=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.104 retrieving revision 1.144 diff -u -p -r1.104 -r1.144 --- mandoc/TODO 2011/04/30 10:18:24 1.104 +++ mandoc/TODO 2012/10/31 09:20:23 1.144 @@ -1,36 +1,19 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.104 2011/04/30 10:18:24 kristaps Exp $ +* $Id: TODO,v 1.144 2012/10/31 09:20:23 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 - -************************************************************************ -* formatter bugs -************************************************************************ - -- tbl(7): Horizontal and vertical lines are formatted badly: - With the box option, there is too much white space at the end of cells. - Horizontal lines from "=" lines are a bit too long. - yuri dot pankov at gmail dot com Thu, 14 Apr 2011 05:45:26 +0400 - -************************************************************************ * 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@ + - .ad (adjust margins) .ad l -- adjust left margin only (flush left) .ad r -- adjust right margin only (flush right) @@ -48,19 +31,18 @@ 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 -- \f(CW (constant width font) occurs in rsyncd.conf(5). - I think we should treat unknown/unavailable fonts as \fR - such that switching back with \fP works correctly - - and doesn't revert the _previous_ \fP. - --- missing mdoc features ---------------------------------------------- - fix bad block nesting involving multiple identical explicit blocks @@ -121,20 +103,33 @@ (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 ----------------------------------------------- -- .RS/.RE can be nested, see e.g. the x11/fluxbox manuals - noticed by dcoppa@ Wed, Apr 13, 2011 at 04:58:14PM +0200: - - groff an-ext.tmac macros (.UR, .UE) occur in xine(5) reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500 + also occur in freeciv-client(6) freeciv-server(6) freeciv-modpack(6) + reported by bentley@ Tue, 30 Oct 2012 01:05:57 -0600 +- -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: @@ -176,13 +171,11 @@ so far, we only have it in roff(7) and man(7) reminded by millert@ Thu, 09 Dec 2010 17:29:52 -0500 -- perl(1) SYNOPSIS looks bad; reported by deraadt@ - 1) man(7) seems to need SYNOPSIS .Nm blocks, too - - In .Bl -column, .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 @@ -200,6 +193,14 @@ - in enclosures, mandoc sometimes fancies a bogus end of sentence reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 +- Trailing isolated dots lack EOS for some macros. + This cannot use mandoc_eos() because groff only does EOS + for isolated dots at least in some of these cases. + Affected macros included those using in_line_eoln(). + Make sure to fix open(2) + without breaking fstat(1), ksh(1), tzset(3) and UKC(8). + reported by Nicolas Joly Fri, 12 Oct 2012 17:00:36 +0200 + ************************************************************************ * formatting issues: gratuitous differences ************************************************************************ @@ -212,21 +213,10 @@ is just "o\bo". see for example OpenBSD ksh(1) -- The characters "|" and "\*(Ba" should never be bold, - not even in the middle of a word, e.g. ".Cm b\*(Bac" in - "mknod [-m mode] name b|c major minor" - in OpenBSD ksh(1) - -- A bogus .Pp between two .It must not produce a double blank line, - see between -R and -r in OpenBSD rm(1), before "update" in mount(8), - or in DIAGNOSTICS in init(8), or before "is always true" in ksh(1). - The same happens with .Pp just before .El, see bgpd.conf(5). - 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. @@ -249,6 +239,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, @@ -257,80 +249,15 @@ - 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): - .It Xo - .Op Ar line - .Cm a Ns Op Cm ppend Ns - .Op Cm !\& - .Xc - The input text is appended after the specified line. - - Header lines of excessive length: Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c and document it in mdoc(7) and man(7) COMPATIBILITY found while talking to Chris Bennett -- In man(7), the sequence - .HP - one line of regular text - .SH - should not produce two blank lines before the .SH, - see for example named-checkconf(8). - -- In man(7), the sequence - regular text - .RS - .IP - should have a blank line between the text and the beginning of the - indented paragraph, see for example sudo(1). - -- In man(7), the sequence - .SH HEADER - - .PP - regular text - 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 - .PP - .RS - indented text - should produce one blank line between the regular and indented texts, - see for example rsync(1), and - .RE - - .PP - .RS - should produce two,not one blank lines. - Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200 - -- In man(7), the sequence - regular text - .IP - .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 @@ -339,10 +266,6 @@ in dig(1). ************************************************************************ -* error reporting issues -************************************************************************ - -************************************************************************ * performance issues ************************************************************************ @@ -354,9 +277,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.