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