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