Annotation of mandoc/TODO, Revision 1.123
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.123 ! schwarze 3: * $Id: TODO,v 1.122 2011/09/20 14:20:48 schwarze Exp $
1.27 kristaps 4: ************************************************************************
5:
6: ************************************************************************
1.61 schwarze 7: * parser bugs
8: ************************************************************************
9:
1.116 schwarze 10: - ".\}" on its own line gets translated to bare ".\&"
11: which forces pset() into man(7)
12: and then triggers an unknown macro error
13: reported by naddy@ Sun, 3 Jul 2011 21:52:24 +0200
14:
1.74 schwarze 15: ************************************************************************
16: * formatter bugs
17: ************************************************************************
1.63 schwarze 18:
1.101 schwarze 19: - tbl(7): Horizontal and vertical lines are formatted badly:
20: With the box option, there is too much white space at the end of cells.
21: Horizontal lines from "=" lines are a bit too long.
22: yuri dot pankov at gmail dot com Thu, 14 Apr 2011 05:45:26 +0400
23:
1.61 schwarze 24: ************************************************************************
1.1 kristaps 25: * missing features
26: ************************************************************************
1.70 kristaps 27:
1.79 schwarze 28: --- missing roff features ----------------------------------------------
1.118 kristaps 29:
30: - .if n \{
31: .br\}
32: should cause an extra space to be raised.
1.79 schwarze 33:
1.82 schwarze 34: - .ad (adjust margins)
35: .ad l -- adjust left margin only (flush left)
36: .ad r -- adjust right margin only (flush right)
37: .ad c -- center text on line
38: .ad b -- adjust both margins (alias: .ad n)
39: .na -- temporarily disable adjustment without changing the mode
40: .ad -- re-enable adjustment without changing the mode
41: Adjustment mode is ignored while in no-fill mode (.nf).
42:
1.81 schwarze 43: - .it (line traps) occur in mysql(1), yasm_arch(7)
44: generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
45: reported by brad@ Sat, 15 Jan 2011 15:48:18 -0500
46:
1.80 schwarze 47: - .ns (no-space mode) occurs in xine-config(1)
48: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.61 schwarze 49:
1.80 schwarze 50: - xloadimage(1) wants .ti (temporary indent), rep by naddy@
1.81 schwarze 51:
52: - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
53: reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500
1.79 schwarze 54:
1.83 schwarze 55: - \c (interrupted text) occurs in chat(8)
1.98 schwarze 56:
1.79 schwarze 57: --- missing mdoc features ----------------------------------------------
58:
1.18 schwarze 59: - fix bad block nesting involving multiple identical explicit blocks
60: see the OpenBSD mdoc_macro.c 1.47 commit message
61:
1.1 kristaps 62: - .Bl -column .Xo support is missing
63: ultimate goal:
64: restore .Xr and .Dv to
65: lib/libc/compat-43/sigvec.3
66: lib/libc/gen/signal.3
67: lib/libc/sys/sigaction.2
68:
1.28 schwarze 69: - edge case: decide how to deal with blk_full bad nesting, e.g.
70: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
71: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
72:
1.74 schwarze 73: - \\ is now implemented correctly
74: * when defining strings and macros using .ds and .de
75: * when parsing roff(7) and man(7) macro arguments
76: It does not yet work in mdoc(7) macro arguments
77: because libmdoc does not yet use mandoc_getarg().
78: Also check what happens in plain text, it must be identical to \e.
1.82 schwarze 79:
80: - .Bd -filled should not be the same as .Bd -ragged, but align both
81: the left and right margin. In groff, it is implemented in terms
82: of .ad b, which we don't have either. Found in cksum(1).
1.22 schwarze 83:
1.10 kristaps 84: - implement blank `Bl -column', such as
85: .Bl -column
86: .It foo Ta bar
87: .El
1.11 kristaps 88:
89: - explicitly disallow nested `Bl -column', which would clobber internal
90: flags defined for struct mdoc_macro
1.102 schwarze 91:
92: - In .Bl -column .It, the end of the line probably has to be regarded
93: as an implicit .Ta, if there could be one, see the following mildly
94: ugly code from login.conf(5):
95: .Bl -column minpasswordlen program xetcxmotd
96: .It path Ta path Ta value of Dv _PATH_DEFPATH
97: .br
98: Default search path.
99: reported by Michal Mazurek <akfaew at jasminek dot net>
100: via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.42 schwarze 101:
102: - inside `.Bl -column' phrases, punctuation is handled like normal
103: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
104:
105: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
106: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
107: but should give "ab ."
1.12 kristaps 108:
109: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 110:
111: - have a blank `It' head for `Bl -tag' not puke
1.20 kristaps 112:
113: - prohibit `Nm' from having non-text HEAD children
114: (e.g., NetBSD mDNSShared/dns-sd.1)
115: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109 schwarze 116:
117: - When there is free text in the SYNOPSIS and that free text contains
118: the .Nm macro, groff somehow understands to treat the .Nm as an in-line
119: macro, while mandoc treats it as a block macro and breaks the line.
120: No idea how the logic for distinguishing in-line and block instances
121: should be, needs investigation.
122: uqs@ Thu, 2 Jun 2011 11:03:51 +0200
123: uqs@ Thu, 2 Jun 2011 11:33:35 +0200
1.57 kristaps 124:
1.79 schwarze 125: --- missing man features -----------------------------------------------
126:
1.80 schwarze 127: - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
128: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.119 kristaps 129:
130: - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
1.80 schwarze 131:
1.79 schwarze 132: --- missing tbl features -----------------------------------------------
133:
134: - implement basic non-parametric .de to support e.g. sox(1)
135: reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
136: *** sox(1) still doesn't work, tbl(1) errors need investigation
1.105 kristaps 137:
138: - allow standalone `.' to be interpreted as an end-of-layout
139: delimiter instead of being thrown away as a no-op roff line
140: reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
1.79 schwarze 141:
142: --- missing misc features ----------------------------------------------
143:
144: - clean up escape sequence handling, creating three classes:
145: (1) fully implemented, or parsed and ignored without loss of content
146: (2) unimplemented, potentially causing loss of content
147: or serious mangling of formatting (e.g. \n) -> ERROR
148: see textproc/mgdiff(1) for nice examples
149: (3) undefined, just output the character -> perhaps WARNING
150:
1.83 schwarze 151: - The \t escape sequence is the same as a literal tab, see for example
152: the ASCII table in hexdump(1) where
153: .Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo
154: .It \&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq
155: produces
156: 000 nul 001 soh 002 stx 003 etx 004 eot 005 enq
157: and the example in oldrdist(1)
158:
1.79 schwarze 159: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
160: These are a weird mixture of man(7) and custom autogenerated low-level
161: roff stuff. Figure out to what extent we can cope.
1.80 schwarze 162: For details, see http://docutils.sourceforge.net/rst.html
1.79 schwarze 163: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
164: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
1.71 schwarze 165:
166: - check compatibility with Plan9:
167: http://swtch.com/usr/local/plan9/tmac/tmac.an
168: http://swtch.com/plan9port/man/man7/man.html
169: "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63 schwarze 170:
1.1 kristaps 171: ************************************************************************
172: * formatting issues: ugly output
173: ************************************************************************
1.87 kristaps 174:
175: - a column list with blank `Ta' cells triggers a spurrious
176: start-with-whitespace printing of a newline
1.33 schwarze 177:
1.67 schwarze 178: - double quotes inside double quotes are escaped by doubling them
1.74 schwarze 179: implement this in mdoc(7), too
180: so far, we only have it in roff(7) and man(7)
1.67 schwarze 181: reminded by millert@ Thu, 09 Dec 2010 17:29:52 -0500
182:
1.28 schwarze 183: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29 kristaps 184: 1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1 kristaps 185:
1.39 schwarze 186: - In .Bl -column,
187: .It Em Authentication<tab>Key Length
188: ought to render "Key Length" with emphasis, too,
189: see OpenBSD iked.conf(5).
1.123 ! schwarze 190: reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.39 schwarze 191:
1.1 kristaps 192: - empty phrases in .Bl column produce too few blanks
193: try e.g. .Bl -column It Ta Ta
194: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48 schwarze 195:
1.83 schwarze 196: - .%T can have trailing punctuation. Currently, it puts the trailing
197: punctuation into a trailing MDOC_TEXT element inside its own scope.
198: That element should rather be outside its scope, such that the
199: punctuation does not get underlines. This is not trivial to
200: implement because .%T then needs some features of in_line_eoln() -
201: slurp all arguments into one single text element - and one feature
202: of in_line() - put trailing punctuation out of scope.
203: Found in mount_nfs(8) and exports(5), search for "Appendix".
204:
1.48 schwarze 205: - in enclosures, mandoc sometimes fancies a bogus end of sentence
206: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.35 kristaps 207:
1.1 kristaps 208: ************************************************************************
1.104 kristaps 209: * formatting issues: gratuitous differences
1.1 kristaps 210: ************************************************************************
1.65 kristaps 211:
212: - .Rv (and probably .Ex) print different text if an `Nm' has been named
213: or not (run a manual without `Nm blah' to see this). I'm not sure
214: that this exists in the wild, but it's still an error.
1.38 schwarze 215:
216: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
217: is just "o\bo".
218: see for example OpenBSD ksh(1)
219:
220: - The characters "|" and "\*(Ba" should never be bold,
221: not even in the middle of a word, e.g. ".Cm b\*(Bac" in
222: "mknod [-m mode] name b|c major minor"
223: in OpenBSD ksh(1)
224:
225: - A bogus .Pp between two .It must not produce a double blank line,
1.39 schwarze 226: see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
1.83 schwarze 227: or in DIAGNOSTICS in init(8), or before "is always true" in ksh(1).
228: The same happens with .Pp just before .El, see bgpd.conf(5).
1.68 kristaps 229: Also have `It' complain if `Pp' is invoked at certain times (not
230: -compact?).
1.103 schwarze 231:
232: - .Pp between two .It in .Bl -column should produce one,
233: not two blank lines, see e.g. login.conf(5).
234: reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059
1.39 schwarze 235:
1.83 schwarze 236: - If the *first* line after .It is .Pp, break the line right after
237: the tag, do not pad with space characters before breaking.
238: See the description of the a, c, and i commands in sed(1).
239:
240: - If the first line after .It is .D1, do not assert a blank line
241: in between, see for example tmux(1).
242: reported by nicm@ 13 Jan 2011 00:18:57 +0000
243:
1.39 schwarze 244: - .Nx 1.0a
245: should be "NetBSD 1.0A", not "NetBSD 1.0a",
246: see OpenBSD ccdconfig(8).
1.83 schwarze 247:
1.39 schwarze 248: - In .Bl -tag, if a tag exceeds the right margin and must be continued
249: on the next line, it must be indented by -width, not width+1;
250: see "rule block|pass" in OpenBSD ifconfig(8).
1.56 schwarze 251:
1.83 schwarze 252: - When the -width string contains macros, the macros must be rendered
253: before measuring the width, for example
254: .Bl -tag -width ".Dv message"
255: in magic(5), located in src/usr.bin/file, is the same
256: as -width 7n, not -width 11n.
257:
1.56 schwarze 258: - The \& zero-width character counts as output.
259: That is, when it is alone on a line between two .Pp,
260: we want three blank lines, not two as in mandoc.
1.63 schwarze 261:
262: - When .Fn arguments exceed one output line, all but the first
263: should be indented, see e.g. rpc(3);
264: reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100
1.121 schwarze 265: reported again by Nicolas Joly via wiz@ Sun, 18 Sep 2011 18:24:40 +0200
266: Also, we don't want to break the line within the argument of:
267: .Fa "chtype tl"
1.83 schwarze 268:
269: - .Ns should work when called at the end of an input line, see
270: the following code in vi(1):
271: .It Xo
272: .Op Ar line
273: .Cm a Ns Op Cm ppend Ns
274: .Op Cm !\&
275: .Xc
276: The input text is appended after the specified line.
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: - In man(7), the sequence
284: .HP
285: one line of regular text
286: .SH
287: should not produce two blank lines before the .SH,
288: see for example named-checkconf(8).
289:
290: - In man(7), the sequence
1.98 schwarze 291: .SH HEADER
292: <blank line>
293: .PP
294: regular text
295: should not produce any blank lines between the header and the text,
296: see for example rsync(1).
297: Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200
298:
299: - In man(7), the sequence
300: regular text
301: .IP
302: .IP "tag"
303: indented text
304: should produce one, not four blank lines between the regular text
305: and the tag, see for example rsync(1).
306: Likewise,
307: regular text
308: .IP
309: indented text
310: should produce one, not two blank lines in between, and
311: regular text
312: .IP
313: .RS
314: .IP tag
315: indented text
316: should produce one, not three blank lines.
317: Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200
1.83 schwarze 318:
319: - trailing whitespace must be ignored even when followed by a font escape,
320: see for example
321: makes
322: \fBdig \fR
323: operate in batch mode
324: in dig(1).
1.75 schwarze 325:
326: ************************************************************************
327: * error reporting issues
328: ************************************************************************
1.1 kristaps 329:
1.9 kristaps 330: ************************************************************************
331: * performance issues
332: ************************************************************************
333:
334: Several areas can be cleaned up to make mandoc even faster. These are
335:
336: - improve hashing mechanism for macros (quite important: performance)
337:
338: - improve hashing mechanism for characters (not as important)
1.23 kristaps 339:
1.37 kristaps 340: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115 kristaps 341:
342: - instead of re-initialising the roff predefined-strings set before each
343: parse, create a read-only version the first time and copy it
1.37 kristaps 344:
1.23 kristaps 345: ************************************************************************
346: * structural issues
347: ************************************************************************
1.122 schwarze 348:
349: - We use the input line number at several places to distinguish
350: same-line from different-line input. That plainly doesn't work
351: with user-defined macros, leading to random breakage.
1.67 schwarze 352:
353: - Find better ways to prevent endless loops
354: in roff(7) macro and string expansion.
1.91 schwarze 355:
1.96 schwarze 356: - Finish cleanup of date handling.
1.91 schwarze 357: Decide which formats should be recognized where.
358: Update both mdoc(7) and man(7) documentation.
359: Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100
CVSweb