Clean up some tight spots in mandoc's default mode: pessimistically

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index 5d587515239922299ee250dc93ae3d371933f502..4f8e591ebb862ed7d121cbfc0adabe67d4f6bbb1 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,3 +1,8 @@
+************************************************************************
+* Official mandoc TODO.  May not be quite up to date.
+* $Id: TODO,v 1.33 2010/07/25 18:22:18 schwarze Exp $
+************************************************************************
+
 ************************************************************************
 * missing features
 ************************************************************************
@@ -16,6 +21,14 @@
   lib/libc/gen/signal.3
   lib/libc/sys/sigaction.2
 
+- edge case: decide how to deal with blk_full bad nesting, e.g.
+  .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
+  from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
+
+- auto-Bk in the SYNOPSIS
+  patch from kristaps@  Fri, 16 Jul 2010 14:51:24 +0200
+  to be revisited after OpenBSD 4.8 tree unlock
+
 - implement \\
   in plain text, identical to \e
   as a macro argument, identical to \ i.e. escaping the next character
@@ -23,15 +36,6 @@
   \\ must behave in a macro def like in a macro argument,
   and when using the macro, it must expand yet again.
 
-- implement \s (physical font size)
-  \sN - set to N
-  \s+N - increment by N, 1 <= N <= 8
-  \s-N - decrement by N, 1 <= N <= 8
-  \s0 - restore previous size
-  \s(nn \s+-(nn \s'+-nn' \s+-'nn' \s[+-nn] \s+-[nn] - disambiguate
-  registers: .s .ps .sr .psr
-  used by e.g. cu(1), tip(1)
-
 - look at bsd.lv tbl(1)
   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
   also look at the mail from Thomas Klausner wiz at NetBSD
@@ -55,9 +59,6 @@
 
 - have a blank `It' head for `Bl -tag' not puke
 
-- ignore horrendous m[] font colouring
-  reported by J.C. Roberts
-
 - prohibit `Nm' from having non-text HEAD children
   (e.g., NetBSD mDNSShared/dns-sd.1)
   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
@@ -66,16 +67,19 @@
 * formatting issues: ugly output
 ************************************************************************
 
-- outside list context, text following .Sm off
-  seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
-        .Sm off
-        .Xo
-        .Op Ar bind_address No /
-        .Ar port
-        .Xc
-        .Sm on
-        or by enclosing
-  reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
+- boot_config.8
+    .Bd -literal
+    .No UKC> Ic find ne
+    24 ne0 at isa0
+  should be
+    UKC> find ne
+    24 ne0 at isa0
+  but is
+    UKC>find ne24 ne0 at isa0
+  from jmc@  Wed, 21 Jul 2010 22:40:02 +0100
+
+- perl(1) SYNOPSIS looks bad; reported by deraadt@
+  1) man(7) seems to need SYNOPSIS .Nm blocks, too
 
 - empty phrases in .Bl column produce too few blanks
   try e.g. .Bl -column It Ta Ta
@@ -101,3 +105,8 @@ Several areas can be cleaned up to make mandoc even faster.  These are
 * 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
+