mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.235 and 1.285

version 1.235, 2017/03/03 14:23:23

version 1.285, 2019/03/01 10:57:17

Line 52 are mere guesses, and some may be wrong.

found by naddy@ in xloadimage(1)

loc ** exist *** algo * size * imp *

- .nr third argument (auto-increment step size, requires \n+)

found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700

loc * exist * algo * size * imp **

- .ns (no-space mode) occurs in xine-config(1)

when implementing this, also let .TH set it

reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500

loc *** exist *** algo *** size ** imp *

- .ta (tab settings)

#1 most important issue naddy@ Mon, 16 Feb 2015 20:59:17 +0100

ircbug(1) gnats(1) reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500

also Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100

also posix2time(3) Carsten Kunze Mon, 1 Dec 2014 13:03:10 +0100

loc ** exist *** algo ** size ** imp ***

- .ti (temporary indent)

found by naddy@ in xloadimage(1) [devel/libvstr] vstr(3)

found by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600

loc ** exist ** algo ** size * imp ** (parser reorg helps a lot)

- .while and .shift

found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200

loc * exist ** algo ** size ** imp **

- \h horizontal move

#2 most important issue naddy@ Mon, 16 Feb 2015 20:59:17 +0100

found in cclive(1) nasm(1) bogofilter(1) asciidoc/DocBook output

bentley@ on discuss@ Sat, 21 Sep 2013 22:29:34 -0600

naddy@ Thu, 4 Dec 2014 16:26:41 +0100

loc ** exist ** algo ** size * imp *** (parser reorg helps a lot)

- \n+ and \n- numerical register increment and decrement

found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700

loc * exist * algo * size * imp **

- \n(.$ macro argument count number register; ocserv(8) by autogen

found by sthen@ Thu, 19 Feb 2015 22:03:01 +0000

loc * exist ** algo * size * imp **

- \w'' improve width measurements

would not be very useful without an expression parser, see below

needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100

loc ** exist *** algo *** size * imp ***

- \\ in high-level macro arguments

Currently, \\ is expanded in two situations:

1) macro and string definition (roff.c setstrn())

2) macro argument parsing (mandoc.c mandoc_getarg())

For user defined macros, the second happens in time because of ROFF_REPARSE.

But for standard high-level macros, it only happens after entering the

high level parsers, which is too late because the code doesn't get

back to roff.c roff_res() from that point. Because this requires

distinguishing requests, user-defined macros and standard macros

on the roff_res() level, it is hard to solve without the parser reorg.

Found by naddy@ in devel/cutils cobfusc(1) Mon, 16 Feb 2015 19:10:52 +0100

loc *** exist *** algo *** size ** imp *

- using undefined strings or macros defines them to be empty

wl@ Mon, 14 Nov 2011 14:37:01 +0000

loc * exist * algo * size * imp *

--- missing mdoc features ----------------------------------------------

- .Bl -column .Xo support is missing

Line 129 are mere guesses, and some may be wrong.

Line 77 are mere guesses, and some may be wrong.

from jmc@ Wed, 14 Jul 2010 18:10:32 +0100

loc * exist *** algo *** size ** imp **

- .Bd -centered implies -filled, not -unfilled, which is not

easy to implement; it requires code similar to .ce, which

we don't have either.

Besides, groff has bug causing text right *before* .Bd -centered

to be centered as well.

loc *** exist *** algo ** size ** imp ** (parser reorg would help)

- .Bd -filled should not be the same as .Bd -ragged, but align both

the left and right margin. In groff, it is implemented in terms

of .ad b, which we don't have either. Found in cksum(1).

Line 169 are mere guesses, and some may be wrong.

Line 110 are mere guesses, and some may be wrong.

is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."

but should give "ab ."

- check whether it is correct that `D1' uses INDENT+1;

does it need its own constant?

loc * exist ** algo ** size * imp **

- prohibit `Nm' from having non-text HEAD children

(e.g., NetBSD mDNSShared/dns-sd.1)

(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)

Line 193 are mere guesses, and some may be wrong.

Line 130 are mere guesses, and some may be wrong.

uqs@ Thu, 2 Jun 2011 11:33:35 +0200

loc * exist ** algo *** size * imp **

--- missing tbl features -----------------------------------------------

--- missing man features -----------------------------------------------

- horizontal lines in the layout still consume data cells

- groff_www(7) .MTO and .URL

and can be mixed with actual data on the same table line

These macros were used by the GNU grep(1) man page.

synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400

The groff_www(7) manual page itself uses them, too.

loc ** exist ** algo ** size ** imp ***

We should probably *not* add them to mandoc.

Just mentioning this here to keep track of the abuse.

Laura Morales <lauretas at mail dot com> 20 Apr 2018 07:33:02 +0200

loc ** exist * algo * size ** imp *

- break long text into lines inside cells

--- missing tbl features -----------------------------------------------

net/lftp(1) from jirib via bentley@ Sep 13, 2016

