First, properly escape periods with \&. Then consistently refer to

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index 3b1425fb68a60feb463578c9ae0cc6c20a7d3787..bca6d03c8cc755b3b21529585d2f0d5c76e49af8 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,6 @@
 ************************************************************************
 * Official mandoc TODO.
-* $Id: TODO,v 1.84 2011/01/25 10:37:49 kristaps Exp $
+* $Id: TODO,v 1.98 2011/03/30 00:02:40 schwarze Exp $
 ************************************************************************
 
 ************************************************************************
@@ -10,15 +10,6 @@
 - .TP before .SH is still FATAL in man(7)
   reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500
 
-- The mdoc(7) parser should handle `\.' as punctuation:
-    .Ql .if ${VAR} op something \.
-  should produce
-    `.if ${VAR} op something'.
-  not
-    `.if ${VAR} op something .'
-  as seen in make(1).
-  To escape the dot, one would use `\&.'.
-
 - the roff parser doesn't tolerate additional characters between
   a macro and the \} terminating a conditional block, e.g.
   .if n \{
@@ -60,6 +51,11 @@
 
 - \c (interrupted text) occurs in chat(8)
 
+- \f(CW (constant width font) occurs in rsyncd.conf(5).
+  I think we should treat unknown/unavailable fonts as \fR
+  such that switching back with \fP works correctly -
+  and doesn't revert the _previous_ \fP.
+
 --- missing mdoc features ----------------------------------------------
 
 - fix bad block nesting involving multiple identical explicit blocks
@@ -112,12 +108,6 @@
 
 --- missing man features -----------------------------------------------
 
-- bashbug(1) complains "line scope broken" after
-  .SM
-  .B something
-  should either just work or be a warning
-  reported by naddy@
-
 - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
 
@@ -160,6 +150,9 @@
 * formatting issues: ugly output
 ************************************************************************
 
+- a column list with blank `Ta' cells triggers a spurrious
+  start-with-whitespace printing of a newline
+
 - double quotes inside double quotes are escaped by doubling them
   implement this in mdoc(7), too
   so far, we only have it in roff(7) and man(7)
@@ -225,15 +218,6 @@
   should be "NetBSD 1.0A", not "NetBSD 1.0a",
   see OpenBSD ccdconfig(8).
 
-- The space character joining .Dx .Fx .Nx .Ox (are these all?) to its
-  argument is non-breaking.  See the cdio(1) HISTORY and many others.
-
-- .Bx uses a dash before its argument, not a space,
-  see for example the chpass(1) and column(1) HISTORY.
-  Besides, the second argument is capitalized, for example,
-    .Bx 4.3 tahoe .
-  produces 4.3BSD-Tahoe.
-
 - 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).
@@ -252,10 +236,6 @@
   should be indented, see e.g. rpc(3);
   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
 
-- .Ns should only be effective when called by another macro,
-  not as a stand-alone macro at the beginning of a line;
-  see for example the awk(1) SYNOPSIS.
-
 - .Ns should work when called at the end of an input line, see
   the following code in vi(1):
     .It Xo
@@ -284,6 +264,49 @@
   should have a blank line between the text and the beginning of the
   indented paragraph, see for example sudo(1).
 
+- In man(7), the sequence
+    .SH HEADER
+    <blank line>
+    .PP
+    regular text
+  should not produce any blank lines between the header and the text,
+  see for example rsync(1).
+  Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
+
+- In man(7), the sequence
+    regular text
+    .PP
+    .RS
+    indented text
+  should produce one blank line between the regular and indented texts,
+  see for example rsync(1), and
+    .RE
+    <blank line>
+    .PP
+    .RS
+  should produce two,not one blank lines.
+  Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
+
+- In man(7), the sequence
+    regular text
+    .IP
+    .IP "tag"
+    indented text
+  should produce one, not four blank lines between the regular text
+  and the tag, see for example rsync(1).
+  Likewise,
+    regular text
+    .IP
+    indented text
+  should produce one, not two blank lines in between, and
+    regular text
+    .IP
+    .RS
+    .IP tag
+    indented text
+  should produce one, not three blank lines.
+  Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200
+
 - At least sometimes, .sp is ignored right after .SH; see named.conf(5).
 
 - trailing whitespace must be ignored even when followed by a font escape,
@@ -315,4 +338,8 @@ Several areas can be cleaned up to make mandoc even faster.  These are
 
 - Find better ways to prevent endless loops
   in roff(7) macro and string expansion.
-  
+ 
+- Finish cleanup of date handling.
+  Decide which formats should be recognized where.
+  Update both mdoc(7) and man(7) documentation.
+  Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100