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

Diff for /mandoc/TODO between version 1.1 and 1.146

version 1.1, 2010/05/14 18:20:20 version 1.146, 2012/11/16 18:44:32
Line 1 
Line 1 
   ************************************************************************
   * Official mandoc TODO.
   * $Id$
   ************************************************************************
   
 Before trying to fix anything from this list,  ************************************************************************
 check against -current mandoc from OpenBSD CVS.  * crashes
 Sometimes, i'm a bit behind marking entries FIXED.  ************************************************************************
   
 In general, i keep FIXED entries for some time  - $ echo ".Ta" >> ls.1
 and remove them when they turn into old news.    $ mandoc ls.1
     assertion "MDOC_BLOCK == p->parent->type" failed:
     file "/usr/src/usr.bin/mandoc/mdoc.c", line 399, function "node_append"
     from jmc@  Thu, 20 Sep 2012 21:35:58 +0059
   
 ************************************************************************  ************************************************************************
 * 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  
   
   - roff.c should treat \n(.H>23 and \n(.V>19 in the pod2man(1)
     preamble as true, see for example AUTHORS in MooseX::Getopt.3p
     reported by Andreas Voegele <mail at andreasvoegele dot com>
     Tue, 22 Nov 2011 15:34:47 +0100 on ports@
   
   - .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@
     reported again by bentley@ in nmh(1)  Mon, 23 Apr 2012 13:38:28 -0600
     also uses .ce (center N lines) and .fc (field control)
   
   - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
     reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
   
   - \c (interrupted text) should prevent the line break
     even inside .Bd literal; that occurs in chat(8)
   
   - using undefined strings or macros defines them to be empty
     wl@  Mon, 14 Nov 2011 14:37:01 +0000
   
   --- 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 65  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)
   
   - When there is free text in the SYNOPSIS and that free text contains
     the .Nm macro, groff somehow understands to treat the .Nm as an in-line
     macro, while mandoc treats it as a block macro and breaks the line.
     No idea how the logic for distinguishing in-line and block instances
     should be, needs investigation.
     uqs@  Thu, 2 Jun 2011 11:03:51 +0200
     uqs@  Thu, 2 Jun 2011 11:33:35 +0200
   
   --- missing man features -----------------------------------------------
   
   - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
     reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
     also occur in freeciv-client(6) freeciv-server(6) freeciv-modpack(6)
     reported by bentley@  Tue, 30 Oct 2012 01:05:57 -0600
   
   - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
   
   --- 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
   
   - allow standalone `.' to be interpreted as an end-of-layout
     delimiter instead of being thrown away as a no-op roff line
     reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
   
   --- 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  
   
   - In .Bl -column,
     .It Em Authentication<tab>Key Length
     ought to render "Key Length" with emphasis, too,
     see OpenBSD iked.conf(5).
     reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +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
   
   - .%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 ",  - .Pp between two .It in .Bl -column should produce one,
   see sysctl(3) for many examples;    not two blank lines, see e.g. login.conf(5).
   mishandling this results in spurious quotes at EOL    reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
   reminded by guenther@  Mon, 26 Apr 2010 01:16:52 -0700    reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
   
 - URGENT, this is making many kernel manuals look bad:  - If the *first* line after .It is .Pp, break the line right after
   .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?    the tag, do not pad with space characters before breaking.
   autoconf.9:    See the description of the a, c, and i commands in sed(1).
     .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.  - If the first line after .It is .D1, do not assert a blank line
    SYNOPSIS    in between, see for example tmux(1).
         date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]    reported by nicm@  13 Jan 2011 00:18:57 +0000
   -          [[[[[[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  - .Nx 1.0a
   try e.g. .Bl -column It Ta Ta    should be "NetBSD 1.0A", not "NetBSD 1.0a",
   reported by millert Fri, 02 Apr 2010 16:13:46 -0400    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).
   
 - FIXED on bsd.lv for mdoc, need to merge and test in OpenBSD  - When the -width string contains macros, the macros must be rendered
     kristaps@  Mon, 10 May 2010 03:12:44 +0200    before measuring the width, for example
     man fix still pending!      .Bl -tag -width ".Dv message"
   in literal displays, ignore the right margin    in magic(5), located in src/usr.bin/file, is the same
   reminded by stsp in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200    as -width 7n, not -width 11n.
     The same applies to .Bl -column column widths;
     reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
   
 - FIXED on bsd.lv, need to merge and test in OpenBSD  - The \& zero-width character counts as output.
     kristaps@  Mon, 10 May 2010 02:59:40 +0200    That is, when it is alone on a line between two .Pp,
   do not mark \*(Ba and | up    we want three blank lines, not two as in mandoc.
   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 .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
     reported again by Nicolas Joly via wiz@  Sun, 18 Sep 2011 18:24:40 +0200
     Also, we don't want to break the line within the argument of:
     .Fa "chtype tl"
   
   - 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
   
   - 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  * performance issues
 ************************************************************************  ************************************************************************
   
 - in literal context, groff disables the right margin  Several areas can be cleaned up to make mandoc even faster.  These are
   an example: syslog.conf.5 EXAMPLES section  
   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,  - improve hashing mechanism for macros (quite important: performance)
   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 characters (not as important)
   
 - FIXED bsd.lv mdoc_html.c 1.61 mdoc_term.c 1.117 kristaps@ 8.4.10  - the PDF file is HUGE: this can be reduced by using relative offsets
   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  
   
   - instead of re-initialising the roff predefined-strings set before each
     parse, create a read-only version the first time and copy it
   
 ************************************************************************  ************************************************************************
 * parser errors without any effect on formatting  * structural issues
 ************************************************************************  ************************************************************************
   
 - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree  - We use the input line number at several places to distinguish
     same-line from different-line input.  That plainly doesn't work
     with user-defined macros, leading to random breakage.
   
   - 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.146
CVSweb