three new TODO items

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index dd97163c857013978fb12fb6ccb5de963d0e1f62..e80c9e41b6db8fc1ebc82b4cfbf09006a6b71605 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,6 @@
 ************************************************************************
 * Official mandoc TODO.
 ************************************************************************
 * Official mandoc TODO.

-* $Id: TODO,v 1.294 2019/05/03 17:31:15 schwarze Exp $
+* $Id: TODO,v 1.314 2021/06/26 11:09:06 schwarze Exp $

 ************************************************************************
 
 Many issues are annotated for difficulty as follows:
 ************************************************************************
 
 Many issues are annotated for difficulty as follows:


@@ -32,6 +32,33 @@ Many issues are annotated for difficulty as follows:
 Obviously, as the issues have not been solved yet, these annotations
 are mere guesses, and some may be wrong.
 
 Obviously, as the issues have not been solved yet, these annotations
 are mere guesses, and some may be wrong.
 

+************************************************************************
+* assertion failures
+************************************************************************
+
+- .if n .ce in the middle of .TS data
+  afl case f1/id:000103,sig:06,src:009024+009105,op:splice,rep:2 (jes@)
+  While roff_parseln() prevents .ce and similar requests in the middle
+  of a tbl, the guard is no longer effective when the .ce is wrapped
+  in a roff block, for example a conditional.  The resulting assertion
+  has never been seen in any real-world manual page.
+  This is too dangerous to fix before release because it requires
+  reorganizing the very delicate internals of roff_parseln(),
+  which risks causing more severe bugs.
+  loc * exist *** algo *** size * imp *
+
+
+************************************************************************
+* bugs: invalid output
+************************************************************************
+
+- wrong number of layout columns in tbl(7) code generated by -T man
+  https://savannah.gnu.org/bugs/?57720
+  The reason likely is that tbl(7) does not support the -Bl -column
+  feature of not explicitly specifying the last table column.
+  loc **  exist *  algo **  size *  imp ***
+
+

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


@@ -83,8 +110,39 @@ are mere guesses, and some may be wrong.
   Jan Stary 20 Apr 2019 20:16:54 +0200
   loc *  exist ***  algo ***  size **  imp *
 
   Jan Stary 20 Apr 2019 20:16:54 +0200
   loc *  exist ***  algo ***  size **  imp *
 

