************************************************************************
* Official mandoc TODO.
-* $Id: TODO,v 1.245 2017/07/22 20:43:40 schwarze Exp $
+* $Id: TODO,v 1.253 2018/05/08 21:42:34 schwarze Exp $
************************************************************************
Many issues are annotated for difficulty as follows:
found by naddy@ in xloadimage(1)
loc ** exist *** algo * size * imp *
-- .nr third argument (auto-increment step size, requires \n+)
- found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
- loc * exist * algo * size * imp **
-
- .ns (no-space mode) occurs in xine-config(1)
when implementing this, also let .TH set it
reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200
loc * exist ** algo ** size ** imp **
-- \n+ and \n- numerical register increment and decrement
- found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
- loc * exist * algo * size * imp **
-
- \w'' improve 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
Found by naddy@ in devel/cutils cobfusc(1) Mon, 16 Feb 2015 19:10:52 +0100
loc *** exist *** algo *** size ** imp *
-- using undefined strings or macros defines them to be empty
- wl@ Mon, 14 Nov 2011 14:37:01 +0000
- loc * exist * algo * size * imp *
+- check for missing roff escape sequences, implement those that are
+ trivial even if not usually appearing in manual pages, gracefully
+ ignore the non-trivial ones, document what they are supposed to do
+ and what mandoc does instead
+ loc * exist ** algo * size * imp *
--- missing mdoc features ----------------------------------------------
uqs@ Thu, 2 Jun 2011 11:33:35 +0200
loc * exist ** algo *** size * imp **
+--- missing man features -----------------------------------------------
+
+- groff_www(7) .MTO and .URL
+ These macros were used by the GNU grep(1) man page.
+ We should probably *not* add them to mandoc.
+ Just mentioning this here to keep track of the abuse.
+ Laura Morales <lauretas at mail dot com> 20 Apr 2018 07:33:02 +0200
+ loc ** exist * algo * size ** imp *
+
--- missing tbl features -----------------------------------------------
- the "s" layout column specifier is used for placement of data
surrounded by blanks, not when it is part of an unquoted word.
Also, check whether there are more such cases (e.g., +?).
reported by bentley@ 20 Jun 2017 02:04:29 -0600
+ loc * exist ** algo ** size * imp *
- Primes, opprime, and '
bentley@ Thu, 13 Jul 2017 23:14:20 -0600
--- HTML issues --------------------------------------------------------
+- duplicate names generate duplicate href="#..." anchor attributes
+ possibly use "#..._<N>" suffixes?
+ Jakub Klinkovsky <j dot l dot k at gmx dot com> 3 Oct 2017 21:23:36 +0200
+ see also the thread: gre(4): Rename duplicate sections
+ up to 20 Apr 2018 15:27:33 +0200
+ loc * exist * algo * size * imp ***
+
+- wrap Sh and Ss content into <div>
+ Laura Morales <lauretas at mail dot com> 21 Apr 2018 18:10:48 +0200
+ (Evaluate whether this is really useful and has no adverse
+ side effects before implementing; if it is possible,
+ it does seem cleaner.)
+ loc ** exist ** algo * size * imp ***
+
+- format ".IP *" etc. as <ul> rather than <dl>
+ https://github.com/Debian/debiman/issues/67
+ 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
* warning issues
************************************************************************
+- warn about duplicate .Sh/.Ss heads
+ gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200
+ loc * exist * algo * size * imp **
+
- style message about macros inside .Bd -literal and .Dl, in particular
font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO)
+- style message about mismatches between the section number in the
+ file name (if it is known) and the section number in .Dt
+ (from the mdoclint TODO)
+
- style message about NULL without .Dv (from the mdoclint TODO)
- style message about error constants without .Er (from the mdoclint TODO)
loc * exist * algo * size * imp **
- style message about violations of the convention
- .An name Aq Mt localpart@domain in AUTHORS
+ .An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO)
- warn about attempts to call non-callable macros
Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100
- style message about suspicious uses of - vs. \- vs. \(mi
e.g. -1 is likely wrong (from the mdoclint TODO)
+- warn about punctuation - e.g. ',' and ';' - at the beginning
+ of a text line, if it is likely intended to follow the preceding
+ output without intervening whitespace, in particular after a
+ macro line (from the mdoclint TODO)
+
- mandoc_special does not really check the escape sequence,
but just the overall format
loc ** exist ** algo *** size ** imp **
* to improve in the groff_mdoc(7) macros
************************************************************************
+- .Cd # arch1, arch2 in section 4 pages:
+ find better way to indicate multiple architectures, maybe:
+ allow .Dt vgafb 4 "macppc sparc64"
+ already shown as "Device Drivers Manual (macppc sparc64)"
+ for apropos, make that "vgafb(4) - macppc # sparc64" instead of "- all"
+ groff can be made to show multiple arches, too, but it is
+ tedious to do the string parsing in roff code...
+ jmc@ 23 Apr 2018 07:24:52 +0100 [man for vgafb(4)...]
+ loc ** exist ** algo * size * imp ***
+
- use uname(1) to set doc-default-operating-system at install time
tobimensch Mon, 1 Dec 2014 00:25:07 +0100
git.ckatri.com / mandoc.git / blobdiff