update after recent code changes

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index ee7bee5352d4bd90c7db3beaa01a648a5245baba..78a54e728189c8e6b22e41251900332128e738be 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,13 +1,15 @@
 ************************************************************************
 * Official mandoc TODO.
 ************************************************************************
 * Official mandoc TODO.

-* $Id: TODO,v 1.160 2013/12/15 21:30:13 schwarze Exp $
+* $Id: TODO,v 1.172 2014/06/20 02:53:13 schwarze Exp $

 ************************************************************************
 
 ************************************************************************
 * crashes
 ************************************************************************
 
 ************************************************************************
 
 ************************************************************************
 * crashes
 ************************************************************************
 

-None known.
+- The abort() in bufcat(), html.c, can be triggered via buffmt_includes()
+  by running -Thtml -Oincludes on a file containing a long .In argument.
+  Fixing this will probably require reworking the whole bufcat() concept.

 
 ************************************************************************
 * missing features
 
 ************************************************************************
 * missing features


@@ -15,11 +17,6 @@ None known.
 
 --- missing roff features ----------------------------------------------
 
 
 --- missing roff features ----------------------------------------------
 

-- roff.c should treat \n(.H>23 and \n(.V>19 in the pod2man(1)
-  preamble as true, see for example AUTHORS in MooseX::Getopt.3p
-  reported by Andreas Voegele <mail at andreasvoegele dot com>
-  Tue, 22 Nov 2011 15:34:47 +0100 on ports@
-

 - .ad (adjust margins)
   .ad l -- adjust left margin only (flush left)
   .ad r -- adjust right margin only (flush right)
 - .ad (adjust margins)
   .ad l -- adjust left margin only (flush left)
   .ad r -- adjust right margin only (flush right)


@@ -29,20 +26,9 @@ None known.
   .ad   -- re-enable adjustment without changing the mode
   Adjustment mode is ignored while in no-fill mode (.nf).
 
   .ad   -- re-enable adjustment without changing the mode
   Adjustment mode is ignored while in no-fill mode (.nf).
 

-- .as (append to string)
-  found by jca@ in ratpoison(1)  Sun, 30 Jun 2013 12:01:09 +0200
-  
-- .ce (center N lines)
-  found by naddy@ in xloadimage(1)
-  found by Juan Francisco Cantero Hurtado <iam at juanfra dot info>
-           in lang/racket(1)  Thu, 20 Jun 2013 03:19:11 +0200
-

 - .fc (field control)
   found by naddy@ in xloadimage(1)
   
 - .fc (field control)
   found by naddy@ in xloadimage(1)
   

-- .ll (line length)
-  found by naddy@ in textproc/enchant(1)  Sat, 12 Oct 2013 03:27:10 +0200
-

 - .nr third argument (auto-increment step size, requires \n+)
   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
 
 - .nr third argument (auto-increment step size, requires \n+)
   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
 


@@ -51,6 +37,7 @@ None known.
 
 - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
 
 - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500

+  also Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100

 
 - .ti (temporary indent)
   found by naddy@ in xloadimage(1)
 
 - .ti (temporary indent)
   found by naddy@ in xloadimage(1)


@@ -70,9 +57,18 @@ None known.
 - \n+ and \n- numerical register increment and decrement
   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
 
 - \n+ and \n- numerical register increment and decrement
   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
 

+- \w'' width measurements
+  would not be very useful without an expression parser, see below
+  needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
+

 - using undefined strings or macros defines them to be empty
   wl@  Mon, 14 Nov 2011 14:37:01 +0000
 
 - using undefined strings or macros defines them to be empty
   wl@  Mon, 14 Nov 2011 14:37:01 +0000
 

+- general expression parser, including arithmetics
+  to be used at least for .if/.ie and .nr and maybe at other places
+  could use J.T.Conklin's PD code in bin/expr/expr.c for inspiration
+  needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
+

 --- missing mdoc features ----------------------------------------------
 
 - fix bad block nesting involving multiple identical explicit blocks
 --- missing mdoc features ----------------------------------------------
 
 - fix bad block nesting involving multiple identical explicit blocks


@@ -143,15 +139,13 @@ None known.
 
 --- missing man features -----------------------------------------------
 
 
 --- missing man features -----------------------------------------------
 

-- groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
-  reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
-  also occur in freeciv-client(6) freeciv-server(6) freeciv-modpack(6)
-  reported by bentley@  Tue, 30 Oct 2012 01:05:57 -0600
-

 - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
 
 --- missing tbl features -----------------------------------------------
 
 - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
 
 --- missing tbl features -----------------------------------------------
 

+- look at the POSIX manuals in the books/man-pages-posix port,
+  they use some unsupported tbl(7) features.
+

 - implement basic non-parametric .de to support e.g. sox(1)
   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
   *** sox(1) still doesn't work, tbl(1) errors need investigation
 - implement basic non-parametric .de to support e.g. sox(1)
   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
   *** sox(1) still doesn't work, tbl(1) errors need investigation


@@ -174,6 +168,13 @@ None known.
   with apropos(1) using the file name as a key, as well.
   Issue reported by tedu@  Fri, 05 Jul 2013 21:15:23 -0400
 
   with apropos(1) using the file name as a key, as well.
   Issue reported by tedu@  Fri, 05 Jul 2013 21:15:23 -0400
 

+- makewhatis(8) for preformatted pages:
+  parse the section number from the header line
+  and compare to the section number from the directory name
+
+- Does makewhatis(8) detect missing NAME sections, missing names,
+  and missing descriptions in all the file formats?
+

 - 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
 - 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


@@ -191,6 +192,10 @@ None known.
 - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
   First impression is not that bad.
 
 - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
   First impression is not that bad.
 

+- look at pages generated by pandoc; see
+  https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
+  porting planned by kili@  Thu, 19 Jun 2014 19:46:28 +0200
+

 - check compatibility with Plan9:
   http://swtch.com/usr/local/plan9/tmac/tmac.an
   http://swtch.com/plan9port/man/man7/man.html
 - check compatibility with Plan9:
   http://swtch.com/usr/local/plan9/tmac/tmac.an
   http://swtch.com/plan9port/man/man7/man.html


@@ -203,11 +208,6 @@ None known.
 - a column list with blank `Ta' cells triggers a spurrious
   start-with-whitespace printing of a newline
 
 - 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)
-  reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
-

 - In .Bl -column,
   .It Em Authentication<tab>Key Length
   ought to render "Key Length" with emphasis, too,
 - In .Bl -column,
   .It Em Authentication<tab>Key Length
   ought to render "Key Length" with emphasis, too,


@@ -239,6 +239,14 @@ None known.
   reveals lots of bugs both in groff and mandoc...
   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
 
   reveals lots of bugs both in groff and mandoc...
   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
 

+--- PDF issues ---------------------------------------------------------
+
+- PDF output doesn't use a monospaced font for .Bd -literal
+  Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
+  Search the text "Routing tables".
+  Also check what PostScript mode does when fixing this.
+  reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
+

 ************************************************************************
 * formatting issues: gratuitous differences
 ************************************************************************
 ************************************************************************
 * formatting issues: gratuitous differences
 ************************************************************************


@@ -291,13 +299,6 @@ None known.
   That is, when it is alone on a line between two .Pp,
   we want three blank lines, not two as in mandoc.
 
   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
-  reported again by Nicolas Joly via wiz@  Sun, 18 Sep 2011 18:24:40 +0200
-  Also, we don't want to break the line within the argument of:
-  .Fa "chtype tl"
-

 - 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
 - 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


@@ -310,6 +311,17 @@ None known.
     operate in batch mode
   in dig(1).
 
     operate in batch mode
   in dig(1).
 

+************************************************************************
+* warning issues
+************************************************************************
+
+- check that MANDOCERR_BADTAB is thrown in the right cases,
+  i.e. when finding a literal tab character in fill mode,
+  and possibly change the wording of the warning message
+  to refer to fill mode, not literal mode
+  See the mail from Werner LEMBERG on the groff list,
+  Fri, 14 Feb 2014 18:54:42 +0100 (CET)
+

 ************************************************************************
 * performance issues
 ************************************************************************
 ************************************************************************
 * performance issues
 ************************************************************************


@@ -340,3 +352,9 @@ Several areas can be cleaned up to make mandoc even faster.  These are
   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
   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

+
+- Consider creating some views that will make the database more
+  readable from the sqlite3 shell.  Consider using them to
+  abstract from the database structure, too.
+  suggested by espie@  Sat, 19 Apr 2014 14:52:57 +0200
+