=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.98 retrieving revision 1.121 diff -u -p -r1.98 -r1.121 --- mandoc/TODO 2011/03/30 00:02:40 1.98 +++ mandoc/TODO 2011/09/18 16:43:28 1.121 @@ -1,31 +1,41 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.98 2011/03/30 00:02:40 schwarze Exp $ +* $Id: TODO,v 1.121 2011/09/18 16:43:28 schwarze Exp $ ************************************************************************ ************************************************************************ * parser bugs ************************************************************************ +- ".\}" 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 + - .TP before .SH is still FATAL in man(7) reported by brad@ Sat, 15 Jan 2011 15:54:54 -0500 + also occurs in emulators/pcsxr/patches/patch-doc_pcsx_1 + jeremy@ commit Wed, 7 Sep 2011 10:00:19 -0600 (MDT) -- 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 ---------------------------------------------- +- .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) @@ -47,15 +57,8 @@ - .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. - --- missing mdoc features ---------------------------------------------- - fix bad block nesting involving multiple identical explicit blocks @@ -91,6 +94,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 +119,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: @@ -183,7 +210,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 +233,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). @@ -235,6 +266,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,13 +292,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 @@ -275,20 +302,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 @@ -307,8 +320,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 @@ -331,6 +342,9 @@ Several areas can be cleaned up to make mandoc even fa - improve hashing mechanism for characters (not as important) - 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