=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.33 retrieving revision 1.38 diff -u -p -r1.33 -r1.38 --- mandoc/TODO 2010/07/25 18:22:18 1.33 +++ mandoc/TODO 2010/08/15 16:38:35 1.38 @@ -1,6 +1,6 @@ ************************************************************************ -* Official mandoc TODO. May not be quite up to date. -* $Id: TODO,v 1.33 2010/07/25 18:22:18 schwarze Exp $ +* Official mandoc TODO. +* $Id: TODO,v 1.38 2010/08/15 16:38:35 schwarze Exp $ ************************************************************************ ************************************************************************ @@ -40,6 +40,7 @@ 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 + joerg@ has patches for this somewhere... - 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 @@ -62,22 +63,14 @@ - 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) + +- allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments + noted by Alex Kozlov 08/06/10 23:05 ************************************************************************ * formatting issues: ugly output ************************************************************************ -- boot_config.8 - .Bd -literal - .No UKC> Ic find ne - 24 ne0 at isa0 - should be - UKC> find ne - 24 ne0 at isa0 - but is - UKC>find ne24 ne0 at isa0 - from jmc@ Wed, 21 Jul 2010 22:40:02 +0100 - - perl(1) SYNOPSIS looks bad; reported by deraadt@ 1) man(7) seems to need SYNOPSIS .Nm blocks, too @@ -85,12 +78,47 @@ try e.g. .Bl -column It Ta Ta reported by millert Fri, 02 Apr 2010 16:13:46 -0400 +- %A doesn't put an "and" before the final author name. + ************************************************************************ * formatting issues: gratuitious differences ************************************************************************ -- none reported right now (yet schwarze@ knows of some) +- .%T should be quoted, not underlined, when .%J is also present, + to better distinguish the contents of .%T and .%J, + see for example OpenBSD cat(1) +- .It ${name Ns [ selector ] Ns } + should be "${name[selector]}" not "${name [selector]}" + This is parsed as + text("${name") text("[") Ns() text(selector)... + Opening punctuation should not fall out of .Ns. + see for example OpenBSD csh(1) + +- .%A should append the last author with " and " (if there are two) + or ", and " (if there are more), not ", " + see for example OpenBSD csh(1) + +- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet + is just "o\bo". + see for example OpenBSD ksh(1) + +- .No text No ) is "text )", not "text)" + see the terrible example + case word in [[(] pattern [| pattern] ... ) list ;; ] ... esac + in OpenBSD ksh(1) + +- .Sm should *not* produce as a blank line in .Bd -literal + see for example "Brace expansion" in 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). + ************************************************************************ * performance issues ************************************************************************ @@ -101,6 +129,8 @@ 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 ************************************************************************ @@ -109,4 +139,9 @@ Several areas can be cleaned up to make mandoc even fa not for strings containing escape sequences. For example, this hinders calculation of the indent required for .Nm \&[ in text(1). comments from kristaps@ Wed, 21 Jul 2010 23:26:08 +0200 + +- another example of the same problem: + .Bl -tag -width "\eD{format}XX" -compact + in OpenBSD ksh(1) gives the wrong width + because "\e" is one character in groff, two in mandoc