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