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