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

Diff for /mandoc/TODO between version 1.89 and 1.140

version 1.89, 2011/02/03 10:24:21 version 1.140, 2012/07/18 16:20:43
Line 4 
Line 4 
 ************************************************************************  ************************************************************************
   
 ************************************************************************  ************************************************************************
 * parser bugs  
 ************************************************************************  
   
 - It should be noted that in mandoc, the TBL macros are interpreted as  
   real roff macros (e.g., `.  TS' is ok), while the troff preprocessor  
   only looks for `.TS' (static string).  This should be noted in the  
   COMPATIBILITY section.  The same applies for nascent `.EQ' (as it is  
   now, `.EN' is processed as a static string).  
   
 - .TP before .SH is still FATAL in man(7)  
   reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500  
   
 - The mdoc(7) parser should handle `\.' as punctuation:  
     .Ql .if ${VAR} op something \.  
   should produce  
     `.if ${VAR} op something'.  
   not  
     `.if ${VAR} op something .'  
   as seen in make(1).  
   To escape the dot, one would use `\&.'.  
   
 - 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  
 ************************************************************************  
   
 ************************************************************************  
 * missing features  * missing features
 ************************************************************************  ************************************************************************
   
 --- missing roff features ----------------------------------------------  --- missing roff features ----------------------------------------------
   
   - 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 (adjust margins)
   .ad l -- adjust left margin only (flush left)    .ad l -- adjust left margin only (flush left)
   .ad r -- adjust right margin only (flush right)    .ad r -- adjust right margin only (flush right)
Line 58 
Line 31 
   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500    reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
   
 - xloadimage(1) wants .ti (temporary indent), rep by naddy@  - 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)  - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500    reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
   
 - pod2man expects `tr' to be implemented for \*(-- to work  - \c (interrupted text) should prevent the line break
     even inside .Bd literal; that occurs in chat(8)
   
 - \c (interrupted text) 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 ----------------------------------------------  --- missing mdoc features ----------------------------------------------
   
Line 101 
Line 78 
 - 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
   
   - 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  - inside `.Bl -column' phrases, punctuation is handled like normal
   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."    text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
   
Line 116 
Line 103 
   (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)
   
   - 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 -----------------------------------------------  --- missing man features -----------------------------------------------
   
 - bashbug(1) complains "line scope broken" after  
   .SM  
   .B something  
   should either just work or be a warning  
   reported by naddy@  
   
 - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)  - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500    reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
   
   - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
   
 --- missing tbl features -----------------------------------------------  --- missing tbl features -----------------------------------------------
   
 - implement basic non-parametric .de to support e.g. sox(1)  - implement basic non-parametric .de to support e.g. sox(1)
   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200    reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
   *** sox(1) still doesn't work, tbl(1) errors need investigation    *** 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 ----------------------------------------------  --- missing misc features ----------------------------------------------
   
 - clean up escape sequence handling, creating three classes:  - clean up escape sequence handling, creating three classes:
Line 174 
Line 169 
   so far, we only have it in roff(7) and man(7)    so far, we only have it in roff(7) and man(7)
   reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500    reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
   
 - perl(1) SYNOPSIS looks bad; reported by deraadt@  
   1) man(7) seems to need SYNOPSIS .Nm blocks, too  
   
 - In .Bl -column,  - In .Bl -column,
   .It Em Authentication<tab>Key Length    .It Em Authentication<tab>Key Length
   ought to render "Key Length" with emphasis, too,    ought to render "Key Length" with emphasis, too,
   see OpenBSD iked.conf(5).    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  - 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
Line 199 
Line 192 
   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059    reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
   
 ************************************************************************  ************************************************************************
 * formatting issues: gratuitious differences  * formatting issues: gratuitous differences
 ************************************************************************  ************************************************************************
   
 - .Rv (and probably .Ex) print different text if an `Nm' has been named  - .Rv (and probably .Ex) print different text if an `Nm' has been named
Line 210 
Line 203 
   is just "o\bo".    is just "o\bo".
   see for example OpenBSD ksh(1)    see for example OpenBSD ksh(1)
   
 - The characters "|" and "\*(Ba" should never be bold,  - .Pp between two .It in .Bl -column should produce one,
   not even in the middle of a word, e.g. ".Cm b\*(Bac" in    not two blank lines, see e.g. login.conf(5).
   "mknod [-m mode] name b|c major minor"    reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
   in OpenBSD ksh(1)    reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
   
 - 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), or before "is always true" in ksh(1).  
   The same happens with .Pp just before .El, see bgpd.conf(5).  
   Also have `It' complain if `Pp' is invoked at certain times (not  
   -compact?).  
   
 - If the *first* line after .It is .Pp, break the line right after  - If the *first* line after .It is .Pp, break the line right after
   the tag, do not pad with space characters before breaking.    the tag, do not pad with space characters before breaking.
   See the description of the a, c, and i commands in sed(1).    See the description of the a, c, and i commands in sed(1).
Line 243 
Line 229 
     .Bl -tag -width ".Dv message"      .Bl -tag -width ".Dv message"
   in magic(5), located in src/usr.bin/file, is the same    in magic(5), located in src/usr.bin/file, is the same
   as -width 7n, not -width 11n.    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
   
 - The \& zero-width character counts as output.  - The \& zero-width character counts as output.
   That is, when it is alone on a line between two .Pp,    That is, when it is alone on a line between two .Pp,
Line 251 
Line 239 
 - When .Fn arguments exceed one output line, all but the first  - When .Fn arguments exceed one output line, all but the first
   should be indented, see e.g. rpc(3);    should be indented, see e.g. rpc(3);
   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100    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"
   
 - .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:  - Header lines of excessive length:
   Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c    Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
   and document it in mdoc(7) and man(7) COMPATIBILITY    and document it in mdoc(7) and man(7) COMPATIBILITY
   found while talking to Chris Bennett    found while talking to Chris Bennett
   
 - In man(7), the sequence  - In man(7), the sequence
     .HP      .SH HEADER
     one line of regular text      <blank line>
     .SH      .PP
   should not produce two blank lines before the .SH,      regular text
   see for example named-checkconf(8).    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  - In man(7), the sequence
     regular text      regular text
     .RS  
     .IP      .IP
   should have a blank line between the text and the beginning of the      .IP "tag"
   indented paragraph, see for example sudo(1).      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,  - trailing whitespace must be ignored even when followed by a font escape,
   see for example    see for example
     makes      makes
Line 290 
Line 285 
   in dig(1).    in dig(1).
   
 ************************************************************************  ************************************************************************
 * error reporting issues  
 ************************************************************************  
   
 ************************************************************************  
 * performance issues  * performance issues
 ************************************************************************  ************************************************************************
   
Line 305  Several areas can be cleaned up to make mandoc even fa
Line 296  Several areas can be cleaned up to make mandoc even fa
   
 - the PDF file is HUGE: this can be reduced by using relative offsets  - the PDF file is HUGE: this can be reduced by using relative offsets
   
   - instead of re-initialising the roff predefined-strings set before each
     parse, create a read-only version the first time and copy it
   
 ************************************************************************  ************************************************************************
 * structural issues  * structural issues
 ************************************************************************  ************************************************************************
   
   - 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  - Find better ways to prevent endless loops
   in roff(7) macro and string expansion.    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.89  
changed lines
  Added in v.1.140

CVSweb