[BACK]Return to TODO CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/TODO, Revision 1.101

1.1       kristaps    1: ************************************************************************
1.37      kristaps    2: * Official mandoc TODO.
1.101   ! schwarze    3: * $Id: TODO,v 1.100 2011/04/13 09:57:41 kristaps Exp $
1.27      kristaps    4: ************************************************************************
                      5:
                      6: ************************************************************************
1.61      schwarze    7: * parser bugs
                      8: ************************************************************************
                      9:
1.81      schwarze   10: - .TP before .SH is still FATAL in man(7)
                     11:   reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500
1.83      schwarze   12:
1.61      schwarze   13: - the roff parser doesn't tolerate additional characters between
                     14:   a macro and the \} terminating a conditional block, e.g.
                     15:   .if n \{
                     16:   .br \}
                     17:   reported by ulrich spoerlein  Tue, 19 Oct 2010 20:39:50 +0200
1.96      schwarze   18:
1.74      schwarze   19: ************************************************************************
                     20: * formatter bugs
                     21: ************************************************************************
1.63      schwarze   22:
1.101   ! schwarze   23: - tbl(7): Horizontal and vertical lines are formatted badly:
        !            24:   With the box option, there is too much white space at the end of cells.
        !            25:   Horizontal lines from "=" lines are a bit too long.
        !            26:   yuri dot pankov at gmail dot com  Thu, 14 Apr 2011 05:45:26 +0400
        !            27:
1.61      schwarze   28: ************************************************************************
1.1       kristaps   29: * missing features
                     30: ************************************************************************
1.70      kristaps   31:
1.79      schwarze   32: --- missing roff features ----------------------------------------------
                     33:
1.82      schwarze   34: - .ad (adjust margins)
                     35:   .ad l -- adjust left margin only (flush left)
                     36:   .ad r -- adjust right margin only (flush right)
                     37:   .ad c -- center text on line
                     38:   .ad b -- adjust both margins (alias: .ad n)
                     39:   .na   -- temporarily disable adjustment without changing the mode
                     40:   .ad   -- re-enable adjustment without changing the mode
                     41:   Adjustment mode is ignored while in no-fill mode (.nf).
                     42:
1.81      schwarze   43: - .it (line traps) occur in mysql(1), yasm_arch(7)
                     44:   generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
                     45:   reported by brad@  Sat, 15 Jan 2011 15:48:18 -0500
                     46:
1.80      schwarze   47: - .ns (no-space mode) occurs in xine-config(1)
                     48:   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
1.61      schwarze   49:
1.80      schwarze   50: - xloadimage(1) wants .ti (temporary indent), rep by naddy@
1.81      schwarze   51:
                     52: - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
                     53:   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
1.75      schwarze   54:
1.80      schwarze   55: - pod2man expects `tr' to be implemented for \*(-- to work
1.79      schwarze   56:
1.83      schwarze   57: - \c (interrupted text) occurs in chat(8)
                     58:
1.98      schwarze   59: - \f(CW (constant width font) occurs in rsyncd.conf(5).
                     60:   I think we should treat unknown/unavailable fonts as \fR
                     61:   such that switching back with \fP works correctly -
                     62:   and doesn't revert the _previous_ \fP.
                     63:
1.79      schwarze   64: --- missing mdoc features ----------------------------------------------
                     65:
1.18      schwarze   66: - fix bad block nesting involving multiple identical explicit blocks
                     67:   see the OpenBSD mdoc_macro.c 1.47 commit message
                     68:
1.1       kristaps   69: - .Bl -column .Xo support is missing
                     70:   ultimate goal:
                     71:   restore .Xr and .Dv to
                     72:   lib/libc/compat-43/sigvec.3
                     73:   lib/libc/gen/signal.3
                     74:   lib/libc/sys/sigaction.2
                     75:
1.28      schwarze   76: - edge case: decide how to deal with blk_full bad nesting, e.g.
                     77:   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
                     78:   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
                     79:
1.74      schwarze   80: - \\ is now implemented correctly
                     81:   * when defining strings and macros using .ds and .de
                     82:   * when parsing roff(7) and man(7) macro arguments
                     83:   It does not yet work in mdoc(7) macro arguments
                     84:   because libmdoc does not yet use mandoc_getarg().
                     85:   Also check what happens in plain text, it must be identical to \e.
1.82      schwarze   86:
                     87: - .Bd -filled should not be the same as .Bd -ragged, but align both
                     88:   the left and right margin.  In groff, it is implemented in terms
                     89:   of .ad b, which we don't have either.  Found in cksum(1).
1.22      schwarze   90:
1.10      kristaps   91: - implement blank `Bl -column', such as
                     92:   .Bl -column
                     93:   .It foo Ta bar
                     94:   .El
