TODO

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