]> git.cameronkatri.com Git - mandoc.git/blobdiff - TODO
Fixed a goddamn subtle error causing MDOC_LITERAL to remain set after a
[mandoc.git] / TODO
diff --git a/TODO b/TODO
index d497a92caed5854fc62c0366727eed81ca09c425..54914944e88244c13731ad91f4f38ebeac8eeefa 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,8 +1,23 @@
 ************************************************************************
 * Official mandoc TODO.
-* $Id: TODO,v 1.58 2010/10/01 21:51:13 schwarze Exp $
+* $Id: TODO,v 1.65 2010/11/29 13:04:31 kristaps Exp $
 ************************************************************************
 
+************************************************************************
+* parser bugs
+************************************************************************
+
+- the roff parser doesn't tolerate additional characters between
+  a macro and the \} terminating a conditional block, e.g.
+  .if n \{
+  .br \}
+  reported by ulrich spoerlein  Tue, 19 Oct 2010 20:39:50 +0200
+
+- .BI "string string " word punct in gettext(3)
+  add bogus line breaks (rep by naddy@)
+  committed; currently working on IP and TP?
+  and what about B and I?
+
 ************************************************************************
 * missing features
 ************************************************************************
   \\ must behave in a macro def like in a macro argument,
   and when using the macro, it must expand yet again.
 
-- 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
-    on Wed, 2 Jun 2010 11:01:29 +0200
-  joerg@ has patches for this somewhere...
+- implement basic non-parametric .de to support e.g. sox(1)
+  .de SP
+  .if t .sp .5
+  .if n .sp
+  ..
+  .de EX
+  .SP
+  .nf
+  .ft CW
+  ..
+  .de EE
+  .ft R
+  .SP
+  .fi
+  ..
+  reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
+
+- implement parametric .de to support e.g.
+  /usr/xenocara/lib/libXxf86vm/manXF86VM.man
+  .de ZN
+  .ie t \fB\^\\$1\^\fR\\$2
+  .el \fI\^\\$1\^\fP\\$2
+  ..
+  .ZN -lXxf86vm
+
+- clean up escape sequence handling, creating three classes:
+  (1) fully implemented, or parsed and ignored without loss of content
+  (2) unimplemented, potentially causing loss of content
+      or serious mangling of formatting (e.g. \n) -> ERROR
+      see textproc/mgdiff(1) for nice examples
+  (3) undefined, just output the character -> perhaps WARNING
+
+- port OpenBSD tbl integration bsd.lv, probably cleaning it up
 
 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
   These are a weird mixture of man(7) and custom autogenerated low-level
   close (in the post validation) or prior to open (pre).  This noted by
   jmc@ a thousand years ago.
 
+- xloadimage(1) wants .ti (temporary indent), rep by naddy@
+
+- bashbug(1) complains "line scope broken" after
+  .SM
+  .B something
+  should either just work or be a warning
+  reported by naddy@
+
 ************************************************************************
 * formatting issues: ugly output
 ************************************************************************
 * formatting issues: gratuitious differences
 ************************************************************************
 
+- .Rv (and probably .Ex) print different text if an `Nm' has been named
+  or not (run a manual without `Nm blah' to see this).  I'm not sure
+  that this exists in the wild, but it's still an error.
+
 - .%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)
   is just "o\bo".
   see for example 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"
   That is, when it is alone on a line between two .Pp,
   we want three blank lines, not two as in mandoc.
 
+- When .Fn arguments exceed one output line, all but the first
+  should be indented, see e.g. rpc(3);
+  reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
+
+- It seems that .TP does not want TWOSPACE after the tag;
+  see bashbug(1); reported by naddy@
+
+- Header lines of excessive length:
+  Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
+  and document it in mdoc(7) and man(7) COMPATIBILITY
+  found while talking to Chris Bennett
+
 ************************************************************************
 * performance issues
 ************************************************************************