=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.84 retrieving revision 1.109 diff -u -p -r1.84 -r1.109 --- mandoc/TODO 2011/01/25 10:37:49 1.84 +++ mandoc/TODO 2011/06/11 15:41:35 1.109 @@ -1,6 +1,6 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.84 2011/01/25 10:37:49 kristaps Exp $ +* $Id: TODO,v 1.109 2011/06/11 15:41:35 schwarze Exp $ ************************************************************************ ************************************************************************ @@ -10,25 +10,15 @@ - .TP before .SH is still FATAL in man(7) reported by brad@ Sat, 15 Jan 2011 15:54:54 -0500 -- The mdoc(7) parser should handle `\.' as punctuation: - .Ql .if ${VAR} op something \. - should produce - `.if ${VAR} op something'. - not - `.if ${VAR} op something .' - as seen in make(1). - To escape the dot, one would use `\&.'. - -- 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 ************************************************************************ @@ -95,6 +85,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 -." @@ -110,13 +110,20 @@ (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 ----------------------------------------------- -- bashbug(1) complains "line scope broken" after - .SM - .B something - should either just work or be a warning - reported by naddy@ +- .RS/.RE can be nested, see e.g. the x11/fluxbox manuals + noticed by dcoppa@ Wed, Apr 13, 2011 at 04:58:14PM +0200: + also affects p5-Net-SFTP-Foreign-1.65 + as reported by gsoares@ Wed, 18 May 2011 09:59:06 -0300 - groff an-ext.tmac macros (.UR, .UE) occur in xine(5) reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500 @@ -127,6 +134,10 @@ 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: @@ -160,6 +171,9 @@ * formatting issues: ugly output ************************************************************************ +- a column list with blank `Ta' cells triggers a spurrious + start-with-whitespace printing of a newline + - double quotes inside double quotes are escaped by doubling them implement this in mdoc(7), too so far, we only have it in roff(7) and man(7) @@ -190,7 +204,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 @@ -213,6 +227,10 @@ 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 + - 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). @@ -225,15 +243,6 @@ should be "NetBSD 1.0A", not "NetBSD 1.0a", see OpenBSD ccdconfig(8). -- The space character joining .Dx .Fx .Nx .Ox (are these all?) to its - argument is non-breaking. See the cdio(1) HISTORY and many others. - -- .Bx uses a dash before its argument, not a space, - see for example the chpass(1) and column(1) HISTORY. - Besides, the second argument is capitalized, for example, - .Bx 4.3 tahoe . - produces 4.3BSD-Tahoe. - - 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). @@ -252,10 +261,6 @@ should be indented, see e.g. rpc(3); reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100 -- .Ns should only be effective when called by another macro, - not as a stand-alone macro at the beginning of a line; - see for example the awk(1) SYNOPSIS. - - .Ns should work when called at the end of an input line, see the following code in vi(1): .It Xo @@ -284,6 +289,49 @@ 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, @@ -315,4 +363,8 @@ Several areas can be cleaned up to make mandoc even fa - Find better ways to prevent endless loops in roff(7) macro and string expansion. - + +- Finish cleanup of date handling. + Decide which formats should be recognized where. + Update both mdoc(7) and man(7) documentation. + Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100