- layout l1 for a column of max text width 3 reduces the following

- vertical centering in cells vertically spanned with ^

inter-column spacing for groff, but not for mandoc

pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200

net/lftp(1) from jirib via bentley@ Sep 13, 2016

loc * exist *** algo *** size ** imp *

- the "w" layout option is ignored

synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400

loc * exist * algo * size * imp **

- the "s" layout column specifier is used for placement of data

into columns, but ignored during column width calculations

synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400

loc * exist ** algo *** size * imp **

- support mdoc(7) and man(7) macros inside tbl(7) code;

probably requires the parser reorg and letting tbl(7)

use roff_node such that macro sets can mix;

Line 223 are mere guesses, and some may be wrong.

Line 153 are mere guesses, and some may be wrong.

loc *** exist ** algo *** size ** imp ***

- look at the POSIX manuals in the books/man-pages-posix port,

they use some unsupported tbl(7) features.

they use some unsupported tbl(7) features, mostly macros in tbl(7).

loc * exist ** algo ** size ** imp ***

- look what Joerg Schilling manual pages use

Thu, 19 Mar 2015 18:31:48 +0100

- use Unicode U+2500 to U+256C for table borders

in tbl(7) -Tutf-8 output

suggested by bentley@ Tue, 14 Oct 2014 04:10:55 -0600

loc * exist ** algo * size * imp **

--- missing eqn features -----------------------------------------------

- In a matrix, break the output line after each matrix line.

Line 252 are mere guesses, and some may be wrong.

Line 177 are mere guesses, and some may be wrong.

see User's Guide (Second Edition) page 5 section 15.

loc ** exist ** algo ** size ** imp **

- GNU eqn converts some operators to special characters, for example,

input HYPHEN-MINUS becomes output \(mi, unless it is part of a

quoted word. mandoc(1) only does this when the operator is

surrounded by blanks, not when it is part of an unquoted word.

Also, check whether there are more such cases (e.g., +?).

reported by bentley@ 20 Jun 2017 02:04:29 -0600

loc * exist ** algo ** size * imp *

- Primes, opprime, and '

bentley@ Thu, 13 Jul 2017 23:14:20 -0600

--- missing misc features ----------------------------------------------

- man -ks 1,8 route; kn@ Jul 13, 2018 orally

- italic correction (\/) in PostScript mode

Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46

loc ** exist ** algo * size * imp *

Line 371 are mere guesses, and some may be wrong.

Line 309 are mere guesses, and some may be wrong.

.Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...

from kristaps@ Tue, 08 Jun 2010 11:13:32 +0200

- implicit whitespace around inline equations

example code: where '$times$' denotes matrix multiplication

must not have an HTML line break, nor a blank, before <math>

partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT},

bentley@ Thu, 13 Jul 2017 19:00:59 -0600

- in enclosures, mandoc sometimes fancies a bogus end of sentence

reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059

loc * exist ** algo *** size * imp ***

Line 398 are mere guesses, and some may be wrong.

Line 342 are mere guesses, and some may be wrong.

--- HTML issues --------------------------------------------------------

- format ".IP *" etc. as <ul> rather than <dl>

https://github.com/Debian/debiman/issues/67

reminded by Pali Rohar 25 Nov 2018 14:34:26 +0100

loc ** exist ** algo ** size * imp ***

- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal

space, see for example random(3). Introduced in

http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92

Line 433 are mere guesses, and some may be wrong.

Line 382 are mere guesses, and some may be wrong.

Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100

loc * exist ** algo ** size * imp **

- .Lk formatting for long links with line breaks

Franco Fichtner 8 Oct 2013 00:33:42 +0200

- In .Bl -enum -width 0n, groff continues one the same line after

the number, mandoc breaks the line.

mail to kristaps@ Mon, 20 Jul 2009 02:21:39 +0200

Line 462 are mere guesses, and some may be wrong.

Line 408 are mere guesses, and some may be wrong.

Probably, this should be fixed somewhere in termp_it_pre(), not sure.

loc * exist ** algo ** size * imp **

- .Nx 1.0a

should be "NetBSD 1.0A", not "NetBSD 1.0a",

see OpenBSD ccdconfig(8).

loc * exist * algo * size * imp **

- In .Bl -tag, if a tag exceeds the right margin and must be continued

on the next line, it must be indented by -width, not width+1;

see "rule block|pass" in OpenBSD ifconfig(8).

loc * exist *** algo ** size * imp **

- When the -width string contains macros, the macros must be rendered

before measuring the width, for example

.Bl -tag -width ".Dv message"

Line 507 are mere guesses, and some may be wrong.

Line 443 are mere guesses, and some may be wrong.

* warning issues

************************************************************************

- provide a way in mandoc(1) to warn about broken .Xr links;

- When a man(1) command returns no result and there was an -S

probably cannot be on by default in -Tlint because it needs

argument, check the -S argument against the list of valid

to access the manpath and mandoc.db(3) after parsing.

