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