************************************************************************
* Official mandoc TODO.
-* $Id: TODO,v 1.213 2015/08/29 15:10:28 schwarze Exp $
+* $Id: TODO,v 1.231 2017/02/05 20:22:04 schwarze Exp $
************************************************************************
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.
-************************************************************************
-* crashes
-************************************************************************
-
-- 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.
- loc ** exist * algo * size ** imp **
-
************************************************************************
* missing features
************************************************************************
uqs@ Thu, 2 Jun 2011 11:33:35 +0200
loc * exist ** algo *** size * imp **
---- missing man features -----------------------------------------------
-
-- -T[x]html doesn't stipulate non-collapsing spaces in literal mode
-
--- missing tbl features -----------------------------------------------
- horizontal lines in the layout still consume data cells
synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400
loc ** exist ** algo ** size ** imp ***
+- break long text into lines inside cells
+ net/lftp(1) from jirib via bentley@ Sep 13, 2016
+
+- layout l1 for a column of max text width 3 reduces the following
+ inter-column spacing for groff, but not for mandoc
+ net/lftp(1) from jirib via bentley@ Sep 13, 2016
+
- the "w" layout option is ignored
synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400
loc * exist * algo * size * imp **
they use some unsupported tbl(7) features.
loc * exist ** algo ** size ** imp ***
+- look what Joerg Schilling manual pages use
+ Thu, 19 Mar 2015 18:31:48 +0100
+
- use Unicode U+2500 to U+256C for table borders
in tbl(7) -Tutf-8 output
suggested by bentley@ Tue, 14 Oct 2014 04:10:55 -0600
even for apropos title line output; req by bapt@
loc * exist * algo * size * imp ***
-- makewhatis(8) for preformatted pages:
- parse the section number from the header line
- and compare to the section number from the directory name
- loc * exist * algo * size * imp **
-
-- Does makewhatis(8) detect missing NAME sections, missing names,
- and missing descriptions in all the file formats?
- loc * exist * algo * size * imp ***
-
- 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
- look at AT&T DWB http://www2.research.att.com/sw/download
Carsten Kunze <carsten dot kunze at arcor dot de> has patches
Mon, 4 Aug 2014 17:01:28 +0200
+ ported version: https://github.com/n-t-roff/DWB3.3
+ Carsten Kunze Wed, 22 Apr 2015 11:21:43 +0200
- 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
https://github.com/schmonz/ikiwiki/compare/mandoc
Amitai Schlair Mon, 19 May 2014 14:05:53 -0400
+- check features of the Slackware man.conf(5) format
+ Carsten Kunze Wed, 11 Mar 2015 17:57:24 +0100
+
************************************************************************
* formatting issues: ugly output
************************************************************************
and triggers a line break; found in audio/normalize-mp3(1)
loc ** exist * algo ** size * imp **
+- rendering of double quotes in -Tascii is ugly in both groff and mandoc
+ to improve, both would have to be changed
+ Carsten Kunze Fri, 12 Dec 2014 14:27:56 +0100
+
- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
reveals lots of bugs both in groff and mandoc...
reported by bentley@ Wed, 22 May 2013 23:49:30 -0600
---- PDF issues ---------------------------------------------------------
+--- PostScript and PDF issues ------------------------------------------
- PDF output doesn't use a monospaced font for .Bd -literal
Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
instructions from juanfra@ Wed, 11 Jun 2014 02:21:01 +0200
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 **
--- HTML issues --------------------------------------------------------
-- <dl><dt><dd> formatting is ugly
- hints are easy to find on the web, e.g.
- http://stackoverflow.com/questions/1713048/
- see also matthew@ Fri, 18 Jul 2014 19:25:12 -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
+ reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
+ loc ** exist ** algo ** size * imp *
- jsg on icb, Nov 3, 2014:
try to guess Xr in man(7) for hyperlinking
+ and render them with <a class="Xr" href=...>
+ https://github.com/Debian/debiman/issues/15
+ loc * exist * algo ** size ** imp **
- The tables used to render the three-part page headers actually force
the width of the <body> to the max-width given for <html>.
http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
loc * exist * algo ** size * imp ***
-- consider whether <var> can be used for Ar Dv Er Ev Fa Va.
- from bentley@ Wed, 13 Aug 2014 09:17:55 -0600
-
- 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
Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100
loc * exist ** algo ** size * imp **
+- .Lk formatting for long links with line breaks
+ Franco Fichtner 8 Oct 2013 00:33:42 +0200
+
- In .Bl -enum -width 0n, groff continues one the same line after
the number, mandoc breaks the line.
mail to kristaps@ Mon, 20 Jul 2009 02:21:39 +0200
in dig(1).
loc ** exist ** algo ** size * imp **
-************************************************************************
-* portability
-************************************************************************
-
-- word boundaries in regular expressions for whatis(1)
- set up config tests to use [[:<:]], \<, or nothing
- Svyatoslav Mishyn Wed, 17 Dec 2014 11:07:10 +0200
- reminded by Peter Bray Fri, 03 Apr 2015 23:02:16 +1100
- loc * exist * algo * size * imp *
-
-- systems having UTF-8 but not en_US.UTF-8
- call locale(1) from ./configure, select a UTF-8-locale,
- and use that for test-wchar.c and term_ascii.c
- to Markus Waldeck Sat, 18 Jul 2015 01:55:37 +0200
- loc * exist * algo * size * imp *
-
************************************************************************
* warning issues
************************************************************************
-- Report errors in -O suboption parsing.
- loc * exist * algo * size * imp **
+- provide a way in mandoc(1) to warn about broken .Xr links;
+ probably cannot be on by default in -Tlint because it needs
+ to access the manpath and mandoc.db(3) after parsing.
+ asked for by jmc@ Fri, 4 Dec 2015 22:39:40 +0000
- warn when .Sh or .Ss contain other macros
Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034
loc * exist * algo * size * imp **
-- 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)
- loc * exist ** algo ** size * imp **
-
- warn about attempts to call non-callable macros
Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100
Note that formatting is inconsistent in groff.
to tech@mdocml, naddy@ Wed, 28 Sep 2011 11:21:46 +0200
wait! kristaps@ Sun, 02 Oct 2011 17:12:52 +0200
-- for system errors, use errno/strerror/warn/err
-
************************************************************************
* documentation issues
************************************************************************
************************************************************************
- Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?
- How does SQLITE_CONFIG_PAGECACHE actually work? Document it!
from kristaps@ Sat, 09 Aug 2014 13:51:36 +0200
Several areas can be cleaned up to make mandoc even faster. These are
* structural issues
************************************************************************
-- Use libz directly instead of forking gunzip(1).
- Suggested by bapt at FreeBSD among others.
+- POSIX says in the documentation of sysconf(3) that PATH_MAX
+ is allowed to be so large that it is a bad idea to use it
+ for sizing static buffers. So use dynamic buffers throughout.
+ See the file test-PATH_MAX.c for details.
+ Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,
+ https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624
- We use the input line number at several places to distinguish
same-line from different-line input. That plainly doesn't work
- struct mparse refactoring
Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200
-- 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
-
************************************************************************
* CGI issues
************************************************************************
git.ckatri.com / mandoc.git / blobdiff