version 1.16, 2010/06/13 22:44:33 |
version 1.39, 2010/08/15 17:38:41 |
|
|
************************************************************************ |
************************************************************************ |
|
* Official mandoc TODO. |
|
* $Id$ |
|
************************************************************************ |
|
|
|
************************************************************************ |
* missing features |
* missing features |
************************************************************************ |
************************************************************************ |
|
|
|
|
at the end of the enclosing block, e.g. .Bl It (El) Sh |
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 |
reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200 |
|
|
|
- fix bad block nesting involving multiple identical explicit blocks |
|
see the OpenBSD mdoc_macro.c 1.47 commit message |
|
|
- .Bl -column .Xo support is missing |
- .Bl -column .Xo support is missing |
ultimate goal: |
ultimate goal: |
restore .Xr and .Dv to |
restore .Xr and .Dv to |
|
|
lib/libc/gen/signal.3 |
lib/libc/gen/signal.3 |
lib/libc/sys/sigaction.2 |
lib/libc/sys/sigaction.2 |
|
|
- .Bk / .Ek is broken, e.g. |
- edge case: decide how to deal with blk_full bad nesting, e.g. |
$ man ssh |
.Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1) |
[...] |
from jmc@ Wed, 14 Jul 2010 18:10:32 +0100 |
ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-b bind_address] [-c cipher_spec] [-D |
|
[bind_address:]port] [-e escape_char] [-F configfile] [-I pkcs11] |
|
reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200 |
|
also reported by jmc@ earlier |
|
|
|
|
- auto-Bk in the SYNOPSIS |
|
patch from kristaps@ Fri, 16 Jul 2010 14:51:24 +0200 |
|
to be revisited after OpenBSD 4.8 tree unlock |
|
|
- implement \\ |
- implement \\ |
in plain text, identical to \e |
in plain text, identical to \e |
as a macro argument, identical to \ i.e. escaping the next character |
as a macro argument, identical to \ i.e. escaping the next character |
|
|
|
|
- look at bsd.lv tbl(1) |
- look at bsd.lv tbl(1) |
from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200 |
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) |
- 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 |
These are a weird mixture of man(7) and custom autogenerated low-level |
|
|
|
|
- have a blank `It' head for `Bl -tag' not puke |
- have a blank `It' head for `Bl -tag' not puke |
|
|
- ignore horrendous m[] font colouring |
- prohibit `Nm' from having non-text HEAD children |
reported by J.C. Roberts |
(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 |
* formatting issues: ugly output |
************************************************************************ |
************************************************************************ |
|
|
- outside list context, text following .Sm off |
- perl(1) SYNOPSIS looks bad; reported by deraadt@ |
seems to follow without a blank (TERM_NOBLANK reset late?) e.g. |
1) man(7) seems to need SYNOPSIS .Nm blocks, too |
.Sm off |
|
.Xo |
|
.Op Ar bind_address No / |
|
.Ar port |
|
.Xc |
|
.Sm on |
|
or by enclosing |
|
reported by jmc Tue, 13 Apr 2010 08:48:14 +0100 |
|
|
|
- URGENT, this is making many kernel manuals look bad: |
- In .Bl -column, |
.Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS? |
.It Em Authentication<tab>Key Length |
autoconf.9: |
ought to render "Key Length" with emphasis, too, |
.Sh DIRECT CONFIGURATION |
see OpenBSD iked.conf(5). |
.nr nS 1 |
|
.Ft "struct device *" |
|
.Fn config_found_sm "struct device *parent" |
|
groff: |
|
DIRECT CONFIGURATION |
|
struct device * |
|
config_found_sm(struct device *parent, ... |
|
reported by sthen Tue, 20 Apr 2010 13:42:51 +0100 |
|
|
|
- indentation got lost in SYNOPSIS, e.g. |
|
SYNOPSIS |
|
date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format] |
|
- [[[[[[cc]yy]mm]dd]HH]MM[.SS]] |
|
+ [[[[[[cc]yy]mm]dd]HH]MM[.SS]] |
|
reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200 |
|
|
|
- empty phrases in .Bl column produce too few blanks |
- empty phrases in .Bl column produce too few blanks |
try e.g. .Bl -column It Ta Ta |
try e.g. .Bl -column It Ta Ta |
reported by millert Fri, 02 Apr 2010 16:13:46 -0400 |
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 |
* formatting issues: gratuitious differences |
************************************************************************ |
************************************************************************ |
|
|
- FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10 |
- .%T should be quoted, not underlined, when .%J is also present, |
lines containing blank characters, and nothing else, |
to better distinguish the contents of .%T and .%J, |
in literal context (.Bd -literal): |
see for example OpenBSD cat(1) |
groff outputs just blank lines "\n" |
|
mandoc outputs blanks to the left margin, |
|
then the number of balnks minus one |
|
NEEDS MERGING TO bsd.lv |
|
|
|
|
- .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) |
* parser errors without any effect on formatting |
or ", and " (if there are more), not ", " |
************************************************************************ |
see for example OpenBSD csh(1) |
|
|
- OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree |
- 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), before "update" in mount(8), |
|
or in DIAGNOSTICS in init(8). |
|
|
|
- .Bd -literal and .Bd -unfilled are *not* identical. |
|
In -literal, tabs are 8 spaces. |
|
In -unfilled, tabs are 5 spaces, just like in -filled and -ragged. |
|
See the CCDF_* display in OpenBSD ccdconfig(8). |
|
|
|
- In .Bd -unfilled, .Pp should produce one blank line, not two; |
|
see the ccd.conf display in OpenBSD ccdconfig(8). |
|
|
|
- .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). |
|
|
|
- When .%T is used outside an .Rs context and with a trailing comma, |
|
there is no point in rendering two commata, |
|
see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8). |
|
|
|
- When .%T is used outside an .Rs context and without a trailing comma, |
|
no comma should be rendered at all, |
|
see the first paragraph of the DESCRIPTION in OpenBSD exports(5). |
|
|
|
- Bogus .Pp before .Bl should not cause a double blank line, |
|
see "The route utility provides the following simple commands:" |
|
in OpenBSD route(8). |
|
|
************************************************************************ |
************************************************************************ |
* performance issues |
* performance issues |
************************************************************************ |
************************************************************************ |
|
|
Several areas can be cleaned up to make mandoc even faster. These are |
Several areas can be cleaned up to make mandoc even faster. These are |
|
|
- improve caching mechanism to handle other per-element arguments so |
|
that they need not be recalculated between front- and back-ends (also |
|
reduces code size and complexity): |
|
`Bl -column' pointer |
|
`Bf' font type |
|
|
|
- improve hashing mechanism for macros (quite important: performance) |
- improve hashing mechanism for macros (quite important: performance) |
|
|
- improve hashing mechanism for characters (not as important) |
- improve hashing mechanism for characters (not as important) |
|
|
|
- the PDF file is HUGE: this can be reduced by using relative offsets |
|
|
|
************************************************************************ |
|
* structural issues |
|
************************************************************************ |
|
|
|
- rendering frontend code can calculate widths only for plain strings, |
|
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 |
|
|