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

Diff for /mandoc/TODO between version 1.1 and 1.104

version 1.1, 2010/05/14 18:20:20 version 1.104, 2011/04/30 10:18:24
Line 1 
Line 1 
   ************************************************************************
   * Official mandoc TODO.
   * $Id$
   ************************************************************************
   
 Before trying to fix anything from this list,  ************************************************************************
 check against -current mandoc from OpenBSD CVS.  * parser bugs
 Sometimes, i'm a bit behind marking entries FIXED.  ************************************************************************
   
 In general, i keep FIXED entries for some time  - .TP before .SH is still FATAL in man(7)
 and remove them when they turn into old news.    reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500
   
   - the roff parser doesn't tolerate additional characters between
     a macro and the \} terminating a conditional block, e.g.
     .if n \{
     .br \}
     reported by ulrich spoerlein  Tue, 19 Oct 2010 20:39:50 +0200
   
 ************************************************************************  ************************************************************************
   * formatter bugs
   ************************************************************************
   
   - tbl(7): Horizontal and vertical lines are formatted badly:
     With the box option, there is too much white space at the end of cells.
     Horizontal lines from "=" lines are a bit too long.
     yuri dot pankov at gmail dot com  Thu, 14 Apr 2011 05:45:26 +0400
   
   ************************************************************************
 * missing features  * missing features
 ************************************************************************  ************************************************************************
   
 - explicit blocks with missing end macro should be implicitely closed  --- missing roff features ----------------------------------------------
   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  
   
   - .ad (adjust margins)
     .ad l -- adjust left margin only (flush left)
     .ad r -- adjust right margin only (flush right)
     .ad c -- center text on line
     .ad b -- adjust both margins (alias: .ad n)
     .na   -- temporarily disable adjustment without changing the mode
     .ad   -- re-enable adjustment without changing the mode
     Adjustment mode is ignored while in no-fill mode (.nf).
   
   - .it (line traps) occur in mysql(1), yasm_arch(7)
     generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
     reported by brad@  Sat, 15 Jan 2011 15:48:18 -0500
   
   - .ns (no-space mode) occurs in xine-config(1)
     reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
   
   - xloadimage(1) wants .ti (temporary indent), rep by naddy@
   
   - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
     reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
   
   - pod2man expects `tr' to be implemented for \*(-- to work
   
   - \c (interrupted text) occurs in chat(8)
   
   - \f(CW (constant width font) occurs in rsyncd.conf(5).
     I think we should treat unknown/unavailable fonts as \fR
     such that switching back with \fP works correctly -
     and doesn't revert the _previous_ \fP.
   
   --- missing mdoc features ----------------------------------------------
   
   - 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
Line 21  and remove them when they turn into old news.
Line 73  and remove them when they turn into old news.
   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  
   
 - man(7) .TH should recognize "3p" as a section number  - \\ is now implemented correctly
   found in usr.bin/pkg_add OpenBSD::Getopt    * when defining strings and macros using .ds and .de
     * when parsing roff(7) and man(7) macro arguments
     It does not yet work in mdoc(7) macro arguments
     because libmdoc does not yet use mandoc_getarg().
     Also check what happens in plain text, it must be identical to \e.
   
 - implement \\  - .Bd -filled should not be the same as .Bd -ragged, but align both
   in plain text, identical to \e    the left and right margin.  In groff, it is implemented in terms
   as a macro argument, identical to \ i.e. escaping the next character    of .ad b, which we don't have either.  Found in cksum(1).
   We do not have macro definitions yet; if we implement them,  
   \\ must behave in a macro def like in a macro argument,  
   and when using the macro, it must expand yet again.  
   
 - look at bsd.lv tbl(1)  - implement blank `Bl -column', such as
   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200    .Bl -column
     .It foo Ta bar
     .El
   
   - explicitly disallow nested `Bl -column', which would clobber internal
     flags defined for struct mdoc_macro
   
   - In .Bl -column .It, the end of the line probably has to be regarded
     as an implicit .Ta, if there could be one, see the following mildly
     ugly code from login.conf(5):
       .Bl -column minpasswordlen program xetcxmotd
       .It path Ta path Ta value of Dv _PATH_DEFPATH
       .br
       Default search path.
     reported by Michal Mazurek <akfaew at jasminek dot net>
     via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
   
   - 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
   
   - have a blank `It' head for `Bl -tag' not puke
   
   - 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)
   
   --- missing man features -----------------------------------------------
   
   - .RS/.RE can be nested, see e.g. the x11/fluxbox manuals
     noticed by dcoppa@  Wed, Apr 13, 2011 at 04:58:14PM +0200:
   
   - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
     reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
   
   --- missing tbl features -----------------------------------------------
   
   - implement basic non-parametric .de to support e.g. sox(1)
     reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
     *** sox(1) still doesn't work, tbl(1) errors need investigation
   
   --- missing misc features ----------------------------------------------
   
   - clean up escape sequence handling, creating three classes:
     (1) fully implemented, or parsed and ignored without loss of content
     (2) unimplemented, potentially causing loss of content
         or serious mangling of formatting (e.g. \n) -> ERROR
         see textproc/mgdiff(1) for nice examples
     (3) undefined, just output the character -> perhaps WARNING
   
   - The \t escape sequence is the same as a literal tab, see for example
     the ASCII table in hexdump(1) where
       .Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo
       .It \&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq
     produces
       000 nul  001 soh  002 stx  003 etx  004 eot  005 enq
     and the example in oldrdist(1)
   
 - 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
   roff stuff.  Figure out to what extent we can cope.    roff stuff.  Figure out to what extent we can cope.
     For details, see http://docutils.sourceforge.net/rst.html
   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200    noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100    reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
   
   - check compatibility with Plan9:
     http://swtch.com/usr/local/plan9/tmac/tmac.an
     http://swtch.com/plan9port/man/man7/man.html
     "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
   
 - FIXED OpenBSD term.h 1.16 term.c 1.30 mdoc_term.c 1.75 schwarze 23.4.10  ************************************************************************
   handle tab characters outside literal context, e.g. usb(4)  * formatting issues: ugly output
   reported by jmc@  Mon, 19 Apr 2010 07:42:12 +0100  ************************************************************************
   
 - FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9  - a column list with blank `Ta' cells triggers a spurrious
   man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15    start-with-whitespace printing of a newline
   man_term.c 1.28 man_html.c 1.9 schwarze 25.4.  
   implement .if .ie .el  
   noticed by espie@  Fri, 23 Apr 2010 17:10:35 +0200  
   
 - FIXED bsd.lv libman.h 1.31 libmdoc.h 1.34 man.c 1.60 mdoc.c 1.123  - double quotes inside double quotes are escaped by doubling them
         kristaps@ 8.4.10    implement this in mdoc(7), too
   FIXED OpenBSD libman.h 1.17 libmdoc.h 1.28 man.c 1.26 mdoc.c 1.45    so far, we only have it in roff(7) and man(7)
         schwarze@ 8.5.10    reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
   groff handles \." just like .\"  
   Thus, mandoc must also ignore such lines.  
   For an example, see tr(1).  
   reported by Claus Assmann Mon, 5 Apr 2010 08:46:30 -0700  
   
   - perl(1) SYNOPSIS looks bad; reported by deraadt@
     1) man(7) seems to need SYNOPSIS .Nm blocks, too
   
   - In .Bl -column,
     .It Em Authentication<tab>Key Length
     ought to render "Key Length" with emphasis, too,
     see OpenBSD iked.conf(5).
   
   - 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
   
   - .%T can have trailing punctuation.  Currently, it puts the trailing
     punctuation into a trailing MDOC_TEXT element inside its own scope.
     That element should rather be outside its scope, such that the
     punctuation does not get underlines.  This is not trivial to
     implement because .%T then needs some features of in_line_eoln() -
     slurp all arguments into one single text element - and one feature
     of in_line() - put trailing punctuation out of scope.
     Found in mount_nfs(8) and exports(5), search for "Appendix".
   
   - in enclosures, mandoc sometimes fancies a bogus end of sentence
     reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
   
 ************************************************************************  ************************************************************************
 * formatting issues: ugly output  * formatting issues: gratuitous differences
 ************************************************************************  ************************************************************************
   
 - outside list context, text following .Sm off  - .Rv (and probably .Ex) print different text if an `Nm' has been named
   seems to follow without a blank (TERM_NOBLANK reset late?) e.g.    or not (run a manual without `Nm blah' to see this).  I'm not sure
         .Sm off    that this exists in the wild, but it's still an error.
         .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  
   
 - do not break the line after "--", it's probably a long option  - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
   reminded by stsp in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200    is just "o\bo".
     see for example OpenBSD ksh(1)
   
 - in .Bl -column .It, "\t" seems to be synonymous to " Ta ",  - The characters "|" and "\*(Ba" should never be bold,
   see sysctl(3) for many examples;    not even in the middle of a word, e.g. ".Cm b\*(Bac" in
   mishandling this results in spurious quotes at EOL    "mknod [-m mode] name b|c major minor"
   reminded by guenther@  Mon, 26 Apr 2010 01:16:52 -0700    in OpenBSD ksh(1)
   
 - URGENT, this is making many kernel manuals look bad:  - A bogus .Pp between two .It must not produce a double blank line,
   .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?    see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
   autoconf.9:    or in DIAGNOSTICS in init(8), or before "is always true" in ksh(1).
     .Sh DIRECT CONFIGURATION    The same happens with .Pp just before .El, see bgpd.conf(5).
     .nr nS 1    Also have `It' complain if `Pp' is invoked at certain times (not
     .Ft "struct device *"    -compact?).
     .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.  - .Pp between two .It in .Bl -column should produce one,
    SYNOPSIS    not two blank lines, see e.g. login.conf(5).
         date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]    reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
   -          [[[[[[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  - If the *first* line after .It is .Pp, break the line right after
   try e.g. .Bl -column It Ta Ta    the tag, do not pad with space characters before breaking.
   reported by millert Fri, 02 Apr 2010 16:13:46 -0400    See the description of the a, c, and i commands in sed(1).
   
   - If the first line after .It is .D1, do not assert a blank line
     in between, see for example tmux(1).
     reported by nicm@  13 Jan 2011 00:18:57 +0000
   
 - FIXED on bsd.lv for mdoc, need to merge and test in OpenBSD  - .Nx 1.0a
     kristaps@  Mon, 10 May 2010 03:12:44 +0200    should be "NetBSD 1.0A", not "NetBSD 1.0a",
     man fix still pending!    see OpenBSD ccdconfig(8).
   in literal displays, ignore the right margin  
   reminded by stsp in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200  
   
 - FIXED on bsd.lv, need to merge and test in OpenBSD  - In .Bl -tag, if a tag exceeds the right margin and must be continued
     kristaps@  Mon, 10 May 2010 02:59:40 +0200    on the next line, it must be indented by -width, not width+1;
   do not mark \*(Ba and | up    see "rule block|pass" in OpenBSD ifconfig(8).
   e.g. .Op Fl c Ar string \*(Ba Fl s \*(Ba Ar file Op Ar argument ...  
   The first should not be in an .Ar font.  
   The second must not end up as -|.  
   When fixing, check whether this is a specific problem with this  
   character, or whether other characters are affected, too.  
   reminded by jmc@  Sat, 24 Apr 2010 06:54:26 +0100  
   
   - When the -width string contains macros, the macros must be rendered
     before measuring the width, for example
       .Bl -tag -width ".Dv message"
     in magic(5), located in src/usr.bin/file, is the same
     as -width 7n, not -width 11n.
   
   - 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.
   
   - When .Fn arguments exceed one output line, all but the first
     should be indented, see e.g. rpc(3);
     reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
   
   - .Ns should work when called at the end of an input line, see
     the following code in vi(1):
       .It Xo
       .Op Ar line
       .Cm a Ns Op Cm ppend Ns
       .Op Cm !\&
       .Xc
       The input text is appended after the specified line.
   
   - Header lines of excessive length:
     Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
     and document it in mdoc(7) and man(7) COMPATIBILITY
     found while talking to Chris Bennett
   
   - In man(7), the sequence
       .HP
       one line of regular text
       .SH
     should not produce two blank lines before the .SH,
     see for example named-checkconf(8).
   
   - In man(7), the sequence
       regular text
       .RS
       .IP
     should have a blank line between the text and the beginning of the
     indented paragraph, see for example sudo(1).
   
   - In man(7), the sequence
       .SH HEADER
       <blank line>
       .PP
       regular text
     should not produce any blank lines between the header and the text,
     see for example rsync(1).
     Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
   
   - In man(7), the sequence
       regular text
       .PP
       .RS
       indented text
     should produce one blank line between the regular and indented texts,
     see for example rsync(1), and
       .RE
       <blank line>
       .PP
       .RS
     should produce two,not one blank lines.
     Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
   
   - In man(7), the sequence
       regular text
       .IP
       .IP "tag"
       indented text
     should produce one, not four blank lines between the regular text
     and the tag, see for example rsync(1).
     Likewise,
       regular text
       .IP
       indented text
     should produce one, not two blank lines in between, and
       regular text
       .IP
       .RS
       .IP tag
       indented text
     should produce one, not three blank lines.
     Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
   
   - At least sometimes, .sp is ignored right after .SH; see named.conf(5).
   
   - trailing whitespace must be ignored even when followed by a font escape,
     see for example
       makes
       \fBdig \fR
       operate in batch mode
     in dig(1).
   
 ************************************************************************  ************************************************************************
 * formatting issues: gratuitious differences  * error reporting issues
 ************************************************************************  ************************************************************************
   
 - in literal context, groff disables the right margin  ************************************************************************
   an example: syslog.conf.5 EXAMPLES section  * performance issues
   reported by jmc Tue, 13 Apr 2010 10:12:15 +0100  ************************************************************************
   solution: raise termp->maxrmargin in literal context  
   
 - lines containing blank characters, and nothing else,  Several areas can be cleaned up to make mandoc even faster.  These are
   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  
   
   - improve hashing mechanism for macros (quite important: performance)
   
 - FIXED bsd.lv mdoc_html.c 1.61 mdoc_term.c 1.117 kristaps@ 8.4.10  - improve hashing mechanism for characters (not as important)
   FIXED OpenBSD mdoc_html.c 1.12 mdoc_term.c 1.76 schwarze@ 8.5.10  
   mandoc .%T changed from quoted to underlined  
   reported by jmc Mon, 10 Aug 2009 05:50:21 +0100  
   
   - the PDF file is HUGE: this can be reduced by using relative offsets
   
 ************************************************************************  ************************************************************************
 * parser errors without any effect on formatting  * structural issues
 ************************************************************************  ************************************************************************
   
 - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree  - Find better ways to prevent endless loops
     in roff(7) macro and string expansion.
   
   - Finish cleanup of date handling.
     Decide which formats should be recognized where.
     Update both mdoc(7) and man(7) documentation.
     Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.104
CVSweb