1.11      kristaps   95:
                     96: - explicitly disallow nested `Bl -column', which would clobber internal
                     97:   flags defined for struct mdoc_macro
1.42      schwarze   98:
                     99: - inside `.Bl -column' phrases, punctuation is handled like normal
                    100:   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
                    101:
                    102: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
                    103:   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
                    104:   but should give "ab ."
1.12      kristaps  105:
                    106: - set a meaningful default if no `Bl' list type is assigned
1.13      kristaps  107:
                    108: - have a blank `It' head for `Bl -tag' not puke
1.20      kristaps  109:
                    110: - prohibit `Nm' from having non-text HEAD children
                    111:   (e.g., NetBSD mDNSShared/dns-sd.1)
                    112:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.57      kristaps  113:
1.79      schwarze  114: --- missing man features -----------------------------------------------
1.101   ! schwarze  115:
        !           116: - .RS/.RE can be nested, see e.g. the x11/fluxbox manuals
        !           117:   noticed by dcoppa@  Wed, Apr 13, 2011 at 04:58:14PM +0200:
1.79      schwarze  118:
1.80      schwarze  119: - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
                    120:   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
                    121:
1.79      schwarze  122: --- missing tbl features -----------------------------------------------
                    123:
                    124: - implement basic non-parametric .de to support e.g. sox(1)
                    125:   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
                    126:   *** sox(1) still doesn't work, tbl(1) errors need investigation
                    127:
                    128: --- missing misc features ----------------------------------------------
                    129:
                    130: - clean up escape sequence handling, creating three classes:
                    131:   (1) fully implemented, or parsed and ignored without loss of content
                    132:   (2) unimplemented, potentially causing loss of content
                    133:       or serious mangling of formatting (e.g. \n) -> ERROR
                    134:       see textproc/mgdiff(1) for nice examples
                    135:   (3) undefined, just output the character -> perhaps WARNING
                    136:
1.83      schwarze  137: - The \t escape sequence is the same as a literal tab, see for example
                    138:   the ASCII table in hexdump(1) where
                    139:     .Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo
                    140:     .It \&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq
                    141:   produces
                    142:     000 nul  001 soh  002 stx  003 etx  004 eot  005 enq
                    143:   and the example in oldrdist(1)
                    144:
1.79      schwarze  145: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
                    146:   These are a weird mixture of man(7) and custom autogenerated low-level
                    147:   roff stuff.  Figure out to what extent we can cope.
1.80      schwarze  148:   For details, see http://docutils.sourceforge.net/rst.html
1.79      schwarze  149:   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
                    150:   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
1.71      schwarze  151:
                    152: - check compatibility with Plan9:
                    153:   http://swtch.com/usr/local/plan9/tmac/tmac.an
                    154:   http://swtch.com/plan9port/man/man7/man.html
                    155:   "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63      schwarze  156:
1.1       kristaps  157: ************************************************************************
                    158: * formatting issues: ugly output
                    159: ************************************************************************
1.87      kristaps  160:
                    161: - a column list with blank `Ta' cells triggers a spurrious
                    162:   start-with-whitespace printing of a newline
