=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.313 retrieving revision 1.329 diff -u -p -r1.313 -r1.329 --- mandoc/TODO 2021/06/02 18:23:34 1.313 +++ mandoc/TODO 2023/10/18 15:41:28 1.329 @@ -1,6 +1,6 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.313 2021/06/02 18:23:34 schwarze Exp $ +* $Id: TODO,v 1.329 2023/10/18 15:41:28 schwarze Exp $ ************************************************************************ Many issues are annotated for difficulty as follows: @@ -47,7 +47,42 @@ are mere guesses, and some may be wrong. 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 *** + +- eqn(7) delimiters cause conditional lines to misbehave + nabijaczleweli 8 Sep 2021 15:24:48 +0200 + loc * exist *** algo *** size * imp * + +- roff.c, roff_expand() should not remove blanks before comments + to Oliver Corff, Sep 7, 2021 + loc * exist * algo * size * imp * + but watch out for regressions in the high-level parsers + maybe it should not even remove comments? - consider T{\" + +- In the body of conditional requests, escape sequence expansion + must not be performed if the condition is false. This implies + the first part of a request line must be expanded before + request parsing (like it is now), but expansion in the second + part must be delayed. + to Nab 8 Aug 2023 20:05:32 +0200 Subject: if/ie d condition always true + loc ** exist *** algo *** size ** imp * + +- tag.c, tag_put() should not put ASCII_HYPH into the tag file, + which happens when the tag contains "-" on the input side + weerd@ 28 Sep 2021 12:44:07 +0200 + loc * exist * algo * size * imp *** + + +************************************************************************ * missing features ************************************************************************ @@ -127,6 +162,11 @@ are mere guesses, and some may be wrong. --- missing mdoc features ---------------------------------------------- +- support mixed case for section names + also, first section is not "NAME" should not appear more than once per page + Alejandro Colomar 28 Apr 2023 16:57:49 +0200 + loc * exist * algo * size * imp *** + - .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 * @@ -270,8 +310,34 @@ are mere guesses, and some may be wrong. --- missing misc features ---------------------------------------------- +- use the default volume headers for sections with suffixes + certainly affects man(7); possibly mdoc(7)?; and also groff(1) + Alejandro Colomar 21 Aug 2022 + +- conisder whether man(1) fallback code in main.c/fs_*() can find files + like man3c/fopen.3c (illumos, Solaris) and man3p/fopen.3p (POSIX) + discussed with Robert Mustacchi 21 Sep 2021 10:39:40 -0700 + loc * exist * algo ** size * imp ** + +- let makewhatis(8) follow symbolic links to dirs below READ_ALLOWED_PATH + this may be feasible using fts_set(FTS_FOLLOW) + mail to sternenseemann 19 Aug 2021 19:11:50 +0200 + loc * exist ** algo ** size * imp ** + +- tag.c, tag_put() and callers like man_validate.c, check_tag() + should not mistake "\-" as a word-ending escape sequence but + instead translate it to plain "-" in the tag name + weerd@ 28 Sep 2021 12:44:07 +0200 + loc ** exist * algo * size * imp *** + +- handle Unicode letters in tags in both HTML and terminal output + thread "section headers with diacritics" starting with + Mario Blaettermann 24 Mar 2022 18:13:23 +0100 + loc ** exist * algo * size * imp ** + - -T man does not handle eqn(7) and tbl(7) Stephen Gregoratto 16 Feb 2020 01:28:07 +1100 + also https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=901636 loc ** exist ** algo ** size *** imp ** - man -ks 1,8 route; kn@ Jul 13, 2018 orally @@ -348,6 +414,10 @@ are mere guesses, and some may be wrong. - 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 ************************************************************************ @@ -406,6 +476,10 @@ are mere guesses, and some may be wrong. reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 loc * exist ** algo *** size * imp *** +- the man(7) single-font macros (e.g. .B) use .itc, + so ".B foo\c" followed by "bar" prints "bar" in bold + gbranden@ Sun, 5 Jun 2022 18:08:46 -0500 + - a line starting with "\fB something" counts as starting with whitespace and triggers a line break; found in audio/normalize-mp3(1) This will become easier once escape sequences are represented @@ -431,10 +505,42 @@ are mere guesses, and some may be wrong. --- HTML issues -------------------------------------------------------- +- .Nm without an argument and .Bx cause premature + Nab Sun, 5 Jun 2022 18:30:09 +0200 + +- .Aq Mt could set and reset "white-space: nowrap"; + Check whether other enclosure macros could profit from similar handling, + or whether that is covered by Unicode line-breaking classes WJ, ZW, GL, ZWJ. + John Gardner 25 Mar 2022 04:44:27 +1100 + +- make the HTML scaffolding customizable with -O skip=... + mail to Oliver Corff 3 Jun 2021 17:28:02 +0200 + more feedback from Oliver 3 Jun 2021 18:27:56 +0200 + more feedback from Oliver 3 Jun 2021 23:37:18 +0200 + would also be useful for + https://github.com/gbdev/rgbds-www/blob/master/ + maintainer/support/man_postproc.awk + - .Bd -unfilled should not use monospaced font anton@ 4 Mar 2021 08:19:35 +0100 loc ** exist * algo * size * imp ** +- HTML formatting of .nf should avoid
, + even when input lines start with whitespace, + and not close and re-open 
 on .P
+  my mail to ports@ 27 Jun 2021 16:09:20 +0200
+  reported again by Mohamed Akram 25 Jun 2022 16:28:18 +0000
+  loc **  exist **  algo *  size *  imp **
+
+- tbl(7) HTML output does not implement column width specifications
+  reported by Ted Bullock 11 Jan 2022 16:00:44 -0700
+  loc *  exist *  algo ?  size ?  imp *
+
+- link from flags in the SYNOPSIS to their descriptions
+  https://github.com/gbdev/rgbds-www/blob/master/
+  maintainer/support/man_postproc.awk
+  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
@@ -457,25 +563,18 @@ are mere guesses, and some may be wrong.
   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  to the max-width given for .
-  Not yet sure how to fix that...
-  Observed by an Anonymous Coward on undeadly.org:
-  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  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
 
 - check https://github.com/trentm/mdocml
 
+--- CSS issues ---------------------------------------------------------
+
+- use flexbox for .Bl-tag instead of the fragile float/clear mechanism
+  John Gardner 25 Mar 2022 04:44:27 +1100
+
+
 ************************************************************************
 * formatting issues: gratuitous differences
 ************************************************************************
@@ -521,6 +620,10 @@ are mere guesses, and some may be wrong.
   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
   reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
   reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@
+  https://reviews.freebsd.org/D35245
+  even groff_mdoc(7) uses this: Nab Sun, 5 Jun 2022 22:16:37 +0200
+  When implementing this, try to avoid breaking existing manuals,
+  or at least fix them: Jan Stary Sun, 5 Jun 2022 22:48:05 +0200
   loc ***  exist ***  algo ***  size **  imp ***
   An easy partial fix would be to just skip the first word if it starts
   with a dot, including any following white space, when measuring.
@@ -535,6 +638,10 @@ are mere guesses, and some may be wrong.
   with .ps and .nf/.fi produce execessive blank lines, see libJudy
   and graphics/dcmtk.  The parser reorg may help with this.
 
+- The man(7) .UR macro produces UTF-8 angle brackets in -Tutf8 output mode
+  with groff, but ASCII <> with mandoc
+  Alejandro Colomar Mon, 7 Aug 2023 17:13:29 +0200 Subject: hostname
+
 - trailing whitespace must be ignored even when followed by a font escape,
   see for example
     makes
@@ -550,6 +657,11 @@ are mere guesses, and some may be wrong.
 - shorten/simplify error messages for usage errors
   To: deraadt@ 25 Oct 2020 23:37:01 +0100
   loc **  exist *  algo *  size **  imp ***
+
+- warn about output lines exceeding 80 characters
+  Alejandro Colomar Aug 22, 2022
+  not trivial because -T lint does not call any formatter
+  loc ***  exist *  algo **  size **  imp **
 
 - warn about duplicate .Sh/.Ss heads
   gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200