+- mandoc replaces all ASCII control characters except tab and line feed
+  with '?' during input.  It would be better to replace them with
+  Unicode escapes in preconv_encode() or somewhere in the vicinity,
+  such that the already existing better replacement strings show
+  up in the output.  Emulating groff is not desirable: groff replaces
+  0x00, 0x0b, and 0x0d to 0x1f with the empty string (bad because
+  that's easy to overlook for the document author), 0x01 with '.'
+  (very confusing), and passes through 0x02 to 0x08, 0x0c, and 0x7f
+  raw (bad because that is insecure output).  Remember that 0x07 may
+  need special handling because it is sometimes used for certain
+  delimiters, so it may need handling *after* roff.c rather than before.
+  reminded by John Gardner 16 Jun 2020 14:26:28 +1000
+  Actually, more ASCII control characters than just 0x07 may need
+  later handling because they can for example be used in macro names.
+  So they may need handling after roff(7) processing.
+  pointed out by John Gardner 23 Jun 2020 18:28:08 +1000
+  more info from John Gardner 29 Jun 2020 19:54:04 +1000
+  loc **  exist **  algo **  size **  imp *
+
+- many missing features used in old groff_char(7),
+  some can possibly be supported
+  kamil at netbsd 12 Nov 2020 17:27:09 +0100 + reply
+
+- \s with arbitrary arg delimiters as already supported for other escapes
+  found following jmc@'s mail 28 Apr 2021 18:31:41 +0100
+  loc *  exist *  algo *  size *  imp *
+

 --- missing mdoc features ----------------------------------------------
 
 --- missing mdoc features ----------------------------------------------
 

+- .Sh and .Ss should be parsed and partially callable, see groff_mdoc(7)
+  reed at reedmedia dot net Sat, 21 Dec 2019 17:13:07 -0600
+  loc **  exist **  algo **  size **  imp *
+

 - .Bl -column .Xo support is missing
   ultimate goal:
   restore .Xr and .Dv to
 - .Bl -column .Xo support is missing
   ultimate goal:
   restore .Xr and .Dv to


@@ -153,6 +211,13 @@ are mere guesses, and some may be wrong.
 
 --- missing man features -----------------------------------------------
 
 
 --- missing man features -----------------------------------------------
 

+- MANWIDTH
+  Markus Waldeck <waldeck at gmx dot de> 9 Jun 2015 05:49:56 +0200
+  Laura Morales <lauretas at mail dot com> 26 Apr 2018 08:15:55 +0200
+  Kamil Rytarowski <kamil at netbsd> 13 Nov 2020 00:19:36 +0100
+  patch from Kamil 13 Nov 2020 22:37:07 +0100
+  loc *  exist *  algo *  size *  imp *
+

 - groff_www(7) .MTO and .URL
   These macros were used by the GNU grep(1) man page.
   The groff_www(7) manual page itself uses them, too.
 - groff_www(7) .MTO and .URL
   These macros were used by the GNU grep(1) man page.
   The groff_www(7) manual page itself uses them, too.


@@ -217,6 +282,10 @@ are mere guesses, and some may be wrong.
 
 --- missing misc features ----------------------------------------------
 
 
 --- missing misc features ----------------------------------------------
 

+- -T man does not handle eqn(7) and tbl(7)
+  Stephen Gregoratto 16 Feb 2020 01:28:07 +1100
+  loc **  exist **  algo **  size ***  imp **
+

 - man -ks 1,8 route; kn@ Jul 13, 2018 orally
 
 - italic correction (\/) in PostScript mode
 - man -ks 1,8 route; kn@ Jul 13, 2018 orally
 
 - italic correction (\/) in PostScript mode


@@ -285,9 +354,16 @@ are mere guesses, and some may be wrong.
   https://github.com/schmonz/ikiwiki/compare/mandoc
   Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
 
   https://github.com/schmonz/ikiwiki/compare/mandoc
   Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
 

+- check compatibility with
+  https://git.sr.ht/~sircmpwn/scdoc
+

 - check features of the Slackware man.conf(5) format
   Carsten Kunze  Wed, 11 Mar 2015 17:57:24 +0100
 
 - check features of the Slackware man.conf(5) format
   Carsten Kunze  Wed, 11 Mar 2015 17:57:24 +0100
 

+- look at http://www.snake.net/software/troffcvt/  (troff to HTML)
+  mentioned by Oliver Corff  22 Jan 2021 01:36:49 +0100
+
+

 ************************************************************************
 * formatting issues: ugly output
 ************************************************************************
 ************************************************************************
 * formatting issues: ugly output
 ************************************************************************


@@ -367,10 +443,22 @@ are mere guesses, and some may be wrong.
     add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
     and change the /Name from /F0 to the new font (/F5 (?)).
   re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100
     add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
     and change the /Name from /F0 to the new font (/F5 (?)).
   re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100

-  loc *  exist **  algo **  size *  imp **
+  loc **  exist **  algo **  size *  imp **

 
 --- HTML issues --------------------------------------------------------
 
 
 --- HTML issues --------------------------------------------------------
 

+- make the HTML scaffolding customozable with -O skip=...
+  mail to Oliver Corff  3 Jun 2021 17:28:02 +0200
+
+- .Bd -unfilled should not use monospaced font
+  anton@  4 Mar 2021 08:19:35 +0100
+  loc **  exist *  algo *  size *  imp **
+
+- get rid of the last handful of style= attributes such that
+  Content-Security-Policy: can be enabled without unsafe-inline
+  suggested by bentley@  Nov 10, 2019 at 06:02:49AM -0700
+  loc *  exist *  algo *  size *  imp **
+

 - .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
   space, see for example random(3).  Introduced in
   http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92
 - .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
   space, see for example random(3).  Introduced in
   http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92


@@ -383,6 +471,11 @@ are mere guesses, and some may be wrong.
   https://github.com/Debian/debiman/issues/15
   loc *  exist *  algo **  size **  imp **
 
   https://github.com/Debian/debiman/issues/15
   loc *  exist *  algo **  size **  imp **
 

+- space characters can end up in href= attributes, for example coming
+  from the first .Xr argument (where they make no sense, but still);
+  does this affect other characters, other source macros...?
+  Jackson Pauls  29 Aug 2017 16:56:27 +0100
+

 - The tables used to render the three-part page headers actually force
   the width of the <body> to the max-width given for <html>.
   Not yet sure how to fix that...
 - The tables used to render the three-part page headers actually force
   the width of the <body> to the max-width given for <html>.
   Not yet sure how to fix that...


@@ -390,6 +483,12 @@ are mere guesses, and some may be wrong.
   http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
   loc *  exist *  algo **  size *  imp ***
 
   http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
   loc *  exist *  algo **  size *  imp ***
 

+- implement the tbl(7) layout "n" specifier for HTML output,
+  probably by manual alignment, inserting adequate numbers of
+  digit-width spaces, similar to tbl_term.c, tbl_number()
+  Oliver Corff 16 May 2021 20:29:00 +0200
+  loc **  exist **  algo **  size *  imp **
+

 - generate <img> tags in HTML
   idea from florian@  Tue, 7 Apr 2015 00:26:28 +0000
   may be possible to implement with .Lk img://something.png alt_text
 - generate <img> tags in HTML
   idea from florian@  Tue, 7 Apr 2015 00:26:28 +0000
   may be possible to implement with .Lk img://something.png alt_text


@@ -467,6 +566,10 @@ are mere guesses, and some may be wrong.
 * warning issues
 ************************************************************************
 
 * warning issues
 ************************************************************************
 

+- shorten/simplify error messages for usage errors
+  To: deraadt@ 25 Oct 2020 23:37:01 +0100
+  loc **  exist *  algo *  size **  imp ***
+

 - warn about duplicate .Sh/.Ss heads
   gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200
   loc *  exist *  algo *  size *  imp **
 - warn about duplicate .Sh/.Ss heads
   gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200
   loc *  exist *  algo *  size *  imp **


@@ -502,6 +605,10 @@ are mere guesses, and some may be wrong.
   output without intervening whitespace, in particular after a
   macro line (from the mdoclint TODO)
 
   output without intervening whitespace, in particular after a
   macro line (from the mdoclint TODO)
 

+- report double .TH in man(7) as an ERROR and let the first win
+  kristaps@  28 Mar 2021 13:30:41 +0200
+  loc *  exist *  algo *  size *  imp *
+

 - makewhatis -p complains about language subdirectories:
   /usr/local/man//ru: Unknown directory part
 
 - makewhatis -p complains about language subdirectories:
   /usr/local/man//ru: Unknown directory part
 


@@ -550,6 +657,9 @@ are mere guesses, and some may be wrong.
 * CGI issues
 ************************************************************************
 
 * CGI issues
 ************************************************************************
 

+ - Inspect httpd(8) logs on man.openbsd.org and consider
+   whether logging can be improved, where bad syntax comes from,
+   and what needs to be done to get rid of COMPAT_OLDURI.

  - Enable HTTP compression by detecting gzip encoding and filtering
    output through libz.
  - Privilege separation (see OpenSSH).
  - Enable HTTP compression by detecting gzip encoding and filtering
    output through libz.
  - Privilege separation (see OpenSSH).


@@ -559,6 +669,15 @@ are mere guesses, and some may be wrong.
 * to improve in the groff_mdoc(7) macros
 ************************************************************************
 
 * to improve in the groff_mdoc(7) macros
 ************************************************************************
 

+- delete OS release verification from .Dx, .Fx, .Nx, .Ox etc.
+  https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=629161
+  also Branden Robinson 18 Dec 2019 00:59:52 +1100
+
+- Can the distinction between .Vt and .Va be made stricter,
+  recommending .Vt extern char * Ns Va optarg ; ?
+  What about the block macro properties of .Vt in the SYNOPSIS?
+  zeurkous 25 Dec 2019 08:48:36 +0100
+

 - .Cd # arch1, arch2 in section 4 pages:
   find better way to indicate multiple architectures, maybe:
   allow .Dt vgafb 4 "macppc sparc64"
 - .Cd # arch1, arch2 in section 4 pages:
   find better way to indicate multiple architectures, maybe:
   allow .Dt vgafb 4 "macppc sparc64"