1.33      schwarze  163:
1.67      schwarze  164: - double quotes inside double quotes are escaped by doubling them
1.74      schwarze  165:   implement this in mdoc(7), too
                    166:   so far, we only have it in roff(7) and man(7)
1.67      schwarze  167:   reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
                    168:
1.28      schwarze  169: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29      kristaps  170:   1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1       kristaps  171:
1.39      schwarze  172: - In .Bl -column,
                    173:   .It Em Authentication<tab>Key Length
                    174:   ought to render "Key Length" with emphasis, too,
                    175:   see OpenBSD iked.conf(5).
                    176:
1.1       kristaps  177: - empty phrases in .Bl column produce too few blanks
                    178:   try e.g. .Bl -column It Ta Ta
                    179:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48      schwarze  180:
1.83      schwarze  181: - .%T can have trailing punctuation.  Currently, it puts the trailing
                    182:   punctuation into a trailing MDOC_TEXT element inside its own scope.
                    183:   That element should rather be outside its scope, such that the
                    184:   punctuation does not get underlines.  This is not trivial to
                    185:   implement because .%T then needs some features of in_line_eoln() -
                    186:   slurp all arguments into one single text element - and one feature
                    187:   of in_line() - put trailing punctuation out of scope.
                    188:   Found in mount_nfs(8) and exports(5), search for "Appendix".
                    189:
1.48      schwarze  190: - in enclosures, mandoc sometimes fancies a bogus end of sentence
                    191:   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
1.35      kristaps  192:
1.1       kristaps  193: ************************************************************************
                    194: * formatting issues: gratuitious differences
                    195: ************************************************************************
1.65      kristaps  196:
                    197: - .Rv (and probably .Ex) print different text if an `Nm' has been named
                    198:   or not (run a manual without `Nm blah' to see this).  I'm not sure
                    199:   that this exists in the wild, but it's still an error.
1.38      schwarze  200:
                    201: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
                    202:   is just "o\bo".
                    203:   see for example OpenBSD ksh(1)
                    204:
                    205: - The characters "|" and "\*(Ba" should never be bold,
                    206:   not even in the middle of a word, e.g. ".Cm b\*(Bac" in
                    207:   "mknod [-m mode] name b|c major minor"
                    208:   in OpenBSD ksh(1)
                    209:
                    210: - A bogus .Pp between two .It must not produce a double blank line,
1.39      schwarze  211:   see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
1.83      schwarze  212:   or in DIAGNOSTICS in init(8), or before "is always true" in ksh(1).
                    213:   The same happens with .Pp just before .El, see bgpd.conf(5).
1.68      kristaps  214:   Also have `It' complain if `Pp' is invoked at certain times (not
                    215:   -compact?).
1.39      schwarze  216:
1.83      schwarze  217: - If the *first* line after .It is .Pp, break the line right after
                    218:   the tag, do not pad with space characters before breaking.
                    219:   See the description of the a, c, and i commands in sed(1).
                    220:
                    221: - If the first line after .It is .D1, do not assert a blank line
                    222:   in between, see for example tmux(1).
                    223:   reported by nicm@  13 Jan 2011 00:18:57 +0000
                    224:
1.39      schwarze  225: - .Nx 1.0a
                    226:   should be "NetBSD 1.0A", not "NetBSD 1.0a",
                    227:   see OpenBSD ccdconfig(8).
1.83      schwarze  228:
1.39      schwarze  229: - In .Bl -tag, if a tag exceeds the right margin and must be continued
                    230:   on the next line, it must be indented by -width, not width+1;
                    231:   see "rule block|pass" in OpenBSD ifconfig(8).
1.56      schwarze  232:
1.83      schwarze  233: - When the -width string contains macros, the macros must be rendered
                    234:   before measuring the width, for example
                    235:     .Bl -tag -width ".Dv message"
                    236:   in magic(5), located in src/usr.bin/file, is the same
                    237:   as -width 7n, not -width 11n.
                    238:
1.56      schwarze  239: - The \& zero-width character counts as output.
                    240:   That is, when it is alone on a line between two .Pp,
                    241:   we want three blank lines, not two as in mandoc.
