TODO

   1 ************************************************************************
   2 * Official mandoc TODO.
   3 * $Id: TODO,v 1.147 2012/11/18 00:05:35 schwarze Exp $
   4 ************************************************************************
   5
   6 ************************************************************************
   7 * crashes
   8 ************************************************************************
   9
  10 - $ echo ".Ta" >> ls.1
  11   $ mandoc ls.1
  12   assertion "MDOC_BLOCK == p->parent->type" failed:
  13   file "/usr/src/usr.bin/mandoc/mdoc.c", line 399, function "node_append"
  14   from jmc@  Thu, 20 Sep 2012 21:35:58 +0059
  15
  16 ************************************************************************
  17 * missing features
  18 ************************************************************************
  19
  20 --- missing roff features ----------------------------------------------
  21
  22 - roff.c should treat \n(.H>23 and \n(.V>19 in the pod2man(1)
  23   preamble as true, see for example AUTHORS in MooseX::Getopt.3p
  24   reported by Andreas Voegele <mail at andreasvoegele dot com>
  25   Tue, 22 Nov 2011 15:34:47 +0100 on ports@
  26
  27 - .ad (adjust margins)
  28   .ad l -- adjust left margin only (flush left)
  29   .ad r -- adjust right margin only (flush right)
  30   .ad c -- center text on line
  31   .ad b -- adjust both margins (alias: .ad n)
  32   .na   -- temporarily disable adjustment without changing the mode
  33   .ad   -- re-enable adjustment without changing the mode
  34   Adjustment mode is ignored while in no-fill mode (.nf).
  35
  36 - .it (line traps) occur in mysql(1), yasm_arch(7)
  37   generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  38   reported by brad@  Sat, 15 Jan 2011 15:48:18 -0500
  39
  40 - .ns (no-space mode) occurs in xine-config(1)
  41   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
  42
  43 - xloadimage(1) wants .ti (temporary indent), rep by naddy@
  44   reported again by bentley@ in nmh(1)  Mon, 23 Apr 2012 13:38:28 -0600
  45   also uses .ce (center N lines) and .fc (field control)
  46
  47 - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
  48   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
  49
  50 - \c (interrupted text) should prevent the line break
  51   even inside .Bd literal; that occurs in chat(8)
  52
  53 - using undefined strings or macros defines them to be empty
  54   wl@  Mon, 14 Nov 2011 14:37:01 +0000
  55
  56 --- missing mdoc features ----------------------------------------------
  57
  58 - fix bad block nesting involving multiple identical explicit blocks
  59   see the OpenBSD mdoc_macro.c 1.47 commit message
  60
  61 - .Bl -column .Xo support is missing
  62   ultimate goal:
  63   restore .Xr and .Dv to
  64   lib/libc/compat-43/sigvec.3
  65   lib/libc/gen/signal.3
  66   lib/libc/sys/sigaction.2
  67
  68 - edge case: decide how to deal with blk_full bad nesting, e.g.
  69   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
  70   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
  71
  72 - \\ is now implemented correctly
  73   * when defining strings and macros using .ds and .de
  74   * when parsing roff(7) and man(7) macro arguments
  75   It does not yet work in mdoc(7) macro arguments
  76   because libmdoc does not yet use mandoc_getarg().
  77   Also check what happens in plain text, it must be identical to \e.
  78
  79 - .Bd -filled should not be the same as .Bd -ragged, but align both
  80   the left and right margin.  In groff, it is implemented in terms
  81   of .ad b, which we don't have either.  Found in cksum(1).
  82
  83 - implement blank `Bl -column', such as
  84   .Bl -column
  85   .It foo Ta bar
  86   .El
  87
  88 - explicitly disallow nested `Bl -column', which would clobber internal
  89   flags defined for struct mdoc_macro
  90
  91 - In .Bl -column .It, the end of the line probably has to be regarded
  92   as an implicit .Ta, if there could be one, see the following mildly
  93   ugly code from login.conf(5):
  94     .Bl -column minpasswordlen program xetcxmotd
  95     .It path Ta path Ta value of Dv _PATH_DEFPATH
  96     .br
  97     Default search path.
  98   reported by Michal Mazurek <akfaew at jasminek dot net>
  99   via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
 100
 101 - inside `.Bl -column' phrases, punctuation is handled like normal
 102   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
 103
 104 - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
 105   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
 106   but should give "ab ."
 107
 108 - set a meaningful default if no `Bl' list type is assigned
 109
 110 - have a blank `It' head for `Bl -tag' not puke
 111
 112 - prohibit `Nm' from having non-text HEAD children
 113   (e.g., NetBSD mDNSShared/dns-sd.1)
 114   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
 115
 116 - When there is free text in the SYNOPSIS and that free text contains
 117   the .Nm macro, groff somehow understands to treat the .Nm as an in-line
 118   macro, while mandoc treats it as a block macro and breaks the line.
 119   No idea how the logic for distinguishing in-line and block instances
 120   should be, needs investigation.
 121   uqs@  Thu, 2 Jun 2011 11:03:51 +0200
 122   uqs@  Thu, 2 Jun 2011 11:33:35 +0200
 123
 124 --- missing man features -----------------------------------------------
 125
 126 - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
 127   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
 128   also occur in freeciv-client(6) freeciv-server(6) freeciv-modpack(6)
 129   reported by bentley@  Tue, 30 Oct 2012 01:05:57 -0600
 130
 131 - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
 132
 133 --- missing tbl features -----------------------------------------------
 134
 135 - implement basic non-parametric .de to support e.g. sox(1)
 136   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
 137   *** sox(1) still doesn't work, tbl(1) errors need investigation
 138
 139 - allow standalone `.' to be interpreted as an end-of-layout
 140   delimiter instead of being thrown away as a no-op roff line
 141   reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
 142
 143 --- missing misc features ----------------------------------------------
 144
 145 - clean up escape sequence handling, creating three classes:
 146   (1) fully implemented, or parsed and ignored without loss of content
 147   (2) unimplemented, potentially causing loss of content
 148       or serious mangling of formatting (e.g. \n) -> ERROR
 149       see textproc/mgdiff(1) for nice examples
 150   (3) undefined, just output the character -> perhaps WARNING
 151
 152 - The \t escape sequence is the same as a literal tab, see for example
 153   the ASCII table in hexdump(1) where
 154     .Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo
 155     .It \&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq
 156   produces
 157     000 nul  001 soh  002 stx  003 etx  004 eot  005 enq
 158   and the example in oldrdist(1)
 159
 160 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
 161   These are a weird mixture of man(7) and custom autogenerated low-level
 162   roff stuff.  Figure out to what extent we can cope.
 163   For details, see http://docutils.sourceforge.net/rst.html
 164   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
 165   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
 166
 167 - check compatibility with Plan9:
 168   http://swtch.com/usr/local/plan9/tmac/tmac.an
 169   http://swtch.com/plan9port/man/man7/man.html
 170   "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
 171
 172 ************************************************************************
 173 * formatting issues: ugly output
 174 ************************************************************************
 175
 176 - a column list with blank `Ta' cells triggers a spurrious
 177   start-with-whitespace printing of a newline
 178
 179 - double quotes inside double quotes are escaped by doubling them
 180   implement this in mdoc(7), too
 181   so far, we only have it in roff(7) and man(7)
 182   reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
 183
 184 - In .Bl -column,
 185   .It Em Authentication<tab>Key Length
 186   ought to render "Key Length" with emphasis, too,
 187   see OpenBSD iked.conf(5).
 188   reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
 189
 190 - empty phrases in .Bl column produce too few blanks
 191   try e.g. .Bl -column It Ta Ta
 192   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
 193
 194 - .%T can have trailing punctuation.  Currently, it puts the trailing
 195   punctuation into a trailing MDOC_TEXT element inside its own scope.
 196   That element should rather be outside its scope, such that the
 197   punctuation does not get underlines.  This is not trivial to
 198   implement because .%T then needs some features of in_line_eoln() -
 199   slurp all arguments into one single text element - and one feature
 200   of in_line() - put trailing punctuation out of scope.
 201   Found in mount_nfs(8) and exports(5), search for "Appendix".
 202
 203 - Trailing punctuation after .%T triggers EOS spacing, at least
 204   outside .Rs (eek!).  Simply setting ARGSFL_DELIM for .%T is not
 205   the right solution, it sends mandoc into an endless loop.
 206   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
 207
 208 - in enclosures, mandoc sometimes fancies a bogus end of sentence
 209   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
 210
 211 ************************************************************************
 212 * formatting issues: gratuitous differences
 213 ************************************************************************
 214
 215 - .Rv (and probably .Ex) print different text if an `Nm' has been named
 216   or not (run a manual without `Nm blah' to see this).  I'm not sure
 217   that this exists in the wild, but it's still an error.
 218
 219 - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
 220   is just "o\bo".
 221   see for example OpenBSD ksh(1)
 222
 223 - .Pp between two .It in .Bl -column should produce one,
 224   not two blank lines, see e.g. login.conf(5).
 225   reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
 226   reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
 227
 228 - If the *first* line after .It is .Pp, break the line right after
 229   the tag, do not pad with space characters before breaking.
 230   See the description of the a, c, and i commands in sed(1).
 231
 232 - If the first line after .It is .D1, do not assert a blank line
 233   in between, see for example tmux(1).
 234   reported by nicm@  13 Jan 2011 00:18:57 +0000
 235
 236 - Trailing punctuation after .It should trigger EOS spacing.
 237   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
 238   Probably, this should be fixed somewhere in termp_it_pre(), not sure.
 239
 240 - .Nx 1.0a
 241   should be "NetBSD 1.0A", not "NetBSD 1.0a",
 242   see OpenBSD ccdconfig(8).
 243
 244 - In .Bl -tag, if a tag exceeds the right margin and must be continued
 245   on the next line, it must be indented by -width, not width+1;
 246   see "rule block|pass" in OpenBSD ifconfig(8).
 247
 248 - When the -width string contains macros, the macros must be rendered
 249   before measuring the width, for example
 250     .Bl -tag -width ".Dv message"
 251   in magic(5), located in src/usr.bin/file, is the same
 252   as -width 7n, not -width 11n.
 253   The same applies to .Bl -column column widths;
 254   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
 255
 256 - The \& zero-width character counts as output.
 257   That is, when it is alone on a line between two .Pp,
 258   we want three blank lines, not two as in mandoc.
 259
 260 - When .Fn arguments exceed one output line, all but the first
 261   should be indented, see e.g. rpc(3);
 262   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
 263   reported again by Nicolas Joly via wiz@  Sun, 18 Sep 2011 18:24:40 +0200
 264   Also, we don't want to break the line within the argument of:
 265   .Fa "chtype tl"
 266
 267 - Header lines of excessive length:
 268   Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
 269   and document it in mdoc(7) and man(7) COMPATIBILITY
 270   found while talking to Chris Bennett
 271
 272 - trailing whitespace must be ignored even when followed by a font escape,
 273   see for example
 274     makes
 275     \fBdig \fR
 276     operate in batch mode
 277   in dig(1).
 278
 279 ************************************************************************
 280 * performance issues
 281 ************************************************************************
 282
 283 Several areas can be cleaned up to make mandoc even faster.  These are
 284
 285 - improve hashing mechanism for macros (quite important: performance)
 286
 287 - improve hashing mechanism for characters (not as important)
 288
 289 - the PDF file is HUGE: this can be reduced by using relative offsets
 290
 291 - instead of re-initialising the roff predefined-strings set before each
 292   parse, create a read-only version the first time and copy it
 293
 294 ************************************************************************
 295 * structural issues
 296 ************************************************************************
 297
 298 - We use the input line number at several places to distinguish
 299   same-line from different-line input.  That plainly doesn't work
 300   with user-defined macros, leading to random breakage.
 301
 302 - Find better ways to prevent endless loops
 303   in roff(7) macro and string expansion.
 304
 305 - Finish cleanup of date handling.
 306   Decide which formats should be recognized where.
 307   Update both mdoc(7) and man(7) documentation.
 308   Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100