architectures and say "Unknown architecture AAA" rather than

asked for by jmc@ Fri, 4 Dec 2015 22:39:40 +0000

"No entry for NNN in the manual" if there is no match.

Requires moving the lists of valid architectures out of

mdoc_validate.c such that they can be used by main.c.

Discussed with jmc@ 10 Aug 2018 19:20:12 +0100.

loc ** exist * algo * size * imp **

- warn about duplicate .Sh/.Ss heads

gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200

loc * exist * algo * size * imp **

- style message about macros inside .Bd -literal and .Dl, in particular

font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO)

- style message about mismatches between the section number in the

file name (if it is known) and the section number in .Dt

(from the mdoclint TODO)

- style message about NULL without .Dv (from the mdoclint TODO)

- style message about error constants without .Er (from the mdoclint TODO)

- warn when .Sh or .Ss contain other macros

Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034

loc * exist * algo * size * imp **

- style message about violations of the convention

.An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO)

- warn about attempts to call non-callable macros

Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100

Note that formatting is inconsistent in groff.

Line 524 are mere guesses, and some may be wrong.

Line 482 are mere guesses, and some may be wrong.

all over mdoc_macro.c and all subtly different.

loc ** exist ** algo ** size ** imp **

- mandoc_special does not really check the escape sequence,

- warn about punctuation - e.g. ',' and ';' - at the beginning

but just the overall format

of a text line, if it is likely intended to follow the preceding

loc ** exist ** algo *** size ** imp **

output without intervening whitespace, in particular after a

macro line (from the mdoclint TODO)

- integrate mdoclint into mandoc ("end-of-line whitespace" thread)

- makewhatis -p complains about language subdirectories:

from jmc@ Mon, 13 Jul 2009 17:12:09 +0100

/usr/local/man//ru: Unknown directory part

from kristaps@ Mon, 13 Jul 2009 18:34:53 +0200

from jmc@ Mon, 13 Jul 2009 17:45:37 +0059

from kristaps@ Mon, 13 Jul 2009 19:02:03 +0200

(mostly done, check what remains)

- -Tlint parser errors and warnings to stdout

to tech@mdocml, naddy@ Wed, 28 Sep 2011 11:21:46 +0200

wait! kristaps@ Sun, 02 Oct 2011 17:12:52 +0200

************************************************************************

* documentation issues

Line 555 are mere guesses, and some may be wrong.

Line 507 are mere guesses, and some may be wrong.

* performance issues

************************************************************************

- Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?

from kristaps@ Sat, 09 Aug 2014 13:51:36 +0200

Several areas can be cleaned up to make mandoc even faster. These are

- improve hashing mechanism for macros (quite important: performance)

- the PDF file is HUGE: this can be reduced by using relative offsets

************************************************************************

Line 579 Several areas can be cleaned up to make mandoc even fa

Line 524 Several areas can be cleaned up to make mandoc even fa

same-line from different-line input. That plainly doesn't work

with user-defined macros, leading to random breakage.

- Is it possible to further simplify ENDBODY_SPACE?

- Find better ways to prevent endless loops

in roff(7) macro and string expansion.

- Finish cleanup of date handling.

- make buffers for parsing functions const

Decide which formats should be recognized where.

christos@ via wiz@ Fri, 18 Dec 2015 17:10:01 +0100

Update both mdoc(7) and man(7) documentation.

Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100

- struct mparse refactoring

Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200

Line 596 Several areas can be cleaned up to make mandoc even fa

Line 541 Several areas can be cleaned up to make mandoc even fa

- Enable HTTP compression by detecting gzip encoding and filtering

output through libz.

- Sandbox (see OpenSSH).

- Privilege separation (see OpenSSH).

- Enable caching support via HTTP 304 and If-Modified-Since.

- Have Mac OSX systems automatically disable -static compilation of the

CGI: -static isn't supported.

************************************************************************

* to improve in the groff_mdoc(7) macros

************************************************************************

- .Cd # arch1, arch2 in section 4 pages:

find better way to indicate multiple architectures, maybe:

allow .Dt vgafb 4 "macppc sparc64"

already shown as "Device Drivers Manual (macppc sparc64)"

for apropos, make that "vgafb(4) - macppc # sparc64" instead of "- all"

groff can be made to show multiple arches, too, but it is

tedious to do the string parsing in roff code...

jmc@ 23 Apr 2018 07:24:52 +0100 [man for vgafb(4)...]

loc ** exist ** algo * size * imp ***

- use uname(1) to set doc-default-operating-system at install time

tobimensch Mon, 1 Dec 2014 00:25:07 +0100

- apostrophe (39), circumflex (94), grave (96), tilde (126)

in manuals: \(aq, \(ha, \`, \(ti

Re: [Groff] ASCII Minus Sign in man Pages.

bentley@ 26 Apr 2017 10:02:06 -0600

Do we need to fix existing manuals?

Do we need to fix the definition of the mdoc(7) language?

CVSweb