=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.104 retrieving revision 1.129 diff -u -p -r1.104 -r1.129 --- mandoc/TODO 2011/04/30 10:18:24 1.104 +++ mandoc/TODO 2012/03/04 23:53:37 1.129 @@ -1,21 +1,17 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.104 2011/04/30 10:18:24 kristaps Exp $ +* $Id: TODO,v 1.129 2012/03/04 23:53:37 schwarze Exp $ ************************************************************************ ************************************************************************ * parser bugs ************************************************************************ -- .TP before .SH is still FATAL in man(7) - reported by brad@ Sat, 15 Jan 2011 15:54:54 -0500 +- ".\}" on its own line gets translated to bare ".\&" + which forces pset() into man(7) + and then triggers an unknown macro error + reported by naddy@ Sun, 3 Jul 2011 21:52:24 +0200 -- 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 ************************************************************************ @@ -31,6 +27,15 @@ --- missing roff features ---------------------------------------------- +- The pod2man preamble wants \h'...' with quoted numerical arguments, + see for example AUTHORS in MooseX::Getopt.3p, p5-MooseX-Getopt. + 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) @@ -52,14 +57,10 @@ - .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) occurs in chat(8) -- \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. +- using undefined strings or macros defines them to be empty + wl@ Mon, 14 Nov 2011 14:37:01 +0000 --- missing mdoc features ---------------------------------------------- @@ -121,20 +122,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 ----------------------------------------------- -- .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 +- -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: @@ -183,6 +195,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 @@ -227,6 +240,7 @@ - .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 +263,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,6 +273,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): @@ -280,13 +299,6 @@ 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 @@ -297,20 +309,6 @@ - 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 @@ -329,8 +327,6 @@ 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 @@ -342,6 +338,8 @@ * error reporting issues ************************************************************************ +- .TP directly followed by .RS gives an assertion. + ************************************************************************ * performance issues ************************************************************************ @@ -354,9 +352,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.