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

Diff for /mandoc/TODO between version 1.1 and 1.14

version 1.1, 2010/05/14 18:20:20 version 1.14, 2010/06/01 22:05:59
Line 1 
Line 1 
   
 Before trying to fix anything from this list,  
 check against -current mandoc from OpenBSD CVS.  
 Sometimes, i'm a bit behind marking entries FIXED.  
   
 In general, i keep FIXED entries for some time  
 and remove them when they turn into old news.  
   
 ************************************************************************  ************************************************************************
 * missing features  * missing features
 ************************************************************************  ************************************************************************
   
   - .` "macro" not implemented (see gnu/usr.bin/cvs/man/cvs.1)
     found by Anthony Bentley (anthonyjbentley@gmail.com)
     06/01/10 23:48 on tech@openbsd
   
 - explicit blocks with missing end macro should be implicitely closed  - explicit blocks with missing end macro should be implicitely closed
   at the end of the enclosing block, e.g. .Bl It (El) Sh    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    reminded by stsp@  in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200
Line 29  and remove them when they turn into old news.
Line 25  and remove them when they turn into old news.
   reminded by Ludo Smissaert  Mon, 10 May 2010 12:15:11 +0200    reminded by Ludo Smissaert  Mon, 10 May 2010 12:15:11 +0200
   also reported by jmc@ earlier    also reported by jmc@ earlier
   
 - man(7) .TH should recognize "3p" as a section number  
   found in usr.bin/pkg_add OpenBSD::Getopt  
   
 - implement \\  - implement \\
   in plain text, identical to \e    in plain text, identical to \e
   as a macro argument, identical to \ i.e. escaping the next character    as a macro argument, identical to \ i.e. escaping the next character
Line 52  and remove them when they turn into old news.
Line 45  and remove them when they turn into old news.
 - FIXED OpenBSD term.h 1.16 term.c 1.30 mdoc_term.c 1.75 schwarze 23.4.10  - 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)    handle tab characters outside literal context, e.g. usb(4)
   reported by jmc@  Mon, 19 Apr 2010 07:42:12 +0100    reported by jmc@  Mon, 19 Apr 2010 07:42:12 +0100
     NEEDS MERGING TO bsd.lv
   
 - FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9  - FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9
   man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15    man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15
   man_term.c 1.28 man_html.c 1.9 schwarze 25.4.    man_term.c 1.28 man_html.c 1.9 schwarze 25.4.
   implement .if .ie .el    implement .if .ie .el
   noticed by espie@  Fri, 23 Apr 2010 17:10:35 +0200    noticed by espie@  Fri, 23 Apr 2010 17:10:35 +0200
     NEEDS MERGING TO bsd.lv
   
 - FIXED bsd.lv libman.h 1.31 libmdoc.h 1.34 man.c 1.60 mdoc.c 1.123  - implement blank `Bl -column', such as
         kristaps@ 8.4.10    .Bl -column
   FIXED OpenBSD libman.h 1.17 libmdoc.h 1.28 man.c 1.26 mdoc.c 1.45    .It foo Ta bar
         schwarze@ 8.5.10    .El
   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  
   
   - explicitly disallow nested `Bl -column', which would clobber internal
     flags defined for struct mdoc_macro
   
   - set a meaningful default if no `Bl' list type is assigned
   
   - have a blank `It' head for `Bl -tag' not puke
   
 ************************************************************************  ************************************************************************
 * formatting issues: ugly output  * formatting issues: ugly output
 ************************************************************************  ************************************************************************
Line 87  and remove them when they turn into old news.
Line 84  and remove them when they turn into old news.
 - do not break the line after "--", it's probably a long option  - do not break the line after "--", it's probably a long option
   reminded by stsp in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200    reminded by stsp in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200
   
 - in .Bl -column .It, "\t" seems to be synonymous to " Ta ",  
   see sysctl(3) for many examples;  
   mishandling this results in spurious quotes at EOL  
   reminded by guenther@  Mon, 26 Apr 2010 01:16:52 -0700  
   
 - URGENT, this is making many kernel manuals look bad:  - URGENT, this is making many kernel manuals look bad:
   .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?    .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
   autoconf.9:    autoconf.9:
Line 116  and remove them when they turn into old news.
Line 108  and remove them when they turn into old news.
   try e.g. .Bl -column It Ta Ta    try e.g. .Bl -column It Ta Ta
   reported by millert Fri, 02 Apr 2010 16:13:46 -0400    reported by millert Fri, 02 Apr 2010 16:13:46 -0400
   
   - nroff inserts a space before :, mandoc doesn't:
       .Dl expr "/$a" Li : '.*/\e(.*\e)'
   
 - FIXED on bsd.lv for mdoc, need to merge and test in OpenBSD  
     kristaps@  Mon, 10 May 2010 03:12:44 +0200  
     man fix still pending!  
   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  
     kristaps@  Mon, 10 May 2010 02:59:40 +0200  
   do not mark \*(Ba and | up  
   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  
   
   
 ************************************************************************  ************************************************************************
 * formatting issues: gratuitious differences  * formatting issues: gratuitious differences
 ************************************************************************  ************************************************************************
   
 - in literal context, groff disables the right margin  - FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10
   an example: syslog.conf.5 EXAMPLES section    lines containing blank characters, and nothing else,
   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,  
   in literal context (.Bd -literal):    in literal context (.Bd -literal):
   groff outputs just blank lines "\n"    groff outputs just blank lines "\n"
   mandoc outputs blanks to the left margin,    mandoc outputs blanks to the left margin,
   then the number of balnks minus one    then the number of balnks minus one
     NEEDS MERGING TO bsd.lv
   
   
 - FIXED bsd.lv mdoc_html.c 1.61 mdoc_term.c 1.117 kristaps@ 8.4.10  
   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  
   
   
 ************************************************************************  ************************************************************************
 * parser errors without any effect on formatting  * parser errors without any effect on formatting
 ************************************************************************  ************************************************************************
   
 - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree  - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree
   
   ************************************************************************
   * performance issues
   ************************************************************************
   
   Several areas can be cleaned up to make mandoc even faster.  These are
   
   - cache `Bd' display types as `Bl' types are cached (this primarily
     improves code-size by removing the a2disp type functions)
   
   - improve caching mechanism to handle other per-element arguments so
     that they need not be recalculated between front- and back-ends (also
     reduces code size and complexity)
   
   - improve hashing mechanism for macros (quite important: performance)
   
   - improve hashing mechanism for characters (not as important)
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.14
CVSweb