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

Diff for /mandoc/TODO between version 1.104 and 1.133

version 1.104, 2011/04/30 10:18:24 version 1.133, 2012/05/31 01:54:45
Line 4 
Line 4 
 ************************************************************************  ************************************************************************
   
 ************************************************************************  ************************************************************************
 * parser bugs  
 ************************************************************************  
   
 - .TP before .SH is still FATAL in man(7)  
   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
 ************************************************************************  ************************************************************************
   
 --- 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 48 
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
   
 - \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 ----------------------------------------------  --- missing mdoc features ----------------------------------------------
   
 - fix bad block nesting involving multiple identical explicit blocks  - fix bad block nesting involving multiple identical explicit blocks
Line 121 
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 -----------------------------------------------
   
 - .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)  - 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 183 
Line 176 
   .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 227 
Line 221 
 - .Pp between two .It in .Bl -column should produce one,  - .Pp between two .It in .Bl -column should produce one,
   not two blank lines, see e.g. login.conf(5).    not two blank lines, see e.g. login.conf(5).
   reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059    reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
     reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
   
 - 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.
Line 249 
Line 244 
     .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 257 
Line 254 
 - 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  - .Ns should work when called at the end of an input line, see
   the following code in vi(1):    the following code in vi(1):
Line 280 
Line 280 
   see for example named-checkconf(8).    see for example named-checkconf(8).
   
 - In man(7), the sequence  - 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      .SH HEADER
     <blank line>      <blank line>
     .PP      .PP
Line 297 
Line 290 
   
 - In man(7), the sequence  - In man(7), the sequence
     regular text      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
     .IP "tag"      .IP "tag"
     indented text      indented text
Line 329 
Line 308 
   should produce one, not three blank lines.    should produce one, not three blank lines.
   Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200    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 342 
Line 319 
 * error reporting issues  * error reporting issues
 ************************************************************************  ************************************************************************
   
   - .TP directly followed by .RS gives an assertion.
   
 ************************************************************************  ************************************************************************
 * performance issues  * performance issues
 ************************************************************************  ************************************************************************
Line 354  Several areas can be cleaned up to make mandoc even fa
Line 333  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.
Legend:
Removed from v.1.104  
changed lines
  Added in v.1.133
CVSweb