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