Annotation of mandoc/TODO, Revision 1.192
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.192 ! schwarze 3: * $Id: TODO,v 1.191 2014/12/02 10:41:12 schwarze Exp $
1.27 kristaps 4: ************************************************************************
1.145 schwarze 5:
1.184 schwarze 6: Many issues are annotated for difficulty as follows:
7:
8: - loc = locality of the issue
9: * single file issue, affects file only, or very few
10: ** single module issue, affects several files of one module
11: *** cross-module issue, significantly impacts multiple modules
12: and may require substantial changes to internal interfaces
13: - exist = difficulty of the existing code in this area
14: * affected code is straightforward and easy to read and change
15: ** affected code is somewhat complex, but once you understand
16: the design, not particularly difficult to understand
17: *** affected code uses a special, exceptionally tricky design
18: - algo = difficulty of the new algorithm to be written
19: * the required logic and code is straightforward
20: ** the required logic is somewhat complex and needs a careful design
21: *** the required logic is exceptionally tricky,
22: maybe an approach to solve that is not even known yet
23: - size = the amount of code to be written or changed
24: * a small number of lines (at most 100, usually much less)
25: ** a considerable amount of code (several dozen to a few hundred)
26: *** a large amount of code (many hundreds, maybe thousands)
27: - imp = importance of the issue
28: * mostly for completeness
29: ** would be nice to have
30: *** issue causes considerable inconvenience
31:
32: Obviously, as the issues have not been solved yet, these annotations
33: are mere guesses, and some may be wrong.
34:
1.145 schwarze 35: ************************************************************************
36: * crashes
37: ************************************************************************
38:
1.169 schwarze 39: - The abort() in bufcat(), html.c, can be triggered via buffmt_includes()
40: by running -Thtml -Oincludes on a file containing a long .In argument.
41: Fixing this will probably require reworking the whole bufcat() concept.
1.184 schwarze 42: loc ** exist * algo * size ** imp **
1.101 schwarze 43:
1.61 schwarze 44: ************************************************************************
1.1 kristaps 45: * missing features
46: ************************************************************************
1.70 kristaps 47:
1.79 schwarze 48: --- missing roff features ----------------------------------------------
49:
1.82 schwarze 50: - .ad (adjust margins)
51: .ad l -- adjust left margin only (flush left)
52: .ad r -- adjust right margin only (flush right)
53: .ad c -- center text on line
54: .ad b -- adjust both margins (alias: .ad n)
55: .na -- temporarily disable adjustment without changing the mode
56: .ad -- re-enable adjustment without changing the mode
57: Adjustment mode is ignored while in no-fill mode (.nf).
1.184 schwarze 58: loc *** exist *** algo ** size ** imp ** (parser reorg would help)
1.150 schwarze 59:
60: - .fc (field control)
61: found by naddy@ in xloadimage(1)
1.184 schwarze 62: loc ** exist *** algo * size * imp *
1.150 schwarze 63:
1.160 schwarze 64: - .nr third argument (auto-increment step size, requires \n+)
65: found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
1.184 schwarze 66: loc * exist * algo * size * imp **
1.160 schwarze 67:
1.80 schwarze 68: - .ns (no-space mode) occurs in xine-config(1)
69: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.184 schwarze 70: loc *** exist *** algo *** size ** imp *
1.61 schwarze 71:
1.81 schwarze 72: - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
73: reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500
1.167 schwarze 74: also Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
1.191 schwarze 75: also posix2time(3) Carsten Kunze Mon, 1 Dec 2014 13:03:10 +0100
76: loc ** exist *** algo ** size ** imp ***
1.150 schwarze 77:
78: - .ti (temporary indent)
79: found by naddy@ in xloadimage(1)
80: found by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600
1.184 schwarze 81: loc ** exist ** algo ** size * imp ** (parser reorg helps a lot)
1.154 schwarze 82:
83: - .while and .shift
84: found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200
1.184 schwarze 85: loc * exist ** algo ** size ** imp **
1.155 schwarze 86:
87: - \h horizontal move
88: found in cclive(1) DocBook output
89: Anthony J. Bentley on discuss@ Sat, 21 Sep 2013 22:29:34 -0600
1.184 schwarze 90: loc ** exist ** algo ** size * imp ** (parser reorg helps a lot)
1.125 schwarze 91:
1.160 schwarze 92: - \n+ and \n- numerical register increment and decrement
93: found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
1.184 schwarze 94: loc * exist * algo * size * imp **
1.160 schwarze 95:
1.184 schwarze 96: - \w'' improve width measurements
1.167 schwarze 97: would not be very useful without an expression parser, see below
98: needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
1.184 schwarze 99: loc ** exist *** algo *** size * imp ***
1.167 schwarze 100:
1.125 schwarze 101: - using undefined strings or macros defines them to be empty
102: wl@ Mon, 14 Nov 2011 14:37:01 +0000
1.184 schwarze 103: loc * exist * algo * size * imp *
1.167 schwarze 104:
1.79 schwarze 105: --- missing mdoc features ----------------------------------------------
106:
1.18 schwarze 107: - fix bad block nesting involving multiple identical explicit blocks
108: see the OpenBSD mdoc_macro.c 1.47 commit message
1.184 schwarze 109: loc * exist *** algo *** size * imp **
1.18 schwarze 110:
1.1 kristaps 111: - .Bl -column .Xo support is missing
112: ultimate goal:
113: restore .Xr and .Dv to
114: lib/libc/compat-43/sigvec.3
115: lib/libc/gen/signal.3
116: lib/libc/sys/sigaction.2
1.184 schwarze 117: loc * exist *** algo *** size * imp **
1.1 kristaps 118:
1.28 schwarze 119: - edge case: decide how to deal with blk_full bad nesting, e.g.
120: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
121: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
1.184 schwarze 122: loc * exist *** algo *** size ** imp **
1.28 schwarze 123:
1.74 schwarze 124: - \\ is now implemented correctly
125: * when defining strings and macros using .ds and .de
126: * when parsing roff(7) and man(7) macro arguments
127: It does not yet work in mdoc(7) macro arguments
128: because libmdoc does not yet use mandoc_getarg().
129: Also check what happens in plain text, it must be identical to \e.
1.82 schwarze 130:
1.174 schwarze 131: - .Bd -centered implies -filled, not -unfilled, which is not
132: easy to implement; it requires code similar to .ce, which
133: we don't have either.
134: Besides, groff has bug causing text right *before* .Bd -centered
135: to be centered as well.
1.184 schwarze 136: loc *** exist *** algo ** size ** imp ** (parser reorg would help)
1.174 schwarze 137:
1.82 schwarze 138: - .Bd -filled should not be the same as .Bd -ragged, but align both
139: the left and right margin. In groff, it is implemented in terms
140: of .ad b, which we don't have either. Found in cksum(1).
1.184 schwarze 141: loc *** exist *** algo ** size ** imp ** (parser reorg would help)
1.22 schwarze 142:
1.10 kristaps 143: - implement blank `Bl -column', such as
144: .Bl -column
145: .It foo Ta bar
146: .El
1.184 schwarze 147: loc * exist *** algo *** size * imp *
1.11 kristaps 148:
149: - explicitly disallow nested `Bl -column', which would clobber internal
150: flags defined for struct mdoc_macro
1.184 schwarze 151: loc * exist * algo * size * imp **
1.102 schwarze 152:
153: - In .Bl -column .It, the end of the line probably has to be regarded
154: as an implicit .Ta, if there could be one, see the following mildly
155: ugly code from login.conf(5):
156: .Bl -column minpasswordlen program xetcxmotd
157: .It path Ta path Ta value of Dv _PATH_DEFPATH
158: .br
159: Default search path.
160: reported by Michal Mazurek <akfaew at jasminek dot net>
161: via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.184 schwarze 162: loc * exist *** algo ** size * imp **
1.42 schwarze 163:
164: - inside `.Bl -column' phrases, punctuation is handled like normal
165: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
166:
167: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
168: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
169: but should give "ab ."
1.12 kristaps 170:
171: - set a meaningful default if no `Bl' list type is assigned
1.184 schwarze 172: loc * exist * algo * size * imp ** (already done?)
1.13 kristaps 173:
174: - have a blank `It' head for `Bl -tag' not puke
1.184 schwarze 175: loc * exist * algo * size * imp ** (already done?)
1.20 kristaps 176:
1.174 schwarze 177: - check whether it is correct that `D1' uses INDENT+1;
178: does it need its own constant?
1.184 schwarze 179: loc * exist ** algo ** size * imp **
1.174 schwarze 180:
1.20 kristaps 181: - prohibit `Nm' from having non-text HEAD children
182: (e.g., NetBSD mDNSShared/dns-sd.1)
183: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109 schwarze 184:
1.174 schwarze 185: - support translated section names
186: e.g. x11/scrotwm scrotwm_es.1:21:2: error: NAME section must be first
187: that one uses NOMBRE because it is spanish...
188: deraadt tends to think that section-dependent macro behaviour
189: is a bad idea in the first place, so this may be irrelevant
1.184 schwarze 190: loc ** exist ** algo ** size * imp **
1.174 schwarze 191:
1.109 schwarze 192: - When there is free text in the SYNOPSIS and that free text contains
193: the .Nm macro, groff somehow understands to treat the .Nm as an in-line
194: macro, while mandoc treats it as a block macro and breaks the line.
195: No idea how the logic for distinguishing in-line and block instances
196: should be, needs investigation.
197: uqs@ Thu, 2 Jun 2011 11:03:51 +0200
198: uqs@ Thu, 2 Jun 2011 11:33:35 +0200
1.184 schwarze 199: loc * exist ** algo *** size * imp **
1.57 kristaps 200:
1.79 schwarze 201: --- missing man features -----------------------------------------------
202:
1.119 kristaps 203: - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
1.80 schwarze 204:
1.79 schwarze 205: --- missing tbl features -----------------------------------------------
206:
1.171 schwarze 207: - look at the POSIX manuals in the books/man-pages-posix port,
208: they use some unsupported tbl(7) features.
1.184 schwarze 209: loc * exist ** algo ** size ** imp ***
1.171 schwarze 210:
1.183 schwarze 211: - use Unicode U+2500 to U+256C for table borders
212: in tbl(7) -Tutf-8 output
213: suggested by bentley@ Tue, 14 Oct 2014 04:10:55 -0600
1.184 schwarze 214: loc * exist ** algo * size * imp **
1.105 kristaps 215:
216: - allow standalone `.' to be interpreted as an end-of-layout
217: delimiter instead of being thrown away as a no-op roff line
218: reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
1.184 schwarze 219: loc ** exist ** algo ** size * imp **
1.79 schwarze 220:
1.182 schwarze 221: --- missing eqn features -----------------------------------------------
222:
223: - The "size" keyword is parsed, but ignored by the formatter.
1.184 schwarze 224: loc * exist * algo * size * imp *
1.182 schwarze 225:
226: - The spacing characters `~', `^', and tab are currently ignored,
227: see User's Guide (Second Edition) page 2 section 4.
1.184 schwarze 228: loc * exist * algo ** size * imp **
1.182 schwarze 229:
230: - Mark and lineup are parsed and ignored,
231: see User's Guide (Second Edition) page 5 section 15.
1.184 schwarze 232: loc ** exist ** algo ** size ** imp **
1.182 schwarze 233:
1.79 schwarze 234: --- missing misc features ----------------------------------------------
1.159 schwarze 235:
236: - italic correction (\/) in PostScript mode
237: Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46
1.184 schwarze 238: loc ** exist ** algo * size * imp *
1.153 schwarze 239:
1.173 schwarze 240: - When makewhatis(8) encounters a FATAL parse error,
241: it silently treats the file as formatted, which makes no sense
242: at all for paths like man1/foo.1 - and which also contradicts
243: what the manual says at the end of the description.
244: The end result will be ENOENT for file names returned
245: by mansearch() in manpage.file.
1.184 schwarze 246: loc * exist * algo * size * imp **
1.173 schwarze 247:
1.171 schwarze 248: - makewhatis(8) for preformatted pages:
249: parse the section number from the header line
250: and compare to the section number from the directory name
1.184 schwarze 251: loc * exist * algo * size * imp **
1.171 schwarze 252:
253: - Does makewhatis(8) detect missing NAME sections, missing names,
254: and missing descriptions in all the file formats?
1.184 schwarze 255: loc * exist * algo * size * imp ***
1.171 schwarze 256:
1.79 schwarze 257: - clean up escape sequence handling, creating three classes:
258: (1) fully implemented, or parsed and ignored without loss of content
259: (2) unimplemented, potentially causing loss of content
260: or serious mangling of formatting (e.g. \n) -> ERROR
261: see textproc/mgdiff(1) for nice examples
262: (3) undefined, just output the character -> perhaps WARNING
1.184 schwarze 263: loc *** exist ** algo ** size ** imp *** (parser reorg helps)
1.83 schwarze 264:
1.174 schwarze 265: - kettenis wants base roff, ms, and me Fri, 1 Jan 2010 22:13:15 +0100 (CET)
1.184 schwarze 266: loc ** exist ** algo ** size *** imp *
1.174 schwarze 267:
268: --- compatibility checks -----------------------------------------------
269:
270: - is .Bk implemented correctly in modern groff?
271: sobrado@ Tue, 19 Apr 2011 22:12:55 +0200
272:
1.175 schwarze 273: - compare output to Heirloom roff, Solaris roff, and
274: http://repo.or.cz/w/neatroff.git http://litcave.rudi.ir/
1.178 schwarze 275:
276: - look at AT&T DWB http://www2.research.att.com/sw/download
277: Carsten Kunze <carsten dot kunze at arcor dot de> has patches
278: Mon, 4 Aug 2014 17:01:28 +0200
1.174 schwarze 279:
1.79 schwarze 280: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
281: These are a weird mixture of man(7) and custom autogenerated low-level
282: roff stuff. Figure out to what extent we can cope.
1.80 schwarze 283: For details, see http://docutils.sourceforge.net/rst.html
1.79 schwarze 284: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
285: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
1.160 schwarze 286:
1.174 schwarze 287: - look at pages generated from ronn(1) github.com/rtomayko/ronn
288: (based on markdown)
289:
1.160 schwarze 290: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
291: First impression is not that bad.
1.172 schwarze 292:
293: - look at pages generated by pandoc; see
294: https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
295: porting planned by kili@ Thu, 19 Jun 2014 19:46:28 +0200
1.71 schwarze 296:
297: - check compatibility with Plan9:
298: http://swtch.com/usr/local/plan9/tmac/tmac.an
299: http://swtch.com/plan9port/man/man7/man.html
300: "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63 schwarze 301:
1.174 schwarze 302: - check compatibility with the man(7) formatter
303: https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
304:
1.186 schwarze 305: - check compatibility with
306: http://ikiwiki.info/plugins/contrib/mandoc/
307: https://github.com/schmonz/ikiwiki/compare/mandoc
308: Amitai Schlair Mon, 19 May 2014 14:05:53 -0400
309:
1.1 kristaps 310: ************************************************************************
311: * formatting issues: ugly output
312: ************************************************************************
1.87 kristaps 313:
314: - a column list with blank `Ta' cells triggers a spurrious
315: start-with-whitespace printing of a newline
1.1 kristaps 316:
1.39 schwarze 317: - In .Bl -column,
318: .It Em Authentication<tab>Key Length
319: ought to render "Key Length" with emphasis, too,
320: see OpenBSD iked.conf(5).
1.123 schwarze 321: reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.184 schwarze 322: loc * exist *** algo *** size ** imp ***
1.39 schwarze 323:
1.1 kristaps 324: - empty phrases in .Bl column produce too few blanks
325: try e.g. .Bl -column It Ta Ta
326: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.184 schwarze 327: loc * exist *** algo *** size * imp **
1.48 schwarze 328:
1.83 schwarze 329: - .%T can have trailing punctuation. Currently, it puts the trailing
330: punctuation into a trailing MDOC_TEXT element inside its own scope.
331: That element should rather be outside its scope, such that the
332: punctuation does not get underlines. This is not trivial to
333: implement because .%T then needs some features of in_line_eoln() -
334: slurp all arguments into one single text element - and one feature
335: of in_line() - put trailing punctuation out of scope.
336: Found in mount_nfs(8) and exports(5), search for "Appendix".
1.184 schwarze 337: loc ** exist ** algo *** size * imp **
1.83 schwarze 338:
1.147 schwarze 339: - Trailing punctuation after .%T triggers EOS spacing, at least
340: outside .Rs (eek!). Simply setting ARGSFL_DELIM for .%T is not
341: the right solution, it sends mandoc into an endless loop.
342: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
1.184 schwarze 343: loc * exist ** algo ** size * imp **
1.147 schwarze 344:
1.174 schwarze 345: - global variables in the SYNOPSIS of section 3 pages
346: .Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...
347: from kristaps@ Tue, 08 Jun 2010 11:13:32 +0200
348:
1.48 schwarze 349: - in enclosures, mandoc sometimes fancies a bogus end of sentence
350: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.184 schwarze 351: loc * exist ** algo *** size * imp ***
1.149 schwarze 352:
353: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
354: reveals lots of bugs both in groff and mandoc...
355: reported by bentley@ Wed, 22 May 2013 23:49:30 -0600
1.171 schwarze 356:
357: --- PDF issues ---------------------------------------------------------
358:
359: - PDF output doesn't use a monospaced font for .Bd -literal
360: Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
361: Search the text "Routing tables".
362: Also check what PostScript mode does when fixing this.
363: reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
1.186 schwarze 364: instructions from juanfra@ Wed, 11 Jun 2014 02:21:01 +0200
365: add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
366: and change the /Name from /F0 to the new font (/F5 (?)).
367: loc * exist ** algo ** size * imp **
1.173 schwarze 368:
369: --- HTML issues --------------------------------------------------------
370:
1.174 schwarze 371: - <dl><dt><dd> formatting is ugly
372: hints are easy to find on the web, e.g.
373: http://stackoverflow.com/questions/1713048/
374: see also matthew@ Fri, 18 Jul 2014 19:25:12 -0700
1.184 schwarze 375: loc * exist * algo ** size * imp ***
1.180 schwarze 376:
1.187 schwarze 377: - jsg on icb, Nov 3, 2014:
378: try to guess Xr in man(7) for hyperlinking
379:
1.180 schwarze 380: - The tables used to render the three-part page headers actually force
381: the width of the <body> to the max-width given for <html>.
382: Not yet sure how to fix that...
383: Observed by an Anonymous Coward on undeadly.org:
384: http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
1.184 schwarze 385: loc * exist * algo ** size * imp ***
1.177 schwarze 386:
387: - consider whether <var> can be used for Ar Dv Er Ev Fa Va.
388: from bentley@ Wed, 13 Aug 2014 09:17:55 -0600
1.174 schwarze 389:
1.173 schwarze 390: - check https://github.com/trentm/mdocml
1.35 kristaps 391:
1.1 kristaps 392: ************************************************************************
1.104 kristaps 393: * formatting issues: gratuitous differences
1.1 kristaps 394: ************************************************************************
1.187 schwarze 395:
396: - .Fn reopens a new scope after punctuation in mandoc,
397: but closes its scope for good in groff.
398: Do we want to change mandoc or groff?
399: Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100
400: loc * exist ** algo ** size * imp **
1.65 kristaps 401:
402: - .Rv (and probably .Ex) print different text if an `Nm' has been named
403: or not (run a manual without `Nm blah' to see this). I'm not sure
404: that this exists in the wild, but it's still an error.
1.184 schwarze 405: loc * exist * algo * size * imp * (already done?)
1.38 schwarze 406:
407: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
1.184 schwarze 408: is just "o\bo". The problem is to not break ps/pdf when fixing.
1.38 schwarze 409: see for example OpenBSD ksh(1)
1.184 schwarze 410: loc ** exist ** algo ** size * imp **
1.103 schwarze 411:
1.174 schwarze 412: - In .Bl -enum -width 0n, groff continues one the same line after
413: the number, mandoc breaks the line.
414: mail to kristaps@ Mon, 20 Jul 2009 02:21:39 +0200
1.184 schwarze 415: loc * exist ** algo ** size * imp **
1.174 schwarze 416:
1.103 schwarze 417: - .Pp between two .It in .Bl -column should produce one,
418: not two blank lines, see e.g. login.conf(5).
419: reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059
1.129 schwarze 420: reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.184 schwarze 421: loc * exist *** algo ** size * imp **
1.39 schwarze 422:
1.83 schwarze 423: - If the *first* line after .It is .Pp, break the line right after
424: the tag, do not pad with space characters before breaking.
425: See the description of the a, c, and i commands in sed(1).
1.184 schwarze 426: loc * exist ** algo ** size * imp **
1.83 schwarze 427:
428: - If the first line after .It is .D1, do not assert a blank line
429: in between, see for example tmux(1).
430: reported by nicm@ 13 Jan 2011 00:18:57 +0000
1.184 schwarze 431: loc * exist ** algo ** size * imp **
1.147 schwarze 432:
433: - Trailing punctuation after .It should trigger EOS spacing.
434: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
435: Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.184 schwarze 436: loc * exist ** algo ** size * imp **
1.83 schwarze 437:
1.39 schwarze 438: - .Nx 1.0a
439: should be "NetBSD 1.0A", not "NetBSD 1.0a",
440: see OpenBSD ccdconfig(8).
1.184 schwarze 441: loc * exist * algo * size * imp **
1.83 schwarze 442:
1.39 schwarze 443: - In .Bl -tag, if a tag exceeds the right margin and must be continued
444: on the next line, it must be indented by -width, not width+1;
445: see "rule block|pass" in OpenBSD ifconfig(8).
1.184 schwarze 446: loc * exist *** algo ** size * imp **
1.56 schwarze 447:
1.83 schwarze 448: - When the -width string contains macros, the macros must be rendered
449: before measuring the width, for example
450: .Bl -tag -width ".Dv message"
451: in magic(5), located in src/usr.bin/file, is the same
452: as -width 7n, not -width 11n.
1.129 schwarze 453: The same applies to .Bl -column column widths;
454: reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157 schwarze 455: reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
1.184 schwarze 456: loc *** exist *** algo *** size ** imp ***
1.157 schwarze 457: An easy partial fix would be to just skip the first word if it starts
458: with a dot, including any following white space, when measuring.
1.184 schwarze 459: loc * exist * algo * size * imp ***
1.83 schwarze 460:
1.56 schwarze 461: - The \& zero-width character counts as output.
462: That is, when it is alone on a line between two .Pp,
463: we want three blank lines, not two as in mandoc.
1.184 schwarze 464: loc ** exist ** algo ** size * imp **
1.83 schwarze 465:
1.64 schwarze 466: - Header lines of excessive length:
467: Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
468: and document it in mdoc(7) and man(7) COMPATIBILITY
469: found while talking to Chris Bennett
1.184 schwarze 470: loc * exist * algo * size * imp *
1.83 schwarze 471:
472: - trailing whitespace must be ignored even when followed by a font escape,
473: see for example
474: makes
475: \fBdig \fR
476: operate in batch mode
477: in dig(1).
1.184 schwarze 478: loc ** exist ** algo ** size * imp **
1.166 schwarze 479:
480: ************************************************************************
481: * warning issues
482: ************************************************************************
483:
484: - check that MANDOCERR_BADTAB is thrown in the right cases,
485: i.e. when finding a literal tab character in fill mode,
486: and possibly change the wording of the warning message
487: to refer to fill mode, not literal mode
488: See the mail from Werner LEMBERG on the groff list,
489: Fri, 14 Feb 2014 18:54:42 +0100 (CET)
1.184 schwarze 490: loc * exist ** algo ** size * imp **
1.188 schwarze 491:
492: - warn about attempts to call non-callable macros
493: Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100
494: Note that formatting is inconsistent in groff.
495: .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
496: Relatively hard because the relevant code is scattered
497: all over mdoc_macro.c and all subtly different.
498: loc ** exist ** algo ** size ** imp **
1.174 schwarze 499:
500: - warn about "new sentence, new line"
1.184 schwarze 501: loc ** exist ** algo *** size * imp **
1.174 schwarze 502:
503: - mandoc_special does not really check the escape sequence,
504: but just the overall format
1.184 schwarze 505: loc ** exist ** algo *** size ** imp **
1.174 schwarze 506:
507: - integrate mdoclint into mandoc ("end-of-line whitespace" thread)
508: from jmc@ Mon, 13 Jul 2009 17:12:09 +0100
509: from kristaps@ Mon, 13 Jul 2009 18:34:53 +0200
510: from jmc@ Mon, 13 Jul 2009 17:45:37 +0059
511: from kristaps@ Mon, 13 Jul 2009 19:02:03 +0200
1.184 schwarze 512: (mostly done, check what remains)
1.174 schwarze 513:
514: - -Tlint parser errors and warnings to stdout
515: to tech@mdocml, naddy@ Wed, 28 Sep 2011 11:21:46 +0200
516: wait! kristaps@ Sun, 02 Oct 2011 17:12:52 +0200
517:
518: - for system errors, use errno/strerror/warn/err
519:
520: ************************************************************************
521: * documentation issues
522: ************************************************************************
523:
524: - mention hyphenation rules:
525: breaking at letter-letter in text mode (not macro args)
526: proper hyphenation is unimplemented
527:
528: - talk about spacing around delimiters
529: to jmc@, kristaps@ Sat, 23 Apr 2011 17:41:27 +0200
530:
531: - mark macros as: page structure domain, manual domain, general text domain
532: is this useful?
533:
534: - mention /usr/share/misc/mdoc.template in mdoc(7)?
1.185 schwarze 535:
536: - Is all the content from http://www.std.com/obi/BSD/doc/usd/28.tbl/tbl
537: covered in tbl(7)?
1.1 kristaps 538:
1.9 kristaps 539: ************************************************************************
540: * performance issues
541: ************************************************************************
1.176 schwarze 542:
543: - Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?
544: How does SQLITE_CONFIG_PAGECACHE actually work? Document it!
545: from kristaps@ Sat, 09 Aug 2014 13:51:36 +0200
1.9 kristaps 546:
547: Several areas can be cleaned up to make mandoc even faster. These are
548:
549: - improve hashing mechanism for macros (quite important: performance)
550:
551: - improve hashing mechanism for characters (not as important)
1.23 kristaps 552:
1.37 kristaps 553: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115 kristaps 554:
555: - instead of re-initialising the roff predefined-strings set before each
556: parse, create a read-only version the first time and copy it
1.184 schwarze 557: loc * exist ** algo ** size * imp **
1.37 kristaps 558:
1.23 kristaps 559: ************************************************************************
560: * structural issues
561: ************************************************************************
1.189 schwarze 562:
563: - Use libz directly instead of forking gunzip(1).
564: Suggested by bapt at FreeBSD among others.
1.122 schwarze 565:
566: - We use the input line number at several places to distinguish
567: same-line from different-line input. That plainly doesn't work
568: with user-defined macros, leading to random breakage.
1.67 schwarze 569:
570: - Find better ways to prevent endless loops
571: in roff(7) macro and string expansion.
1.91 schwarze 572:
1.96 schwarze 573: - Finish cleanup of date handling.
1.91 schwarze 574: Decide which formats should be recognized where.
575: Update both mdoc(7) and man(7) documentation.
576: Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100
1.186 schwarze 577:
578: - struct mparse refactoring
579: Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200
1.170 schwarze 580:
581: - Consider creating some views that will make the database more
582: readable from the sqlite3 shell. Consider using them to
583: abstract from the database structure, too.
584: suggested by espie@ Sat, 19 Apr 2014 14:52:57 +0200
585:
1.179 kristaps 586: ************************************************************************
587: * CGI issues
588: ************************************************************************
589:
590: - Enable HTTP compression by detecting gzip encoding and filtering
591: output through libz.
592: - Sandbox (see OpenSSH).
593: - Enable caching support via HTTP 304 and If-Modified-Since.
594: - Allow for cgi.h to be overridden by CGI environment variables.
595: Otherwise, binary distributions will inherit the compile-time
596: behaviour, which is not optimal.
597: - Have Mac OSX systems automatically disable -static compilation of the
598: CGI: -static isn't supported.
1.181 kristaps 599:
1.192 ! schwarze 600: ************************************************************************
! 601: * to improve in the groff_mdoc(7) macros
! 602: ************************************************************************
! 603:
! 604: - use uname(1) to set doc-default-operating-system at install time
! 605: tobimensch Mon, 1 Dec 2014 00:25:07 +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