Note missing man/roff(?) feature not documented anywhere.

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index 9e243109fa05febc9b8cfdc9924ceec1eb245f9a..3fc2d98b58bd47880946e91aed52b6689d33afe7 100644 (file)
--- a/TODO
+++ b/TODO
@@ -2,6 +2,10 @@
 * 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
   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
 - explicit blocks with missing end macro should be implicitely closed
   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


@@ -21,9 +25,6 @@
   reminded by Ludo Smissaert  Mon, 10 May 2010 12:15:11 +0200
   also reported by jmc@ earlier
 
   reminded by Ludo Smissaert  Mon, 10 May 2010 12:15:11 +0200
   also reported by jmc@ earlier
 

-- man(7) .TH should recognize "3p" as a section number
-  found in usr.bin/pkg_add OpenBSD::Getopt
-

 - implement \\
   in plain text, identical to \e
   as a macro argument, identical to \ i.e. escaping the next character
 - implement \\
   in plain text, identical to \e
   as a macro argument, identical to \ i.e. escaping the next character


@@ -53,7 +54,18 @@
   noticed by espie@  Fri, 23 Apr 2010 17:10:35 +0200
   NEEDS MERGING TO bsd.lv
 
   noticed by espie@  Fri, 23 Apr 2010 17:10:35 +0200
   NEEDS MERGING TO bsd.lv
 

+- implement blank `Bl -column', such as
+  .Bl -column
+  .It foo Ta bar
+  .El
+
+- 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
 ************************************************************************


@@ -72,11 +84,6 @@
 - 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
 
 - 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
 

-- 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:
   .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
   autoconf.9:
 - URGENT, this is making many kernel manuals look bad:
   .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
   autoconf.9:


@@ -101,21 +108,20 @@
   try e.g. .Bl -column It Ta Ta
   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
 
   try e.g. .Bl -column It Ta Ta
   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
 ************************************************************************
 

-- in literal context, groff disables the right margin
-  an example: syslog.conf.5 EXAMPLES section
-  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,
+- FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10
+  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
   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

 
 
 ************************************************************************
 
 
 ************************************************************************


@@ -124,3 +130,19 @@
 
 - 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)