1.63      schwarze  242:
                    243: - When .Fn arguments exceed one output line, all but the first
                    244:   should be indented, see e.g. rpc(3);
                    245:   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
1.83      schwarze  246:
                    247: - .Ns should work when called at the end of an input line, see
                    248:   the following code in vi(1):
                    249:     .It Xo
                    250:     .Op Ar line
                    251:     .Cm a Ns Op Cm ppend Ns
                    252:     .Op Cm !\&
                    253:     .Xc
                    254:     The input text is appended after the specified line.
                    255:
1.64      schwarze  256: - Header lines of excessive length:
                    257:   Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
                    258:   and document it in mdoc(7) and man(7) COMPATIBILITY
                    259:   found while talking to Chris Bennett
1.83      schwarze  260:
                    261: - In man(7), the sequence
                    262:     .HP
                    263:     one line of regular text
                    264:     .SH
                    265:   should not produce two blank lines before the .SH,
                    266:   see for example named-checkconf(8).
                    267:
                    268: - In man(7), the sequence
                    269:     regular text
                    270:     .RS
                    271:     .IP
                    272:   should have a blank line between the text and the beginning of the
                    273:   indented paragraph, see for example sudo(1).
1.98      schwarze  274:
                    275: - In man(7), the sequence
                    276:     .SH HEADER
                    277:     <blank line>
                    278:     .PP
                    279:     regular text
                    280:   should not produce any blank lines between the header and the text,
                    281:   see for example rsync(1).
                    282:   Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
                    283:
                    284: - In man(7), the sequence
                    285:     regular text
                    286:     .PP
                    287:     .RS
                    288:     indented text
                    289:   should produce one blank line between the regular and indented texts,
                    290:   see for example rsync(1), and
                    291:     .RE
                    292:     <blank line>
                    293:     .PP
                    294:     .RS
                    295:   should produce two,not one blank lines.
                    296:   Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
                    297:
                    298: - In man(7), the sequence
                    299:     regular text
                    300:     .IP
                    301:     .IP "tag"
                    302:     indented text
                    303:   should produce one, not four blank lines between the regular text
                    304:   and the tag, see for example rsync(1).
                    305:   Likewise,
                    306:     regular text
                    307:     .IP
                    308:     indented text
                    309:   should produce one, not two blank lines in between, and
                    310:     regular text
                    311:     .IP
                    312:     .RS
                    313:     .IP tag
                    314:     indented text
                    315:   should produce one, not three blank lines.
                    316:   Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
1.83      schwarze  317:
                    318: - At least sometimes, .sp is ignored right after .SH; see named.conf(5).
                    319:
                    320: - trailing whitespace must be ignored even when followed by a font escape,
                    321:   see for example
                    322:     makes
                    323:     \fBdig \fR
                    324:     operate in batch mode
                    325:   in dig(1).
1.75      schwarze  326:
                    327: ************************************************************************
                    328: * error reporting issues
                    329: ************************************************************************
1.1       kristaps  330:
1.9       kristaps  331: ************************************************************************
                    332: * performance issues
                    333: ************************************************************************
                    334:
                    335: Several areas can be cleaned up to make mandoc even faster.  These are
                    336:
                    337: - improve hashing mechanism for macros (quite important: performance)
                    338:
                    339: - improve hashing mechanism for characters (not as important)
1.23      kristaps  340:
1.37      kristaps  341: - the PDF file is HUGE: this can be reduced by using relative offsets
                    342:
1.23      kristaps  343: ************************************************************************
                    344: * structural issues
                    345: ************************************************************************
1.67      schwarze  346:
                    347: - Find better ways to prevent endless loops
                    348:   in roff(7) macro and string expansion.
1.91      schwarze  349:
1.96      schwarze  350: - Finish cleanup of date handling.
1.91      schwarze  351:   Decide which formats should be recognized where.
                    352:   Update both mdoc(7) and man(7) documentation.
                    353:   Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100

CVSweb