TODO

   1 ************************************************************************
   2 * Official mandoc TODO.
   3 * $Id: TODO,v 1.72 2011/01/03 21:53:46 kristaps 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 - pod2man expects `tr' to be implemented for \*(-- to work
  26
  27 - explicit blocks with missing end macro should be implicitely closed
  28   at the end of the enclosing block, e.g. .Bl It (El) Sh
  29   reminded by stsp@  in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200
  30
  31 - fix bad block nesting involving multiple identical explicit blocks
  32   see the OpenBSD mdoc_macro.c 1.47 commit message
  33
  34 - .Bl -column .Xo support is missing
  35   ultimate goal:
  36   restore .Xr and .Dv to
  37   lib/libc/compat-43/sigvec.3
  38   lib/libc/gen/signal.3
  39   lib/libc/sys/sigaction.2
  40
  41 - edge case: decide how to deal with blk_full bad nesting, e.g.
  42   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
  43   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
  44
  45 - auto-Bk in the SYNOPSIS
  46   patch from kristaps@  Fri, 16 Jul 2010 14:51:24 +0200
  47   to be revisited after OpenBSD 4.8 tree unlock
  48
  49 - implement \\
  50   in plain text, identical to \e
  51   as a macro argument, identical to \ i.e. escaping the next character
  52   We do not have macro definitions yet; if we implement them,
  53   \\ must behave in a macro def like in a macro argument,
  54   and when using the macro, it must expand yet again.
  55
  56 - implement basic non-parametric .de to support e.g. sox(1)
  57   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
  58   *** sox(1) still doesn't work, tbl(1) errors need investigation
  59
  60 - clean up escape sequence handling, creating three classes:
  61   (1) fully implemented, or parsed and ignored without loss of content
  62   (2) unimplemented, potentially causing loss of content
  63       or serious mangling of formatting (e.g. \n) -> ERROR
  64       see textproc/mgdiff(1) for nice examples
  65   (3) undefined, just output the character -> perhaps WARNING
  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 - xloadimage(1) wants .ti (temporary indent), rep by naddy@
  97
  98 - bashbug(1) complains "line scope broken" after
  99   .SM
 100   .B something
 101   should either just work or be a warning
 102   reported by naddy@
 103
 104 - check compatibility with Plan9:
 105   http://swtch.com/usr/local/plan9/tmac/tmac.an
 106   http://swtch.com/plan9port/man/man7/man.html
 107   "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
 108
 109 ************************************************************************
 110 * formatting issues: ugly output
 111 ************************************************************************
 112
 113 - double quotes inside double quotes are escaped by doubling them
 114   implement this in man(7) and mdoc(7)
 115   reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
 116
 117 - perl(1) SYNOPSIS looks bad; reported by deraadt@
 118   1) man(7) seems to need SYNOPSIS .Nm blocks, too
 119
 120 - In .Bl -column,
 121   .It Em Authentication<tab>Key Length
 122   ought to render "Key Length" with emphasis, too,
 123   see OpenBSD iked.conf(5).
 124
 125 - empty phrases in .Bl column produce too few blanks
 126   try e.g. .Bl -column It Ta Ta
 127   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
 128
 129 - in enclosures, mandoc sometimes fancies a bogus end of sentence
 130   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
 131
 132 ************************************************************************
 133 * formatting issues: gratuitious differences
 134 ************************************************************************
 135
 136 - .Rv (and probably .Ex) print different text if an `Nm' has been named
 137   or not (run a manual without `Nm blah' to see this).  I'm not sure
 138   that this exists in the wild, but it's still an error.
 139
 140 - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
 141   is just "o\bo".
 142   see for example OpenBSD ksh(1)
 143
 144 - The characters "|" and "\*(Ba" should never be bold,
 145   not even in the middle of a word, e.g. ".Cm b\*(Bac" in
 146   "mknod [-m mode] name b|c major minor"
 147   in OpenBSD ksh(1)
 148
 149 - A bogus .Pp between two .It must not produce a double blank line,
 150   see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
 151   or in DIAGNOSTICS in init(8).
 152   Also have `It' complain if `Pp' is invoked at certain times (not
 153   -compact?).
 154
 155 - .Bd -literal and .Bd -unfilled are *not* identical.
 156   In -literal, tabs are 8 spaces.
 157   In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
 158   See the CCDF_* display in OpenBSD ccdconfig(8).
 159
 160 - .Nx 1.0a
 161   should be "NetBSD 1.0A", not "NetBSD 1.0a",
 162   see OpenBSD ccdconfig(8).
 163
 164 - In .Bl -tag, if a tag exceeds the right margin and must be continued
 165   on the next line, it must be indented by -width, not width+1;
 166   see "rule block|pass" in OpenBSD ifconfig(8).
 167
 168 - The \& zero-width character counts as output.
 169   That is, when it is alone on a line between two .Pp,
 170   we want three blank lines, not two as in mandoc.
 171
 172 - When .Fn arguments exceed one output line, all but the first
 173   should be indented, see e.g. rpc(3);
 174   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
 175
 176 - It seems that .TP does not want TWOSPACE after the tag;
 177   see bashbug(1); reported by naddy@
 178
 179 - Header lines of excessive length:
 180   Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
 181   and document it in mdoc(7) and man(7) COMPATIBILITY
 182   found while talking to Chris Bennett
 183
 184 ************************************************************************
 185 * performance issues
 186 ************************************************************************
 187
 188 Several areas can be cleaned up to make mandoc even faster.  These are
 189
 190 - improve hashing mechanism for macros (quite important: performance)
 191
 192 - improve hashing mechanism for characters (not as important)
 193
 194 - the PDF file is HUGE: this can be reduced by using relative offsets
 195
 196 ************************************************************************
 197 * structural issues
 198 ************************************************************************
 199
 200 - Find better ways to prevent endless loops
 201   in roff(7) macro and string expansion.
 202