Remove fixed TODO and add a new one.

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index 05e0a2fafc9fcabe3d96da9610290b2136d7b076..9b549ebcb2e3249bd8a48cd2b4b8d2bf7d6d5ef7 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,6 @@
 ************************************************************************
-* Official mandoc TODO.  May not be quite up to date.
-* $Id: TODO,v 1.36 2010/08/07 17:52:36 kristaps Exp $
+* Official mandoc TODO.
+* $Id: TODO,v 1.52 2010/09/25 16:52:15 kristaps 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,7 +73,7 @@
 
 - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
   noted by Alex Kozlov 08/06/10 23:05
-  
+
 ************************************************************************
 * formatting issues: ugly output
 ************************************************************************
@@ -74,17 +81,73 @@
 - 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
 
-- %A doesn't put an "and" before the final author name.
+- in enclosures, mandoc sometimes fancies a bogus end of sentence
+  reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
 
 ************************************************************************
 * formatting issues: gratuitious differences
 ************************************************************************
 
-- none reported right now (yet schwarze@ knows of some)
+- .%T should be quoted, not underlined, when .%J is also present,
+  to better distinguish the contents of .%T and .%J,
+  see for example OpenBSD cat(1)
+
+- .It ${name Ns [ selector ] Ns }
+  should be "${name[selector]}" not "${name [selector]}"
+  This is parsed as
+  text("${name") text("[") Ns() text(selector)...
+  Opening punctuation should not fall out of .Ns.
+  see for example OpenBSD csh(1)
+
+- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
+  is just "o\bo".
+  see for example OpenBSD ksh(1)
+
+- .No text No ) is "text )", not "text)"
+  see the terrible example
+    case word in [[(]  pattern [| pattern] ... ) list ;; ] ... esac
+  in OpenBSD ksh(1)
+
+- .Sm should *not* produce as a blank line in .Bd -literal
+  see for example "Brace expansion" in 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).
+
+- .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).
+
+- 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
@@ -96,12 +159,10 @@ Several areas can be cleaned up to make mandoc even faster.  These are
 
 - improve hashing mechanism for characters (not as important)
 
+- the PDF file is HUGE: this can be reduced by using relative offsets
+
 ************************************************************************
 * structural issues
 ************************************************************************
 
-- rendering frontend code can calculate widths only for plain strings,
-  not for strings containing escape sequences.  For example, this
-  hinders calculation of the indent required for .Nm \&[ in text(1).
-  comments from kristaps@  Wed, 21 Jul 2010 23:26:08 +0200
-
+- remove superfluous NOSPACE invocations (e.g., with term_word(p, "("))