Annotation of mandoc/TODO, Revision 1.297
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.297 ! schwarze 3: * $Id: TODO,v 1.296 2019/11/09 17:09:15 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.296 schwarze 36: * crashes
37: ************************************************************************
38:
39: - .ce .if n .B two crashes because "return (*roffs[t].sub)" bypasses
40: the "high level macros abort .ce" safeguard in roff_parseln()
41: reported by espie@ in textproc/fstrcmp
42:
43: ************************************************************************
1.1 kristaps 44: * missing features
45: ************************************************************************
1.70 kristaps 46:
1.79 schwarze 47: --- missing roff features ----------------------------------------------
1.258 schwarze 48:
1.82 schwarze 49: - .ad (adjust margins)
50: .ad l -- adjust left margin only (flush left)
51: .ad r -- adjust right margin only (flush right)
52: .ad c -- center text on line
53: .ad b -- adjust both margins (alias: .ad n)
54: .na -- temporarily disable adjustment without changing the mode
55: .ad -- re-enable adjustment without changing the mode
56: Adjustment mode is ignored while in no-fill mode (.nf).
1.184 schwarze 57: loc *** exist *** algo ** size ** imp ** (parser reorg would help)
1.150 schwarze 58:
59: - .fc (field control)
60: found by naddy@ in xloadimage(1)
1.184 schwarze 61: loc ** exist *** algo * size * imp *
1.198 schwarze 62:
1.80 schwarze 63: - .ns (no-space mode) occurs in xine-config(1)
1.205 schwarze 64: when implementing this, also let .TH set it
1.80 schwarze 65: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.184 schwarze 66: loc *** exist *** algo *** size ** imp *
1.201 schwarze 67:
1.184 schwarze 68: - \w'' improve width measurements
1.167 schwarze 69: would not be very useful without an expression parser, see below
70: needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
1.184 schwarze 71: loc ** exist *** algo *** size * imp ***
1.291 schwarze 72:
73: - .als only works for macros in mandoc, not for user-defined strings.
74: Also, the "val" field in struct roffkv would have to be replaced
75: with a pointer to a reference-counted wrapper, and an alias
76: would have to point to the same wrapper as the original.
77: .als to undefined does nothing; the alias is not created.
78: .rm'ing the original leaves the alias to point to the old value.
79: .de .als .de changes both, but
80: .de .als .rm .de only changes the new value, not the alias.
81: Found in groffer(1) version 1.19
82: Jan Stary 20 Apr 2019 20:16:54 +0200
83: loc * exist ** algo ** size ** imp *
84:
85: - roff string condition comparisons fail when vars contain quotes:
86: .ds s '
87: .if '\*s'' \&...
88: hard to fix because of the basic architecture (string replacement
89: happens before roff(7) syntax parsing)
90: Found in groffer(1) version 1.19
91: Jan Stary 20 Apr 2019 20:16:54 +0200
92: loc * exist *** algo *** size ** imp *
1.203 schwarze 93:
1.79 schwarze 94: --- missing mdoc features ----------------------------------------------
1.18 schwarze 95:
1.1 kristaps 96: - .Bl -column .Xo support is missing
97: ultimate goal:
98: restore .Xr and .Dv to
99: lib/libc/compat-43/sigvec.3
100: lib/libc/gen/signal.3
101: lib/libc/sys/sigaction.2
1.184 schwarze 102: loc * exist *** algo *** size * imp **
1.1 kristaps 103:
1.28 schwarze 104: - edge case: decide how to deal with blk_full bad nesting, e.g.
105: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
106: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
1.184 schwarze 107: loc * exist *** algo *** size ** imp **
1.174 schwarze 108:
1.82 schwarze 109: - .Bd -filled should not be the same as .Bd -ragged, but align both
110: the left and right margin. In groff, it is implemented in terms
111: of .ad b, which we don't have either. Found in cksum(1).
1.184 schwarze 112: loc *** exist *** algo ** size ** imp ** (parser reorg would help)
1.22 schwarze 113:
1.10 kristaps 114: - implement blank `Bl -column', such as
115: .Bl -column
116: .It foo Ta bar
117: .El
1.184 schwarze 118: loc * exist *** algo *** size * imp *
1.11 kristaps 119:
120: - explicitly disallow nested `Bl -column', which would clobber internal
121: flags defined for struct mdoc_macro
1.184 schwarze 122: loc * exist * algo * size * imp **
1.102 schwarze 123:
124: - In .Bl -column .It, the end of the line probably has to be regarded
125: as an implicit .Ta, if there could be one, see the following mildly
126: ugly code from login.conf(5):
127: .Bl -column minpasswordlen program xetcxmotd
128: .It path Ta path Ta value of Dv _PATH_DEFPATH
129: .br
130: Default search path.
131: reported by Michal Mazurek <akfaew at jasminek dot net>
132: via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.184 schwarze 133: loc * exist *** algo ** size * imp **
1.42 schwarze 134:
135: - inside `.Bl -column' phrases, punctuation is handled like normal
136: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
137:
138: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
139: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
140: but should give "ab ."
1.12 kristaps 141:
1.20 kristaps 142: - prohibit `Nm' from having non-text HEAD children
143: (e.g., NetBSD mDNSShared/dns-sd.1)
144: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109 schwarze 145:
1.174 schwarze 146: - support translated section names
147: e.g. x11/scrotwm scrotwm_es.1:21:2: error: NAME section must be first
148: that one uses NOMBRE because it is spanish...
149: deraadt tends to think that section-dependent macro behaviour
150: is a bad idea in the first place, so this may be irrelevant
1.184 schwarze 151: loc ** exist ** algo ** size * imp **
1.174 schwarze 152:
1.109 schwarze 153: - When there is free text in the SYNOPSIS and that free text contains
154: the .Nm macro, groff somehow understands to treat the .Nm as an in-line
155: macro, while mandoc treats it as a block macro and breaks the line.
156: No idea how the logic for distinguishing in-line and block instances
157: should be, needs investigation.
158: uqs@ Thu, 2 Jun 2011 11:03:51 +0200
159: uqs@ Thu, 2 Jun 2011 11:33:35 +0200
1.184 schwarze 160: loc * exist ** algo *** size * imp **
1.57 kristaps 161:
1.252 schwarze 162: --- missing man features -----------------------------------------------
1.258 schwarze 163:
1.252 schwarze 164: - groff_www(7) .MTO and .URL
165: These macros were used by the GNU grep(1) man page.
1.258 schwarze 166: The groff_www(7) manual page itself uses them, too.
1.252 schwarze 167: We should probably *not* add them to mandoc.
168: Just mentioning this here to keep track of the abuse.
169: Laura Morales <lauretas at mail dot com> 20 Apr 2018 07:33:02 +0200
170: loc ** exist * algo * size ** imp *
171:
1.79 schwarze 172: --- missing tbl features -----------------------------------------------
173:
1.255 schwarze 174: - vertical centering in cells vertically spanned with ^
175: pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200
176: loc * exist *** algo *** size ** imp *
177:
1.208 schwarze 178: - support mdoc(7) and man(7) macros inside tbl(7) code;
179: probably requires the parser reorg and letting tbl(7)
180: use roff_node such that macro sets can mix;
1.233 schwarze 181: informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100
1.208 schwarze 182: loc *** exist ** algo *** size ** imp ***
183:
1.171 schwarze 184: - look at the POSIX manuals in the books/man-pages-posix port,
1.283 schwarze 185: they use some unsupported tbl(7) features, mostly macros in tbl(7).
1.184 schwarze 186: loc * exist ** algo ** size ** imp ***
1.171 schwarze 187:
1.230 schwarze 188: - look what Joerg Schilling manual pages use
189: Thu, 19 Mar 2015 18:31:48 +0100
1.255 schwarze 190:
1.182 schwarze 191: --- missing eqn features -----------------------------------------------
1.209 schwarze 192:
193: - In a matrix, break the output line after each matrix line.
1.287 schwarze 194: Found in the discussion at CDBUG 2015. Suggested by Avi Weinstock.
195: This may not be the ideal solution after all: eqn(7) matrices
196: are lists of columns, so Avi's proposal would show each *column*
197: on its own *line*, which is likely to cause confusion.
198: A better solution, but much harder to implement, would be to
199: actually show the coordinates of column vectors on different
200: terminal output lines, using the clumnated output facilities
201: developed for .Bl -tag, .Bl -column, and also used for tbl(7).
202: loc * exist * algo ** size ** imp **
1.182 schwarze 203:
204: - The "size" keyword is parsed, but ignored by the formatter.
1.184 schwarze 205: loc * exist * algo * size * imp *
1.182 schwarze 206:
207: - The spacing characters `~', `^', and tab are currently ignored,
208: see User's Guide (Second Edition) page 2 section 4.
1.184 schwarze 209: loc * exist * algo ** size * imp **
1.182 schwarze 210:
211: - Mark and lineup are parsed and ignored,
212: see User's Guide (Second Edition) page 5 section 15.
1.184 schwarze 213: loc ** exist ** algo ** size ** imp **
1.238 schwarze 214:
215: - GNU eqn converts some operators to special characters, for example,
216: input HYPHEN-MINUS becomes output \(mi, unless it is part of a
217: quoted word. mandoc(1) only does this when the operator is
218: surrounded by blanks, not when it is part of an unquoted word.
219: Also, check whether there are more such cases (e.g., +?).
220: reported by bentley@ 20 Jun 2017 02:04:29 -0600
1.252 schwarze 221: loc * exist ** algo ** size * imp *
1.182 schwarze 222:
1.239 schwarze 223: - Primes, opprime, and '
224: bentley@ Thu, 13 Jul 2017 23:14:20 -0600
225:
1.79 schwarze 226: --- missing misc features ----------------------------------------------
1.255 schwarze 227:
228: - man -ks 1,8 route; kn@ Jul 13, 2018 orally
1.159 schwarze 229:
230: - italic correction (\/) in PostScript mode
231: Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46
1.184 schwarze 232: loc ** exist ** algo * size * imp *
1.153 schwarze 233:
1.210 schwarze 234: - change the default PAGER to more -Es and use the pager
235: even for apropos title line output; req by bapt@
236: loc * exist * algo * size * imp ***
1.171 schwarze 237:
1.79 schwarze 238: - clean up escape sequence handling, creating three classes:
239: (1) fully implemented, or parsed and ignored without loss of content
240: (2) unimplemented, potentially causing loss of content
241: or serious mangling of formatting (e.g. \n) -> ERROR
242: see textproc/mgdiff(1) for nice examples
243: (3) undefined, just output the character -> perhaps WARNING
1.184 schwarze 244: loc *** exist ** algo ** size ** imp *** (parser reorg helps)
1.83 schwarze 245:
1.174 schwarze 246: - kettenis wants base roff, ms, and me Fri, 1 Jan 2010 22:13:15 +0100 (CET)
1.184 schwarze 247: loc ** exist ** algo ** size *** imp *
1.174 schwarze 248:
249: --- compatibility checks -----------------------------------------------
1.196 schwarze 250:
1.174 schwarze 251: - is .Bk implemented correctly in modern groff?
252: sobrado@ Tue, 19 Apr 2011 22:12:55 +0200
253:
1.175 schwarze 254: - compare output to Heirloom roff, Solaris roff, and
255: http://repo.or.cz/w/neatroff.git http://litcave.rudi.ir/
1.178 schwarze 256:
257: - look at AT&T DWB http://www2.research.att.com/sw/download
258: Carsten Kunze <carsten dot kunze at arcor dot de> has patches
259: Mon, 4 Aug 2014 17:01:28 +0200
1.230 schwarze 260: ported version: https://github.com/n-t-roff/DWB3.3
261: Carsten Kunze Wed, 22 Apr 2015 11:21:43 +0200
1.174 schwarze 262:
1.79 schwarze 263: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
264: These are a weird mixture of man(7) and custom autogenerated low-level
265: roff stuff. Figure out to what extent we can cope.
1.80 schwarze 266: For details, see http://docutils.sourceforge.net/rst.html
1.79 schwarze 267: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
268: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
1.160 schwarze 269:
1.174 schwarze 270: - look at pages generated from ronn(1) github.com/rtomayko/ronn
271: (based on markdown)
272:
1.160 schwarze 273: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
274: First impression is not that bad.
1.172 schwarze 275:
276: - look at pages generated by pandoc; see
277: https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
278: porting planned by kili@ Thu, 19 Jun 2014 19:46:28 +0200
1.71 schwarze 279:
280: - check compatibility with Plan9:
281: http://swtch.com/usr/local/plan9/tmac/tmac.an
282: http://swtch.com/plan9port/man/man7/man.html
283: "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63 schwarze 284:
1.207 schwarze 285: - check compatibility with COHERENT troff:
286: http://www.nesssoftware.com/home/mwc/source.php
287:
1.174 schwarze 288: - check compatibility with the man(7) formatter
289: https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
290:
1.186 schwarze 291: - check compatibility with
292: http://ikiwiki.info/plugins/contrib/mandoc/
293: https://github.com/schmonz/ikiwiki/compare/mandoc
294: Amitai Schlair Mon, 19 May 2014 14:05:53 -0400
1.295 schwarze 295:
296: - check compatibility with
297: https://git.sr.ht/~sircmpwn/scdoc
1.186 schwarze 298:
1.230 schwarze 299: - check features of the Slackware man.conf(5) format
300: Carsten Kunze Wed, 11 Mar 2015 17:57:24 +0100
301:
1.1 kristaps 302: ************************************************************************
303: * formatting issues: ugly output
304: ************************************************************************
1.87 kristaps 305:
1.195 schwarze 306: - revisit empty in-line macros
307: look at the difference between "Em x Em ." and "Sq x Em ."
308: Carsten Kunze Fri, 12 Dec 2014 00:15:41 +0100
309: loc *** exist *** algo *** size * imp **
310:
311: - a column list with blank `Ta' cells triggers a spurious
1.87 kristaps 312: start-with-whitespace printing of a newline
1.195 schwarze 313:
314: - In .Bl -column, .It a<tab>"b<tab>c"
315: shows the quotes in groff, but not in mandoc
316: loc * exist *** algo ** size * imp **
1.1 kristaps 317:
1.39 schwarze 318: - In .Bl -column,
319: .It Em Authentication<tab>Key Length
320: ought to render "Key Length" with emphasis, too,
321: see OpenBSD iked.conf(5).
1.123 schwarze 322: reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.184 schwarze 323: loc * exist *** algo *** size ** imp ***
1.39 schwarze 324:
1.1 kristaps 325: - empty phrases in .Bl column produce too few blanks
326: try e.g. .Bl -column It Ta Ta
327: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.184 schwarze 328: loc * exist *** algo *** size * imp **
1.48 schwarze 329:
1.83 schwarze 330: - .%T can have trailing punctuation. Currently, it puts the trailing
331: punctuation into a trailing MDOC_TEXT element inside its own scope.
332: That element should rather be outside its scope, such that the
333: punctuation does not get underlines. This is not trivial to
334: implement because .%T then needs some features of in_line_eoln() -
335: slurp all arguments into one single text element - and one feature
336: of in_line() - put trailing punctuation out of scope.
337: Found in mount_nfs(8) and exports(5), search for "Appendix".
1.184 schwarze 338: loc ** exist ** algo *** size * imp **
1.83 schwarze 339:
1.147 schwarze 340: - Trailing punctuation after .%T triggers EOS spacing, at least
341: outside .Rs (eek!). Simply setting ARGSFL_DELIM for .%T is not
342: the right solution, it sends mandoc into an endless loop.
343: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
1.184 schwarze 344: loc * exist ** algo ** size * imp **
1.147 schwarze 345:
1.174 schwarze 346: - global variables in the SYNOPSIS of section 3 pages
347: .Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...
348: from kristaps@ Tue, 08 Jun 2010 11:13:32 +0200
1.239 schwarze 349:
350: - implicit whitespace around inline equations
351: example code: where '$times$' denotes matrix multiplication
352: must not have an HTML line break, nor a blank, before <math>
353: partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT},
354: bentley@ Thu, 13 Jul 2017 19:00:59 -0600
1.174 schwarze 355:
1.48 schwarze 356: - in enclosures, mandoc sometimes fancies a bogus end of sentence
357: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.184 schwarze 358: loc * exist ** algo *** size * imp ***
1.197 schwarze 359:
360: - a line starting with "\fB something" counts as starting with whitespace
361: and triggers a line break; found in audio/normalize-mp3(1)
1.287 schwarze 362: This will become easier once escape sequences are represented
363: by syntax tree nodes.
1.197 schwarze 364: loc ** exist * algo ** size * imp **
1.149 schwarze 365:
366: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
367: reveals lots of bugs both in groff and mandoc...
368: reported by bentley@ Wed, 22 May 2013 23:49:30 -0600
1.171 schwarze 369:
1.230 schwarze 370: --- PostScript and PDF issues ------------------------------------------
1.171 schwarze 371:
372: - PDF output doesn't use a monospaced font for .Bd -literal
373: Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
374: Search the text "Routing tables".
375: Also check what PostScript mode does when fixing this.
376: reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
1.186 schwarze 377: instructions from juanfra@ Wed, 11 Jun 2014 02:21:01 +0200
378: add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
379: and change the /Name from /F0 to the new font (/F5 (?)).
1.230 schwarze 380: re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100
1.186 schwarze 381: loc * exist ** algo ** size * imp **
1.173 schwarze 382:
383: --- HTML issues --------------------------------------------------------
1.297 ! schwarze 384:
! 385: - get rid of the last handful of style= attributes such that
! 386: Content-Security-Policy: can be enabled without unsafe-inline
! 387: suggested by bentley@ Nov 10, 2019 at 06:02:49AM -0700
! 388: loc * exist * algo * size * imp **
1.214 schwarze 389:
390: - .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
391: space, see for example random(3). Introduced in
392: http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92
393: reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
394: loc ** exist ** algo ** size * imp *
1.180 schwarze 395:
1.187 schwarze 396: - jsg on icb, Nov 3, 2014:
397: try to guess Xr in man(7) for hyperlinking
1.226 schwarze 398: and render them with <a class="Xr" href=...>
399: https://github.com/Debian/debiman/issues/15
400: loc * exist * algo ** size ** imp **
1.296 schwarze 401:
402: - space characters can end up in href= attributes, for example coming
403: from the first .Xr argument (where they make no sense, but still);
404: does this affect other characters, other source macros...?
405: Jackson Pauls 29 Aug 2017 16:56:27 +0100
1.187 schwarze 406:
1.180 schwarze 407: - The tables used to render the three-part page headers actually force
408: the width of the <body> to the max-width given for <html>.
409: Not yet sure how to fix that...
410: Observed by an Anonymous Coward on undeadly.org:
411: http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
1.184 schwarze 412: loc * exist * algo ** size * imp ***
1.206 schwarze 413:
414: - generate <img> tags in HTML
415: idea from florian@ Tue, 7 Apr 2015 00:26:28 +0000
416: may be possible to implement with .Lk img://something.png alt_text
1.174 schwarze 417:
1.173 schwarze 418: - check https://github.com/trentm/mdocml
1.35 kristaps 419:
1.1 kristaps 420: ************************************************************************
1.104 kristaps 421: * formatting issues: gratuitous differences
1.1 kristaps 422: ************************************************************************
1.187 schwarze 423:
424: - .Fn reopens a new scope after punctuation in mandoc,
425: but closes its scope for good in groff.
426: Do we want to change mandoc or groff?
427: Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100
428: loc * exist ** algo ** size * imp **
1.230 schwarze 429:
1.174 schwarze 430: - In .Bl -enum -width 0n, groff continues one the same line after
431: the number, mandoc breaks the line.
432: mail to kristaps@ Mon, 20 Jul 2009 02:21:39 +0200
1.184 schwarze 433: loc * exist ** algo ** size * imp **
1.174 schwarze 434:
1.103 schwarze 435: - .Pp between two .It in .Bl -column should produce one,
436: not two blank lines, see e.g. login.conf(5).
437: reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059
1.129 schwarze 438: reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.184 schwarze 439: loc * exist *** algo ** size * imp **
1.39 schwarze 440:
1.83 schwarze 441: - If the *first* line after .It is .Pp, break the line right after
442: the tag, do not pad with space characters before breaking.
443: See the description of the a, c, and i commands in sed(1).
1.184 schwarze 444: loc * exist ** algo ** size * imp **
1.83 schwarze 445:
446: - If the first line after .It is .D1, do not assert a blank line
447: in between, see for example tmux(1).
448: reported by nicm@ 13 Jan 2011 00:18:57 +0000
1.184 schwarze 449: loc * exist ** algo ** size * imp **
1.147 schwarze 450:
451: - Trailing punctuation after .It should trigger EOS spacing.
452: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
453: Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.184 schwarze 454: loc * exist ** algo ** size * imp **
1.83 schwarze 455:
456: - When the -width string contains macros, the macros must be rendered
457: before measuring the width, for example
458: .Bl -tag -width ".Dv message"
459: in magic(5), located in src/usr.bin/file, is the same
460: as -width 7n, not -width 11n.
1.129 schwarze 461: The same applies to .Bl -column column widths;
462: reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157 schwarze 463: reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
1.234 schwarze 464: reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@
1.184 schwarze 465: loc *** exist *** algo *** size ** imp ***
1.157 schwarze 466: An easy partial fix would be to just skip the first word if it starts
467: with a dot, including any following white space, when measuring.
1.184 schwarze 468: loc * exist * algo * size * imp ***
1.83 schwarze 469:
1.56 schwarze 470: - The \& zero-width character counts as output.
471: That is, when it is alone on a line between two .Pp,
472: we want three blank lines, not two as in mandoc.
1.184 schwarze 473: loc ** exist ** algo ** size * imp **
1.83 schwarze 474:
1.205 schwarze 475: - Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
476: with .ps and .nf/.fi produce execessive blank lines, see libJudy
1.207 schwarze 477: and graphics/dcmtk. The parser reorg may help with this.
1.83 schwarze 478:
479: - trailing whitespace must be ignored even when followed by a font escape,
1.198 schwarze 480: see for example
1.83 schwarze 481: makes
482: \fBdig \fR
483: operate in batch mode
484: in dig(1).
1.184 schwarze 485: loc ** exist ** algo ** size * imp **
1.166 schwarze 486:
487: ************************************************************************
488: * warning issues
489: ************************************************************************
1.251 schwarze 490:
491: - warn about duplicate .Sh/.Ss heads
492: gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200
1.252 schwarze 493: loc * exist * algo * size * imp **
1.216 schwarze 494:
1.245 schwarze 495: - style message about macros inside .Bd -literal and .Dl, in particular
496: font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO)
497:
1.246 schwarze 498: - style message about mismatches between the section number in the
499: file name (if it is known) and the section number in .Dt
500: (from the mdoclint TODO)
501:
1.245 schwarze 502: - style message about NULL without .Dv (from the mdoclint TODO)
503:
504: - style message about error constants without .Er (from the mdoclint TODO)
505:
1.211 schwarze 506: - warn when .Sh or .Ss contain other macros
507: Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034
1.210 schwarze 508: loc * exist * algo * size * imp **
1.188 schwarze 509:
1.245 schwarze 510: - style message about violations of the convention
1.246 schwarze 511: .An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO)
1.245 schwarze 512:
1.188 schwarze 513: - warn about attempts to call non-callable macros
514: Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100
515: Note that formatting is inconsistent in groff.
516: .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
517: Relatively hard because the relevant code is scattered
518: all over mdoc_macro.c and all subtly different.
519: loc ** exist ** algo ** size ** imp **
1.245 schwarze 520:
1.246 schwarze 521: - warn about punctuation - e.g. ',' and ';' - at the beginning
522: of a text line, if it is likely intended to follow the preceding
523: output without intervening whitespace, in particular after a
524: macro line (from the mdoclint TODO)
1.257 schwarze 525:
526: - makewhatis -p complains about language subdirectories:
527: /usr/local/man//ru: Unknown directory part
528:
1.174 schwarze 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: ************************************************************************
545:
1.37 kristaps 546: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115 kristaps 547:
1.23 kristaps 548: ************************************************************************
549: * structural issues
550: ************************************************************************
1.221 schwarze 551:
552: - POSIX says in the documentation of sysconf(3) that PATH_MAX
553: is allowed to be so large that it is a bad idea to use it
554: for sizing static buffers. So use dynamic buffers throughout.
555: See the file test-PATH_MAX.c for details.
556: Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,
557: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624
1.67 schwarze 558:
1.241 schwarze 559: - Is it possible to further simplify ENDBODY_SPACE?
560:
1.67 schwarze 561: - Find better ways to prevent endless loops
562: in roff(7) macro and string expansion.
1.241 schwarze 563:
564: - make buffers for parsing functions const
565: christos@ via wiz@ Fri, 18 Dec 2015 17:10:01 +0100
1.186 schwarze 566:
567: - struct mparse refactoring
568: Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200
1.170 schwarze 569:
1.179 kristaps 570: ************************************************************************
571: * CGI issues
572: ************************************************************************
573:
574: - Enable HTTP compression by detecting gzip encoding and filtering
575: output through libz.
1.256 schwarze 576: - Privilege separation (see OpenSSH).
1.179 kristaps 577: - Enable caching support via HTTP 304 and If-Modified-Since.
1.181 kristaps 578:
1.192 schwarze 579: ************************************************************************
580: * to improve in the groff_mdoc(7) macros
581: ************************************************************************
1.252 schwarze 582:
583: - .Cd # arch1, arch2 in section 4 pages:
584: find better way to indicate multiple architectures, maybe:
585: allow .Dt vgafb 4 "macppc sparc64"
586: already shown as "Device Drivers Manual (macppc sparc64)"
587: for apropos, make that "vgafb(4) - macppc # sparc64" instead of "- all"
588: groff can be made to show multiple arches, too, but it is
589: tedious to do the string parsing in roff code...
590: jmc@ 23 Apr 2018 07:24:52 +0100 [man for vgafb(4)...]
591: loc ** exist ** algo * size * imp ***
1.192 schwarze 592:
593: - use uname(1) to set doc-default-operating-system at install time
594: tobimensch Mon, 1 Dec 2014 00:25:07 +0100
1.236 schwarze 595:
596: - apostrophe (39), circumflex (94), grave (96), tilde (126)
597: in manuals: \(aq, \(ha, \`, \(ti
598: Re: [Groff] ASCII Minus Sign in man Pages.
599: bentley@ 26 Apr 2017 10:02:06 -0600
600: Do we need to fix existing manuals?
601: Do we need to fix the definition of the mdoc(7) language?
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