TODO

   1 ************************************************************************
   2 * Official mandoc TODO.
   3 * $Id: TODO,v 1.67 2010/12/09 23:44:39 schwarze Exp $
   4 ************************************************************************
   5
   6 ************************************************************************
   7 * parser bugs
   8 ************************************************************************
   9
  10 - the roff parser doesn't tolerate additional characters between
  11   a macro and the \} terminating a conditional block, e.g.
  12   .if n \{
  13   .br \}
  14   reported by ulrich spoerlein  Tue, 19 Oct 2010 20:39:50 +0200
  15
  16 - .BI "string string " word punct in gettext(3)
  17   add bogus line breaks (rep by naddy@)
  18   committed; currently working on IP and TP?
  19   and what about B and I?
  20
  21 ************************************************************************
  22 * missing features
  23 ************************************************************************
  24
  25 - explicit blocks with missing end macro should be implicitely closed
  26   at the end of the enclosing block, e.g. .Bl It (El) Sh
  27   reminded by stsp@  in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200
  28
  29 - fix bad block nesting involving multiple identical explicit blocks
  30   see the OpenBSD mdoc_macro.c 1.47 commit message
  31
  32 - .Bl -column .Xo support is missing
  33   ultimate goal:
  34   restore .Xr and .Dv to
  35   lib/libc/compat-43/sigvec.3
  36   lib/libc/gen/signal.3
  37   lib/libc/sys/sigaction.2
  38
  39 - edge case: decide how to deal with blk_full bad nesting, e.g.
  40   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
  41   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
  42
  43 - auto-Bk in the SYNOPSIS
  44   patch from kristaps@  Fri, 16 Jul 2010 14:51:24 +0200
  45   to be revisited after OpenBSD 4.8 tree unlock
  46
  47 - implement \\
  48   in plain text, identical to \e
  49   as a macro argument, identical to \ i.e. escaping the next character
  50   We do not have macro definitions yet; if we implement them,
  51   \\ must behave in a macro def like in a macro argument,
  52   and when using the macro, it must expand yet again.
  53
  54 - implement basic non-parametric .de to support e.g. sox(1)
  55   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
  56   *** sox(1) still doesn't work, tbl(1) errors need investigation
  57
  58 - clean up escape sequence handling, creating three classes:
  59   (1) fully implemented, or parsed and ignored without loss of content
  60   (2) unimplemented, potentially causing loss of content
  61       or serious mangling of formatting (e.g. \n) -> ERROR
  62       see textproc/mgdiff(1) for nice examples
  63   (3) undefined, just output the character -> perhaps WARNING
  64
  65 - port OpenBSD tbl integration bsd.lv, probably cleaning it up
  66
  67 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
  68   These are a weird mixture of man(7) and custom autogenerated low-level
  69   roff stuff.  Figure out to what extent we can cope.
  70   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
  71   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
  72
  73 - implement blank `Bl -column', such as
  74   .Bl -column
  75   .It foo Ta bar
  76   .El
  77
  78 - explicitly disallow nested `Bl -column', which would clobber internal
  79   flags defined for struct mdoc_macro
  80
  81 - inside `.Bl -column' phrases, punctuation is handled like normal
  82   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
  83
  84 - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
  85   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
  86   but should give "ab ."
  87
  88 - set a meaningful default if no `Bl' list type is assigned
  89
  90 - have a blank `It' head for `Bl -tag' not puke
  91
  92 - prohibit `Nm' from having non-text HEAD children
  93   (e.g., NetBSD mDNSShared/dns-sd.1)
  94   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
  95
  96 - Have `Sh', `It', `Ss' and others complain if `Pp' is invoked prior to
  97   close (in the post validation) or prior to open (pre).  This noted by
  98   jmc@ a thousand years ago.
  99
 100 - xloadimage(1) wants .ti (temporary indent), rep by naddy@
 101
 102 - bashbug(1) complains "line scope broken" after
 103   .SM
 104   .B something
 105   should either just work or be a warning
 106   reported by naddy@
 107
 108 ************************************************************************
 109 * formatting issues: ugly output
 110 ************************************************************************
 111
 112 - double quotes inside double quotes are escaped by doubling them
 113   implement this in man(7) and mdoc(7)
 114   reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
 115
 116 - perl(1) SYNOPSIS looks bad; reported by deraadt@
 117   1) man(7) seems to need SYNOPSIS .Nm blocks, too
 118
 119 - In .Bl -column,
 120   .It Em Authentication<tab>Key Length
 121   ought to render "Key Length" with emphasis, too,
 122   see OpenBSD iked.conf(5).
 123
 124 - empty phrases in .Bl column produce too few blanks
 125   try e.g. .Bl -column It Ta Ta
 126   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
 127
 128 - in enclosures, mandoc sometimes fancies a bogus end of sentence
 129   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
 130
 131 ************************************************************************
 132 * formatting issues: gratuitious differences
 133 ************************************************************************
 134
 135 - .Rv (and probably .Ex) print different text if an `Nm' has been named
 136   or not (run a manual without `Nm blah' to see this).  I'm not sure
 137   that this exists in the wild, but it's still an error.
 138
 139 - .%T should be quoted, not underlined, when .%J is also present,
 140   to better distinguish the contents of .%T and .%J,
 141   see for example OpenBSD cat(1)
 142
 143 - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
 144   is just "o\bo".
 145   see for example OpenBSD ksh(1)
 146
 147 - The characters "|" and "\*(Ba" should never be bold,
 148   not even in the middle of a word, e.g. ".Cm b\*(Bac" in
 149   "mknod [-m mode] name b|c major minor"
 150   in OpenBSD ksh(1)
 151
 152 - A bogus .Pp between two .It must not produce a double blank line,
 153   see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
 154   or in DIAGNOSTICS in init(8).
 155
 156 - .Bd -literal and .Bd -unfilled are *not* identical.
 157   In -literal, tabs are 8 spaces.
 158   In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
 159   See the CCDF_* display in OpenBSD ccdconfig(8).
 160
 161 - .Nx 1.0a
 162   should be "NetBSD 1.0A", not "NetBSD 1.0a",
 163   see OpenBSD ccdconfig(8).
 164
 165 - In .Bl -tag, if a tag exceeds the right margin and must be continued
 166   on the next line, it must be indented by -width, not width+1;
 167   see "rule block|pass" in OpenBSD ifconfig(8).
 168
 169 - The \& zero-width character counts as output.
 170   That is, when it is alone on a line between two .Pp,
 171   we want three blank lines, not two as in mandoc.
 172
 173 - When .Fn arguments exceed one output line, all but the first
 174   should be indented, see e.g. rpc(3);
 175   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
 176
 177 - It seems that .TP does not want TWOSPACE after the tag;
 178   see bashbug(1); reported by naddy@
 179
 180 - Header lines of excessive length:
 181   Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
 182   and document it in mdoc(7) and man(7) COMPATIBILITY
 183   found while talking to Chris Bennett
 184
 185 ************************************************************************
 186 * performance issues
 187 ************************************************************************
 188
 189 Several areas can be cleaned up to make mandoc even faster.  These are
 190
 191 - improve hashing mechanism for macros (quite important: performance)
 192
 193 - improve hashing mechanism for characters (not as important)
 194
 195 - the PDF file is HUGE: this can be reduced by using relative offsets
 196
 197 ************************************************************************
 198 * structural issues
 199 ************************************************************************
 200
 201 - Find better ways to prevent endless loops
 202   in roff(7) macro and string expansion.
 203