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