version 1.20, 2010/07/02 10:43:21 |
version 1.59, 2010/10/10 09:59:48 |
|
|
************************************************************************ |
************************************************************************ |
|
* Official mandoc TODO. |
|
* $Id$ |
|
************************************************************************ |
|
|
|
************************************************************************ |
* missing features |
* missing features |
************************************************************************ |
************************************************************************ |
|
|
|
|
- fix bad block nesting involving multiple identical explicit blocks |
- fix bad block nesting involving multiple identical explicit blocks |
see the OpenBSD mdoc_macro.c 1.47 commit message |
see the OpenBSD mdoc_macro.c 1.47 commit message |
|
|
- we need real .ds; for example, terminfo.3 has |
|
.ds n 5 |
|
and then later |
|
\fBterminfo\fR(\*n) |
|
reported orally by halex@ during c2k10 |
|
|
|
- \*(Pu is not implemented, but used in mdoc.samples |
|
implementing .ds would solve this as well |
|
reminded by jmc@, last on Sun, 27 Jun 2010 15:29:18 +0100 |
|
|
|
- .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 |
|
|
|
- edge case: decide how to deal with blk_full bad nesting, e.g. |
|
.Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1) |
|
from jmc@ Wed, 14 Jul 2010 18:10:32 +0100 |
|
|
|
- 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 |
|
|
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 |
also look at the mail from Thomas Klausner wiz at NetBSD |
on Wed, 2 Jun 2010 11:01:29 +0200 |
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 |
|
|
- explicitly disallow nested `Bl -column', which would clobber internal |
- explicitly disallow nested `Bl -column', which would clobber internal |
flags defined for struct mdoc_macro |
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 |
- set a meaningful default if no `Bl' list type is assigned |
|
|
- 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 |
|
reported by J.C. Roberts |
|
|
|
- prohibit `Nm' from having non-text HEAD children |
- prohibit `Nm' from having non-text HEAD children |
(e.g., NetBSD mDNSShared/dns-sd.1) |
(e.g., NetBSD mDNSShared/dns-sd.1) |
(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified) |
(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 |
|
|
|
- Have `Sh', `It', `Ss' and others complain if `Pp' is invoked prior to |
|
close (in the post validation) or prior to open (pre). This noted by |
|
jmc@ a thousand years ago. |
|
|
************************************************************************ |
************************************************************************ |
* 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 |
|
|
|
- indentation got lost in SYNOPSIS, e.g. |
- In .Bl -column, |
SYNOPSIS |
.It Em Authentication<tab>Key Length |
date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format] |
ought to render "Key Length" with emphasis, too, |
- [[[[[[cc]yy]mm]dd]HH]MM[.SS]] |
see OpenBSD iked.conf(5). |
+ [[[[[[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 |
|
|
|
- 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 |
* 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) |
|
|
|
- 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). |
|
|
|
- .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). |
|
|
|
- .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. |
|
|
************************************************************************ |
************************************************************************ |
* 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 |
|
************************************************************************ |