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

Diff for /mandoc/TODO between version 1.115 and 1.162

version 1.115, 2011/06/30 08:05:13 version 1.162, 2013/12/25 14:40:34
Line 4 
Line 4 
 ************************************************************************  ************************************************************************
   
 ************************************************************************  ************************************************************************
 * parser bugs  * crashes
 ************************************************************************  ************************************************************************
   
 - .TP before .SH is still FATAL in man(7)  None known.
   reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500  
   
 ************************************************************************  ************************************************************************
 * 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 34 
Line 29 
   .ad   -- re-enable adjustment without changing the mode    .ad   -- re-enable adjustment without changing the mode
   Adjustment mode is ignored while in no-fill mode (.nf).    Adjustment mode is ignored while in no-fill mode (.nf).
   
 - .it (line traps) occur in mysql(1), yasm_arch(7)  - .as (append to string)
   generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>    found by jca@ in ratpoison(1)  Sun, 30 Jun 2013 12:01:09 +0200
   reported by brad@  Sat, 15 Jan 2011 15:48:18 -0500  
   - .ce (center N lines)
     found by naddy@ in xloadimage(1)
     found by Juan Francisco Cantero Hurtado <iam at juanfra dot info>
              in lang/racket(1)  Thu, 20 Jun 2013 03:19:11 +0200
   
   - .fc (field control)
     found by naddy@ in xloadimage(1)
   
   - .ll (line length)
     found by naddy@ in textproc/enchant(1)  Sat, 12 Oct 2013 03:27:10 +0200
   
   - .nr third argument (auto-increment step size, requires \n+)
     found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
   
 - .ns (no-space mode) occurs in xine-config(1)  - .ns (no-space mode) occurs in xine-config(1)
   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@  
   
 - .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  - .ti (temporary indent)
     found by naddy@ in xloadimage(1)
     found by bentley@ in nmh(1)  Mon, 23 Apr 2012 13:38:28 -0600
   
 - \c (interrupted text) occurs in chat(8)  - .while and .shift
     found by jca@ in ratpoison(1)  Sun, 30 Jun 2013 12:01:09 +0200
   
   - \c (interrupted text) should prevent the line break
     even inside .Bd literal; that occurs in chat(8)
     also found in cclive(1) - DocBook output
   
   - \h horizontal move
     found in cclive(1) DocBook output
     Anthony J. Bentley on discuss@  Sat, 21 Sep 2013 22:29:34 -0600
   
   - \n+ and \n- numerical register increment and decrement
     found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
   
   - 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 ----------------------------------------------
   
 - fix bad block nesting involving multiple identical explicit blocks  - fix bad block nesting involving multiple identical explicit blocks
Line 122 
Line 145 
   
 - 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
     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 -----------------------------------------------  --- 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)
Line 135 
Line 162 
   
 --- missing misc features ----------------------------------------------  --- missing misc features ----------------------------------------------
   
   - italic correction (\/) in PostScript mode
     Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
   
   - The whatis(1) utility looks for whole words in Nm.
     If the file name of a page does not agree with the contents of any
     of its Nm macros (e.g. pool(9)), add the file name as an Nm entry
     to the mandoc.db as well, such that whatis(1) finds it.
     If there is a page with a file name that does not appear as a substring
     neither in Nm nor in Nd, the same fix would allow finding that page
     with apropos(1) using the file name as a key, as well.
     Issue reported by tedu@  Fri, 05 Jul 2013 21:15:23 -0400
   
 - clean up escape sequence handling, creating three classes:  - clean up escape sequence handling, creating three classes:
   (1) fully implemented, or parsed and ignored without loss of content    (1) fully implemented, or parsed and ignored without loss of content
   (2) unimplemented, potentially causing loss of content    (2) unimplemented, potentially causing loss of content
Line 142 
Line 181 
       see textproc/mgdiff(1) for nice examples        see textproc/mgdiff(1) for nice examples
   (3) undefined, just output the character -> perhaps WARNING    (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.
Line 157 
Line 188 
   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
   
   - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
     First impression is not that bad.
   
 - check compatibility with Plan9:  - check compatibility with Plan9:
   http://swtch.com/usr/local/plan9/tmac/tmac.an    http://swtch.com/usr/local/plan9/tmac/tmac.an
   http://swtch.com/plan9port/man/man7/man.html    http://swtch.com/plan9port/man/man7/man.html
Line 169 
Line 203 
 - a column list with blank `Ta' cells triggers a spurrious  - a column list with blank `Ta' cells triggers a spurrious
   start-with-whitespace printing of a newline    start-with-whitespace printing of a newline
   
 - double quotes inside double quotes are escaped by doubling them  
   implement this in mdoc(7), too  
   so far, we only have it in roff(7) and man(7)  
   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 195 
Line 222 
   of in_line() - put trailing punctuation out of scope.    of in_line() - put trailing punctuation out of scope.
   Found in mount_nfs(8) and exports(5), search for "Appendix".    Found in mount_nfs(8) and exports(5), search for "Appendix".
   
   - Trailing punctuation after .%T triggers EOS spacing, at least
     outside .Rs (eek!).  Simply setting ARGSFL_DELIM for .%T is not
     the right solution, it sends mandoc into an endless loop.
     reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
   
 - in enclosures, mandoc sometimes fancies a bogus end of sentence  - in enclosures, mandoc sometimes fancies a bogus end of sentence
   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059    reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
   
   - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
     reveals lots of bugs both in groff and mandoc...
     reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
   
 ************************************************************************  ************************************************************************
 * formatting issues: gratuitous differences  * formatting issues: gratuitous differences
 ************************************************************************  ************************************************************************
Line 210 
Line 246 
   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,  
   not even in the middle of a word, e.g. ".Cm b\*(Bac" in  
   "mknod [-m mode] name b|c major minor"  
   in OpenBSD ksh(1)  
   
 - 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?).  
   
 - .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 234 
Line 259 
   in between, see for example tmux(1).    in between, see for example tmux(1).
   reported by nicm@  13 Jan 2011 00:18:57 +0000    reported by nicm@  13 Jan 2011 00:18:57 +0000
   
   - Trailing punctuation after .It should trigger EOS spacing.
     reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
     Probably, this should be fixed somewhere in termp_it_pre(), not sure.
   
 - .Nx 1.0a  - .Nx 1.0a
   should be "NetBSD 1.0A", not "NetBSD 1.0a",    should be "NetBSD 1.0A", not "NetBSD 1.0a",
   see OpenBSD ccdconfig(8).    see OpenBSD ccdconfig(8).
Line 247 
Line 276 
     .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
     reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
     An easy partial fix would be to just skip the first word if it starts
     with a dot, including any following white space, when measuring.
   
 - 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,
   we want three blank lines, not two as in mandoc.    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:  - 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  
     .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  
     .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  
     .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  
   
 - 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 314 
Line 299 
   in dig(1).    in dig(1).
   
 ************************************************************************  ************************************************************************
 * error reporting issues  
 ************************************************************************  
   
 ************************************************************************  
 * performance issues  * performance issues
 ************************************************************************  ************************************************************************
   
Line 335  Several areas can be cleaned up to make mandoc even fa
Line 316  Several areas can be cleaned up to make mandoc even fa
 ************************************************************************  ************************************************************************
 * 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.115  
changed lines
  Added in v.1.162

CVSweb