Annotation of mandoc/TODO, Revision 1.168
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.168 ! schwarze 3: * $Id: TODO,v 1.167 2014/03/08 21:54:39 schwarze Exp $
1.27 kristaps 4: ************************************************************************
1.145 schwarze 5:
6: ************************************************************************
7: * crashes
8: ************************************************************************
9:
1.158 schwarze 10: None known.
1.101 schwarze 11:
1.61 schwarze 12: ************************************************************************
1.1 kristaps 13: * missing features
14: ************************************************************************
1.70 kristaps 15:
1.79 schwarze 16: --- missing roff features ----------------------------------------------
17:
1.82 schwarze 18: - .ad (adjust margins)
19: .ad l -- adjust left margin only (flush left)
20: .ad r -- adjust right margin only (flush right)
21: .ad c -- center text on line
22: .ad b -- adjust both margins (alias: .ad n)
23: .na -- temporarily disable adjustment without changing the mode
24: .ad -- re-enable adjustment without changing the mode
25: Adjustment mode is ignored while in no-fill mode (.nf).
1.150 schwarze 26:
27: - .fc (field control)
28: found by naddy@ in xloadimage(1)
29:
1.160 schwarze 30: - .nr third argument (auto-increment step size, requires \n+)
31: found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
32:
1.80 schwarze 33: - .ns (no-space mode) occurs in xine-config(1)
34: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.61 schwarze 35:
1.81 schwarze 36: - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
37: reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500
1.167 schwarze 38: also Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
1.150 schwarze 39:
40: - .ti (temporary indent)
41: found by naddy@ in xloadimage(1)
42: found by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600
1.154 schwarze 43:
44: - .while and .shift
45: found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200
1.79 schwarze 46:
1.132 schwarze 47: - \c (interrupted text) should prevent the line break
48: even inside .Bd literal; that occurs in chat(8)
1.155 schwarze 49: also found in cclive(1) - DocBook output
50:
51: - \h horizontal move
52: found in cclive(1) DocBook output
53: Anthony J. Bentley on discuss@ Sat, 21 Sep 2013 22:29:34 -0600
1.125 schwarze 54:
1.160 schwarze 55: - \n+ and \n- numerical register increment and decrement
56: found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
57:
1.167 schwarze 58: - \w'' width measurements
59: would not be very useful without an expression parser, see below
60: needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
61:
1.125 schwarze 62: - using undefined strings or macros defines them to be empty
63: wl@ Mon, 14 Nov 2011 14:37:01 +0000
1.167 schwarze 64:
65: - general expression parser, including arithmetics
66: to be used at least for .if/.ie and .nr and maybe at other places
67: could use J.T.Conklin's PD code in bin/expr/expr.c for inspiration
68: needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
1.98 schwarze 69:
1.79 schwarze 70: --- missing mdoc features ----------------------------------------------
71:
1.18 schwarze 72: - fix bad block nesting involving multiple identical explicit blocks
73: see the OpenBSD mdoc_macro.c 1.47 commit message
74:
1.1 kristaps 75: - .Bl -column .Xo support is missing
76: ultimate goal:
77: restore .Xr and .Dv to
78: lib/libc/compat-43/sigvec.3
79: lib/libc/gen/signal.3
80: lib/libc/sys/sigaction.2
81:
1.28 schwarze 82: - edge case: decide how to deal with blk_full bad nesting, e.g.
83: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
84: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
85:
1.74 schwarze 86: - \\ is now implemented correctly
87: * when defining strings and macros using .ds and .de
88: * when parsing roff(7) and man(7) macro arguments
89: It does not yet work in mdoc(7) macro arguments
90: because libmdoc does not yet use mandoc_getarg().
91: Also check what happens in plain text, it must be identical to \e.
1.82 schwarze 92:
93: - .Bd -filled should not be the same as .Bd -ragged, but align both
94: the left and right margin. In groff, it is implemented in terms
95: of .ad b, which we don't have either. Found in cksum(1).
1.22 schwarze 96:
1.10 kristaps 97: - implement blank `Bl -column', such as
98: .Bl -column
99: .It foo Ta bar
100: .El
1.11 kristaps 101:
102: - explicitly disallow nested `Bl -column', which would clobber internal
103: flags defined for struct mdoc_macro
1.102 schwarze 104:
105: - In .Bl -column .It, the end of the line probably has to be regarded
106: as an implicit .Ta, if there could be one, see the following mildly
107: ugly code from login.conf(5):
108: .Bl -column minpasswordlen program xetcxmotd
109: .It path Ta path Ta value of Dv _PATH_DEFPATH
110: .br
111: Default search path.
112: reported by Michal Mazurek <akfaew at jasminek dot net>
113: via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.42 schwarze 114:
115: - inside `.Bl -column' phrases, punctuation is handled like normal
116: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
117:
118: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
119: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
120: but should give "ab ."
1.12 kristaps 121:
122: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 123:
124: - have a blank `It' head for `Bl -tag' not puke
1.20 kristaps 125:
126: - prohibit `Nm' from having non-text HEAD children
127: (e.g., NetBSD mDNSShared/dns-sd.1)
128: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109 schwarze 129:
130: - When there is free text in the SYNOPSIS and that free text contains
131: the .Nm macro, groff somehow understands to treat the .Nm as an in-line
132: macro, while mandoc treats it as a block macro and breaks the line.
133: No idea how the logic for distinguishing in-line and block instances
134: should be, needs investigation.
135: uqs@ Thu, 2 Jun 2011 11:03:51 +0200
136: uqs@ Thu, 2 Jun 2011 11:33:35 +0200
1.57 kristaps 137:
1.79 schwarze 138: --- missing man features -----------------------------------------------
139:
1.119 kristaps 140: - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
1.80 schwarze 141:
1.79 schwarze 142: --- missing tbl features -----------------------------------------------
143:
144: - implement basic non-parametric .de to support e.g. sox(1)
145: reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
146: *** sox(1) still doesn't work, tbl(1) errors need investigation
1.105 kristaps 147:
148: - allow standalone `.' to be interpreted as an end-of-layout
149: delimiter instead of being thrown away as a no-op roff line
150: reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
1.79 schwarze 151:
152: --- missing misc features ----------------------------------------------
1.159 schwarze 153:
154: - italic correction (\/) in PostScript mode
155: Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46
1.153 schwarze 156:
157: - The whatis(1) utility looks for whole words in Nm.
158: If the file name of a page does not agree with the contents of any
159: of its Nm macros (e.g. pool(9)), add the file name as an Nm entry
160: to the mandoc.db as well, such that whatis(1) finds it.
161: If there is a page with a file name that does not appear as a substring
162: neither in Nm nor in Nd, the same fix would allow finding that page
163: with apropos(1) using the file name as a key, as well.
164: Issue reported by tedu@ Fri, 05 Jul 2013 21:15:23 -0400
1.79 schwarze 165:
166: - clean up escape sequence handling, creating three classes:
167: (1) fully implemented, or parsed and ignored without loss of content
168: (2) unimplemented, potentially causing loss of content
169: or serious mangling of formatting (e.g. \n) -> ERROR
170: see textproc/mgdiff(1) for nice examples
171: (3) undefined, just output the character -> perhaps WARNING
1.83 schwarze 172:
1.79 schwarze 173: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
174: These are a weird mixture of man(7) and custom autogenerated low-level
175: roff stuff. Figure out to what extent we can cope.
1.80 schwarze 176: For details, see http://docutils.sourceforge.net/rst.html
1.79 schwarze 177: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
178: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
1.160 schwarze 179:
180: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
181: First impression is not that bad.
1.71 schwarze 182:
183: - check compatibility with Plan9:
184: http://swtch.com/usr/local/plan9/tmac/tmac.an
185: http://swtch.com/plan9port/man/man7/man.html
186: "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63 schwarze 187:
1.1 kristaps 188: ************************************************************************
189: * formatting issues: ugly output
190: ************************************************************************
1.87 kristaps 191:
192: - a column list with blank `Ta' cells triggers a spurrious
193: start-with-whitespace printing of a newline
1.1 kristaps 194:
1.39 schwarze 195: - In .Bl -column,
196: .It Em Authentication<tab>Key Length
197: ought to render "Key Length" with emphasis, too,
198: see OpenBSD iked.conf(5).
1.123 schwarze 199: reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.39 schwarze 200:
1.1 kristaps 201: - empty phrases in .Bl column produce too few blanks
202: try e.g. .Bl -column It Ta Ta
203: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48 schwarze 204:
1.83 schwarze 205: - .%T can have trailing punctuation. Currently, it puts the trailing
206: punctuation into a trailing MDOC_TEXT element inside its own scope.
207: That element should rather be outside its scope, such that the
208: punctuation does not get underlines. This is not trivial to
209: implement because .%T then needs some features of in_line_eoln() -
210: slurp all arguments into one single text element - and one feature
211: of in_line() - put trailing punctuation out of scope.
212: Found in mount_nfs(8) and exports(5), search for "Appendix".
213:
1.147 schwarze 214: - Trailing punctuation after .%T triggers EOS spacing, at least
215: outside .Rs (eek!). Simply setting ARGSFL_DELIM for .%T is not
216: the right solution, it sends mandoc into an endless loop.
217: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
218:
1.48 schwarze 219: - in enclosures, mandoc sometimes fancies a bogus end of sentence
220: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.149 schwarze 221:
222: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
223: reveals lots of bugs both in groff and mandoc...
224: reported by bentley@ Wed, 22 May 2013 23:49:30 -0600
1.35 kristaps 225:
1.1 kristaps 226: ************************************************************************
1.104 kristaps 227: * formatting issues: gratuitous differences
1.1 kristaps 228: ************************************************************************
1.65 kristaps 229:
230: - .Rv (and probably .Ex) print different text if an `Nm' has been named
231: or not (run a manual without `Nm blah' to see this). I'm not sure
232: that this exists in the wild, but it's still an error.
1.38 schwarze 233:
234: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
235: is just "o\bo".
236: see for example OpenBSD ksh(1)
1.103 schwarze 237:
238: - .Pp between two .It in .Bl -column should produce one,
239: not two blank lines, see e.g. login.conf(5).
240: reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059
1.129 schwarze 241: reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.39 schwarze 242:
1.83 schwarze 243: - If the *first* line after .It is .Pp, break the line right after
244: the tag, do not pad with space characters before breaking.
245: See the description of the a, c, and i commands in sed(1).
246:
247: - If the first line after .It is .D1, do not assert a blank line
248: in between, see for example tmux(1).
249: reported by nicm@ 13 Jan 2011 00:18:57 +0000
1.147 schwarze 250:
251: - Trailing punctuation after .It should trigger EOS spacing.
252: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
253: Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.83 schwarze 254:
1.39 schwarze 255: - .Nx 1.0a
256: should be "NetBSD 1.0A", not "NetBSD 1.0a",
257: see OpenBSD ccdconfig(8).
1.83 schwarze 258:
1.39 schwarze 259: - In .Bl -tag, if a tag exceeds the right margin and must be continued
260: on the next line, it must be indented by -width, not width+1;
261: see "rule block|pass" in OpenBSD ifconfig(8).
1.56 schwarze 262:
1.83 schwarze 263: - When the -width string contains macros, the macros must be rendered
264: before measuring the width, for example
265: .Bl -tag -width ".Dv message"
266: in magic(5), located in src/usr.bin/file, is the same
267: as -width 7n, not -width 11n.
1.129 schwarze 268: The same applies to .Bl -column column widths;
269: reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157 schwarze 270: reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
271: An easy partial fix would be to just skip the first word if it starts
272: with a dot, including any following white space, when measuring.
1.83 schwarze 273:
1.56 schwarze 274: - The \& zero-width character counts as output.
275: That is, when it is alone on a line between two .Pp,
276: we want three blank lines, not two as in mandoc.
1.83 schwarze 277:
1.64 schwarze 278: - Header lines of excessive length:
279: Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
280: and document it in mdoc(7) and man(7) COMPATIBILITY
281: found while talking to Chris Bennett
1.83 schwarze 282:
283: - trailing whitespace must be ignored even when followed by a font escape,
284: see for example
285: makes
286: \fBdig \fR
287: operate in batch mode
288: in dig(1).
1.166 schwarze 289:
290: ************************************************************************
291: * warning issues
292: ************************************************************************
293:
294: - check that MANDOCERR_BADTAB is thrown in the right cases,
295: i.e. when finding a literal tab character in fill mode,
296: and possibly change the wording of the warning message
297: to refer to fill mode, not literal mode
298: See the mail from Werner LEMBERG on the groff list,
299: Fri, 14 Feb 2014 18:54:42 +0100 (CET)
1.1 kristaps 300:
1.9 kristaps 301: ************************************************************************
302: * performance issues
303: ************************************************************************
304:
305: Several areas can be cleaned up to make mandoc even faster. These are
306:
307: - improve hashing mechanism for macros (quite important: performance)
308:
309: - improve hashing mechanism for characters (not as important)
1.23 kristaps 310:
1.37 kristaps 311: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115 kristaps 312:
313: - instead of re-initialising the roff predefined-strings set before each
314: parse, create a read-only version the first time and copy it
1.37 kristaps 315:
1.23 kristaps 316: ************************************************************************
317: * structural issues
318: ************************************************************************
1.122 schwarze 319:
320: - We use the input line number at several places to distinguish
321: same-line from different-line input. That plainly doesn't work
322: with user-defined macros, leading to random breakage.
1.67 schwarze 323:
324: - Find better ways to prevent endless loops
325: in roff(7) macro and string expansion.
1.91 schwarze 326:
1.96 schwarze 327: - Finish cleanup of date handling.
1.91 schwarze 328: Decide which formats should be recognized where.
329: Update both mdoc(7) and man(7) documentation.
330: Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100
CVSweb