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