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

Diff for /mandoc/TODO between version 1.14 and 1.20

version 1.14, 2010/06/01 22:05:59 version 1.20, 2010/07/02 10:43:21
Line 2 
Line 2 
 * 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
   
   - fix bad block nesting involving multiple identical explicit blocks
     see the OpenBSD mdoc_macro.c 1.47 commit message
   
   - we need real .ds; for example, terminfo.3 has
     .ds n 5
     and then later
     \fBterminfo\fR(\*n)
     reported orally by halex@ during c2k10
   
   - \*(Pu is not implemented, but used in mdoc.samples
     implementing .ds would solve this as well
     reminded by jmc@, last on Sun, 27 Jun 2010 15:29:18 +0100
   
 - .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 17 
Line 26 
   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.  
   $ man ssh  
   [...]  
   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  
   
 - 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 34 
Line 35 
   
 - look at bsd.lv tbl(1)  - look at bsd.lv tbl(1)
   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200    from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
     also look at the mail from Thomas Klausner wiz at NetBSD
       on Wed, 2 Jun 2010 11:01:29 +0200
   
 - 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
Line 41 
Line 44 
   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
   
   
 - 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)  
   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  
   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.  
   implement .if .ie .el  
   noticed by espie@  Fri, 23 Apr 2010 17:10:35 +0200  
   NEEDS MERGING TO bsd.lv  
   
 - implement blank `Bl -column', such as  - implement blank `Bl -column', such as
   .Bl -column    .Bl -column
   .It foo Ta bar    .It foo Ta bar
Line 65 
Line 55 
 - set a meaningful default if no `Bl' list type is assigned  - set a meaningful default if no `Bl' list type is assigned
   
 - have a blank `It' head for `Bl -tag' not puke  - have a blank `It' head for `Bl -tag' not puke
   
   - ignore horrendous m[] font colouring
     reported by J.C. Roberts
   
   - 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)
   
 ************************************************************************  ************************************************************************
 * formatting issues: ugly output  * formatting issues: ugly output
Line 81 
Line 78 
         or by enclosing          or by enclosing
   reported by jmc Tue, 13 Apr 2010 08:48:14 +0100    reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
   
 - 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  
   
 - URGENT, this is making many kernel manuals look bad:  
   .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?  
   autoconf.9:  
     .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.  - indentation got lost in SYNOPSIS, e.g.
    SYNOPSIS     SYNOPSIS
         date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]          date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
Line 108 
Line 89 
   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)'  
   
 ************************************************************************  ************************************************************************
 * formatting issues: gratuitious differences  * formatting issues: gratuitious differences
 ************************************************************************  ************************************************************************
   
 - FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10  - none reported right now (yet schwarze@ knows of some)
   lines containing blank characters, and nothing else,  
   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  
   NEEDS MERGING TO bsd.lv  
   
   
 ************************************************************************  ************************************************************************
 * parser errors without any effect on formatting  
 ************************************************************************  
   
 - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree  
   
 ************************************************************************  
 * performance issues  * performance issues
 ************************************************************************  ************************************************************************
   
 Several areas can be cleaned up to make mandoc even faster.  These are  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  - improve caching mechanism to handle other per-element arguments so
   that they need not be recalculated between front- and back-ends (also    that they need not be recalculated between front- and back-ends (also
   reduces code size and complexity)    reduces code size and complexity):
       `Bl -column' pointer
       `Bf' font type
   
 - improve hashing mechanism for macros (quite important: performance)  - improve hashing mechanism for macros (quite important: performance)
   
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.20
CVSweb