Clean-ups in -T[x]html: inline print_num(), as it was just a single

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index 9615a49916bb2c09070cd87cdb290527c2affad2..06a2f21e6f79a39d76c4e500d04a6c3908b23bcb 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,6 @@
 ************************************************************************
 * Official mandoc TODO.
-* $Id: TODO,v 1.94 2011/03/22 15:30:30 kristaps Exp $
+* $Id: TODO,v 1.104 2011/04/30 10:18:24 kristaps Exp $
 ************************************************************************
 
 ************************************************************************
@@ -20,6 +20,11 @@
 * formatter bugs
 ************************************************************************
 
+- tbl(7): Horizontal and vertical lines are formatted badly:
+  With the box option, there is too much white space at the end of cells.
+  Horizontal lines from "=" lines are a bit too long.
+  yuri dot pankov at gmail dot com  Thu, 14 Apr 2011 05:45:26 +0400
+
 ************************************************************************
 * missing features
 ************************************************************************
@@ -51,6 +56,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
@@ -86,6 +96,16 @@
 - explicitly disallow nested `Bl -column', which would clobber internal
   flags defined for struct mdoc_macro
 
+- In .Bl -column .It, the end of the line probably has to be regarded
+  as an implicit .Ta, if there could be one, see the following mildly
+  ugly code from login.conf(5):
+    .Bl -column minpasswordlen program xetcxmotd
+    .It path Ta path Ta value of Dv _PATH_DEFPATH
+    .br
+    Default search path.
+  reported by Michal Mazurek <akfaew at jasminek dot net>
+  via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
+
 - inside `.Bl -column' phrases, punctuation is handled like normal
   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
 
@@ -103,11 +123,8 @@
 
 --- missing man features -----------------------------------------------
 
-- bashbug(1) complains "line scope broken" after
-  .SM
-  .B something
-  should either just work or be a warning
-  reported by naddy@
+- .RS/.RE can be nested, see e.g. the x11/fluxbox manuals
+  noticed by dcoppa@  Wed, Apr 13, 2011 at 04:58:14PM +0200:
 
 - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
@@ -184,7 +201,7 @@
   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
 
 ************************************************************************
-* formatting issues: gratuitious differences
+* formatting issues: gratuitous differences
 ************************************************************************
 
 - .Rv (and probably .Ex) print different text if an `Nm' has been named
@@ -207,6 +224,10 @@
   Also have `It' complain if `Pp' is invoked at certain times (not
   -compact?).
 
+- .Pp between two .It in .Bl -column should produce one,
+  not two blank lines, see e.g. login.conf(5).
+  reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
+
 - If the *first* line after .It is .Pp, break the line right after
   the tag, do not pad with space characters before breaking.
   See the description of the a, c, and i commands in sed(1).
@@ -265,6 +286,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,
@@ -297,11 +361,7 @@ 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.
  
-- Clean up date handling.
-  Store dates as strings, not time numbers.
-  When the format is not recognized, just use the string from the input.
-  When the format is recognized, normalize the string to whatever
-  format is standard at the respective place.
+- 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