"sys/param.h is for kernel interface programs.

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index afd4c62beb6458402024e2b753068bba21ae536c..937911847698c8053d66bff10319850f0b2a6900 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,6 @@
 ************************************************************************
 * Official mandoc TODO.
-* $Id: TODO,v 1.38 2010/08/15 16:38:35 schwarze Exp $
+* $Id: TODO,v 1.42 2010/08/20 22:51:29 schwarze Exp $
 ************************************************************************
 
 ************************************************************************
@@ -56,6 +56,13 @@
 - explicitly disallow nested `Bl -column', which would clobber internal
   flags defined for struct mdoc_macro
 
+- inside `.Bl -column' phrases, punctuation is handled like normal
+  text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
+
+- inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
+  is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
+  but should give "ab ."
+
 - set a meaningful default if no `Bl' list type is assigned
 
 - have a blank `It' head for `Bl -tag' not puke
@@ -66,6 +73,9 @@
 
 - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
   noted by Alex Kozlov 08/06/10 23:05
+
+- 'br\} doesn't correctly close scope.
+  Noted by joerg@, 28/7/2010.
   
 ************************************************************************
 * formatting issues: ugly output
@@ -74,6 +84,11 @@
 - perl(1) SYNOPSIS looks bad; reported by deraadt@
   1) man(7) seems to need SYNOPSIS .Nm blocks, too
 
+- In .Bl -column,
+  .It Em Authentication<tab>Key Length
+  ought to render "Key Length" with emphasis, too,
+  see OpenBSD iked.conf(5).
+
 - empty phrases in .Bl column produce too few blanks
   try e.g. .Bl -column It Ta Ta
   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
@@ -117,7 +132,36 @@
   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).
+  see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
+  or in DIAGNOSTICS in init(8).
+
+- .Bd -literal and .Bd -unfilled are *not* identical.
+  In -literal, tabs are 8 spaces.
+  In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
+  See the CCDF_* display in OpenBSD ccdconfig(8).
+
+- In .Bd -unfilled, .Pp should produce one blank line, not two;
+  see the ccd.conf display in OpenBSD ccdconfig(8).
+
+- .Nx 1.0a
+  should be "NetBSD 1.0A", not "NetBSD 1.0a",
+  see OpenBSD ccdconfig(8).
+
+- In .Bl -tag, if a tag exceeds the right margin and must be continued
+  on the next line, it must be indented by -width, not width+1;
+  see "rule block|pass" in OpenBSD ifconfig(8).
+
+- When .%T is used outside an .Rs context and with a trailing comma,
+  there is no point in rendering two commata,
+  see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).
+
+- When .%T is used outside an .Rs context and without a trailing comma,
+  no comma should be rendered at all,
+  see the first paragraph of the DESCRIPTION in OpenBSD exports(5).
+
+- Bogus .Pp before .Bl should not cause a double blank line,
+  see "The route utility provides the following simple commands:"
+  in OpenBSD route(8).
 
 ************************************************************************
 * performance issues
@@ -145,3 +189,7 @@ Several areas can be cleaned up to make mandoc even faster.  These are
   in OpenBSD ksh(1) gives the wrong width
   because "\e" is one character in groff, two in mandoc
 
+- Now that `ds' is minimally supported, we can get rid of some
+  predefined strings.  \*(C+ has already been thrown out.  Track these
+  down and whack them.  Look in e.g. gcc.1 for the top-level `ds'
+  invocations.  These are reproduced across most crappy GNU manuals.