=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.17 retrieving revision 1.29 diff -u -p -r1.17 -r1.29 --- mandoc/TODO 2010/06/27 17:31:38 1.17 +++ mandoc/TODO 2010/07/18 18:04:25 1.29 @@ -1,4 +1,9 @@ ************************************************************************ +* Official mandoc TODO. May not be quite up to date. +* $Id: TODO,v 1.29 2010/07/18 18:04:25 kristaps Exp $ +************************************************************************ + +************************************************************************ * missing features ************************************************************************ @@ -6,16 +11,9 @@ 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 -- we need real .ds; for example, terminfo.3 has - .ds n 5 - and then later - \fBterminfo\fR(\*n) - reported orally by halex@ during c2k10 +- fix bad block nesting involving multiple identical explicit blocks + see the OpenBSD mdoc_macro.c 1.47 commit message -- \*(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 ultimate goal: restore .Xr and .Dv to @@ -23,6 +21,14 @@ lib/libc/gen/signal.3 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 \\ in plain text, identical to \e as a macro argument, identical to \ i.e. escaping the next character @@ -30,6 +36,15 @@ \\ 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) + - 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 @@ -55,77 +70,41 @@ - ignore horrendous m[] font colouring reported by J.C. Roberts + +- 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) ************************************************************************ * formatting issues: ugly output ************************************************************************ -- outside list context, text following .Sm off - seems to follow without a blank (TERM_NOBLANK reset late?) e.g. - .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 +- perl(1) SYNOPSIS looks bad; reported by deraadt@ + 1) man(7) seems to need SYNOPSIS .Nm blocks, too -- URGENT, this is making many kernel manuals look bad: - .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS? - autoconf.9: - .Sh DIRECT CONFIGURATION - .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 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 + ************************************************************************ * formatting issues: gratuitious differences ************************************************************************ -- FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10 - lines containing blank characters, and nothing else, - in literal context (.Bd -literal): - 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 +- none reported right now (yet schwarze@ knows of some) - ************************************************************************ -* parser errors without any effect on formatting -************************************************************************ - -- OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree - -************************************************************************ * performance issues ************************************************************************ 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 characters (not as important) + +************************************************************************ +* structural issues +************************************************************************