=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.96 retrieving revision 1.132 diff -u -p -r1.96 -r1.132 --- mandoc/TODO 2011/03/23 22:16:03 1.96 +++ mandoc/TODO 2012/05/28 23:09:22 1.132 @@ -1,36 +1,23 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.96 2011/03/23 22:16:03 schwarze Exp $ +* $Id: TODO,v 1.132 2012/05/28 23:09:22 schwarze Exp $ ************************************************************************ ************************************************************************ -* parser bugs -************************************************************************ - -- .TP before .SH is still FATAL in man(7) - reported by brad@ Sat, 15 Jan 2011 15:54:54 -0500 - -- the roff parser doesn't tolerate additional characters between - a macro and the \} terminating a conditional block, e.g. - .if n \{ - .br \} - reported by ulrich spoerlein Tue, 19 Oct 2010 20:39:50 +0200 - -- \. at the start of the line does *not* prevent interpretation - of the following word as a macro. - Werner LEMBERG on bug-groff@ Tue, 22 Mar 2011 14:21:28 +0100 - http://lists.gnu.org/archive/html/bug-groff/2011-03/msg00011.html - -************************************************************************ -* formatter bugs -************************************************************************ - -************************************************************************ * missing features ************************************************************************ --- missing roff features ---------------------------------------------- +- roff.c should treat \n(.H>23 and \n(.V>19 in the pod2man(1) + preamble as true, see for example AUTHORS in MooseX::Getopt.3p + reported by Andreas Voegele + Tue, 22 Nov 2011 15:34:47 +0100 on ports@ + +- .if n \{ + .br\} + should cause an extra space to be raised. + - .ad (adjust margins) .ad l -- adjust left margin only (flush left) .ad r -- adjust right margin only (flush right) @@ -48,13 +35,17 @@ reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500 - xloadimage(1) wants .ti (temporary indent), rep by naddy@ + reported again by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600 + also uses .ce (center N lines) and .fc (field control) - .ta (tab settings) occurs in ircbug(1) and probably gnats(1) reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500 -- pod2man expects `tr' to be implemented for \*(-- to work +- \c (interrupted text) should prevent the line break + even inside .Bd literal; that occurs in chat(8) -- \c (interrupted text) occurs in chat(8) +- using undefined strings or macros defines them to be empty + wl@ Mon, 14 Nov 2011 14:37:01 +0000 --- missing mdoc features ---------------------------------------------- @@ -91,6 +82,16 @@ - explicitly disallow nested `Bl -column', which would clobber internal flags defined for struct mdoc_macro +- In .Bl -column .It, the end of the line probably has to be regarded + as an implicit .Ta, if there could be one, see the following mildly + ugly code from login.conf(5): + .Bl -column minpasswordlen program xetcxmotd + .It path Ta path Ta value of Dv _PATH_DEFPATH + .br + Default search path. + reported by Michal Mazurek + via jmc@ Thu, 7 Apr 2011 16:00:53 +0059 + - inside `.Bl -column' phrases, punctuation is handled like normal text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -." @@ -106,17 +107,31 @@ (e.g., NetBSD mDNSShared/dns-sd.1) (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified) +- When there is free text in the SYNOPSIS and that free text contains + the .Nm macro, groff somehow understands to treat the .Nm as an in-line + macro, while mandoc treats it as a block macro and breaks the line. + No idea how the logic for distinguishing in-line and block instances + should be, needs investigation. + uqs@ Thu, 2 Jun 2011 11:03:51 +0200 + uqs@ Thu, 2 Jun 2011 11:33:35 +0200 + --- missing man features ----------------------------------------------- - groff an-ext.tmac macros (.UR, .UE) occur in xine(5) reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500 +- -T[x]html doesn't stipulate non-collapsing spaces in literal mode + --- missing tbl features ----------------------------------------------- - implement basic non-parametric .de to support e.g. sox(1) reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200 *** sox(1) still doesn't work, tbl(1) errors need investigation +- allow standalone `.' to be interpreted as an end-of-layout + delimiter instead of being thrown away as a no-op roff line + reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST + --- missing misc features ---------------------------------------------- - clean up escape sequence handling, creating three classes: @@ -165,6 +180,7 @@ .It Em AuthenticationKey Length ought to render "Key Length" with emphasis, too, see OpenBSD iked.conf(5). + reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200 - empty phrases in .Bl column produce too few blanks try e.g. .Bl -column It Ta Ta @@ -183,7 +199,7 @@ reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 ************************************************************************ -* formatting issues: gratuitious differences +* formatting issues: gratuitous differences ************************************************************************ - .Rv (and probably .Ex) print different text if an `Nm' has been named @@ -206,6 +222,11 @@ Also have `It' complain if `Pp' is invoked at certain times (not -compact?). +- .Pp between two .It in .Bl -column should produce one, + not two blank lines, see e.g. login.conf(5). + reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059 + reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC) + - If the *first* line after .It is .Pp, break the line right after the tag, do not pad with space characters before breaking. See the description of the a, c, and i commands in sed(1). @@ -227,6 +248,8 @@ .Bl -tag -width ".Dv message" in magic(5), located in src/usr.bin/file, is the same as -width 7n, not -width 11n. + The same applies to .Bl -column column widths; + reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar - The \& zero-width character counts as output. That is, when it is alone on a line between two .Pp, @@ -235,6 +258,9 @@ - When .Fn arguments exceed one output line, all but the first should be indented, see e.g. rpc(3); reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100 + reported again by Nicolas Joly via wiz@ Sun, 18 Sep 2011 18:24:40 +0200 + Also, we don't want to break the line within the argument of: + .Fa "chtype tl" - .Ns should work when called at the end of an input line, see the following code in vi(1): @@ -258,14 +284,34 @@ see for example named-checkconf(8). - In man(7), the sequence + .SH HEADER + + .PP regular text - .RS + should not produce any blank lines between the header and the text, + see for example rsync(1). + Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200 + +- In man(7), the sequence + regular text .IP - should have a blank line between the text and the beginning of the - indented paragraph, see for example sudo(1). + .IP "tag" + indented text + should produce one, not four blank lines between the regular text + and the tag, see for example rsync(1). + Likewise, + regular text + .IP + indented text + should produce one, not two blank lines in between, and + regular text + .IP + .RS + .IP tag + indented text + should produce one, not three blank lines. + Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200 -- At least sometimes, .sp is ignored right after .SH; see named.conf(5). - - trailing whitespace must be ignored even when followed by a font escape, see for example makes @@ -277,6 +323,8 @@ * error reporting issues ************************************************************************ +- .TP directly followed by .RS gives an assertion. + ************************************************************************ * performance issues ************************************************************************ @@ -289,9 +337,16 @@ Several areas can be cleaned up to make mandoc even fa - the PDF file is HUGE: this can be reduced by using relative offsets +- instead of re-initialising the roff predefined-strings set before each + parse, create a read-only version the first time and copy it + ************************************************************************ * structural issues ************************************************************************ + +- We use the input line number at several places to distinguish + same-line from different-line input. That plainly doesn't work + with user-defined macros, leading to random breakage. - Find better ways to prevent endless loops in roff(7) macro and string expansion.