=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.30 retrieving revision 1.73 diff -u -p -r1.30 -r1.73 --- mandoc/TODO 2010/07/18 23:06:18 1.30 +++ mandoc/TODO 2011/01/06 14:05:12 1.73 @@ -1,12 +1,29 @@ ************************************************************************ -* Official mandoc TODO. May not be quite up to date. -* $Id: TODO,v 1.30 2010/07/18 23:06:18 kristaps Exp $ +* Official mandoc TODO. +* $Id: TODO,v 1.73 2011/01/06 14:05:12 kristaps Exp $ ************************************************************************ ************************************************************************ +* parser bugs +************************************************************************ + +- 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 + +- .BI "string string " word punct in gettext(3) + add bogus line breaks (rep by naddy@) + committed; currently working on IP and TP? + and what about B and I? + +************************************************************************ * missing features ************************************************************************ +- pod2man expects `tr' to be implemented for \*(-- to work + - explicit blocks with missing end macro should be implicitely closed at the end of the enclosing block, e.g. .Bl It (El) Sh reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200 @@ -36,19 +53,16 @@ \\ must behave in a macro def like in a macro argument, and when using the macro, it must expand yet again. -- implement \s (physical font size) - \sN - set to N - \s+N - increment by N, 1 <= N <= 8 - \s-N - decrement by N, 1 <= N <= 8 - \s0 - restore previous size - \s(nn \s+-(nn \s'+-nn' \s+-'nn' \s[+-nn] \s+-[nn] - disambiguate - registers: .s .ps .sr .psr - used by e.g. cu(1), tip(1) +- 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 -- look at bsd.lv tbl(1) - from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200 - also look at the mail from Thomas Klausner wiz at NetBSD - on Wed, 2 Jun 2010 11:01:29 +0200 +- clean up escape sequence handling, creating three classes: + (1) fully implemented, or parsed and ignored without loss of content + (2) unimplemented, potentially causing loss of content + or serious mangling of formatting (e.g. \n) -> ERROR + see textproc/mgdiff(1) for nice examples + (3) undefined, just output the character -> perhaps WARNING - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1) These are a weird mixture of man(7) and custom autogenerated low-level @@ -64,6 +78,13 @@ - explicitly disallow nested `Bl -column', which would clobber internal flags defined for struct mdoc_macro +- inside `.Bl -column' phrases, punctuation is handled like normal + text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -." + +- inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf' + is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab." + but should give "ab ." + - set a meaningful default if no `Bl' list type is assigned - have a blank `It' head for `Bl -tag' not puke @@ -71,27 +92,90 @@ - prohibit `Nm' from having non-text HEAD children (e.g., NetBSD mDNSShared/dns-sd.1) (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified) - + +- xloadimage(1) wants .ti (temporary indent), rep by naddy@ + +- bashbug(1) complains "line scope broken" after + .SM + .B something + should either just work or be a warning + reported by naddy@ + +- check compatibility with Plan9: + http://swtch.com/usr/local/plan9/tmac/tmac.an + http://swtch.com/plan9port/man/man7/man.html + "Anthony J. Bentley" 28 Dec 2010 21:58:40 -0700 + ************************************************************************ * formatting issues: ugly output ************************************************************************ +- double quotes inside double quotes are escaped by doubling them + implement this in man(7) and mdoc(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). + - empty phrases in .Bl column produce too few blanks try e.g. .Bl -column It Ta Ta reported by millert Fri, 02 Apr 2010 16:13:46 -0400 -- .Pp before and after .Sh (and .Ss) produces a spurious blank line; - reported by jmc@ Thu, 15 Jul 2010 23:00:28 +0100 +- in enclosures, mandoc sometimes fancies a bogus end of sentence + reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 ************************************************************************ * formatting issues: gratuitious differences ************************************************************************ -- none reported right now (yet schwarze@ knows of some) +- .Rv (and probably .Ex) print different text if an `Nm' has been named + or not (run a manual without `Nm blah' to see this). I'm not sure + that this exists in the wild, but it's still an error. +- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet + 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). + Also have `It' complain if `Pp' is invoked at certain times (not + -compact?). + +- .Nx 1.0a + should be "NetBSD 1.0A", not "NetBSD 1.0a", + see OpenBSD ccdconfig(8). + +- 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). + +- The \& zero-width character counts as output. + That is, when it is alone on a line between two .Pp, + we want three blank lines, not two as in mandoc. + +- 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 + +- It seems that .TP does not want TWOSPACE after the tag; + see bashbug(1); reported by naddy@ + +- 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 + ************************************************************************ * performance issues ************************************************************************ @@ -102,6 +186,12 @@ 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 + ************************************************************************ * structural issues ************************************************************************ + +- Find better ways to prevent endless loops + in roff(7) macro and string expansion. +