TODO

   1 ************************************************************************
   2 * Official mandoc TODO.
   3 * $Id: TODO,v 1.42 2010/08/20 22:51:29 schwarze Exp $
   4 ************************************************************************
   5
   6 ************************************************************************
   7 * missing features
   8 ************************************************************************
   9
  10 - explicit blocks with missing end macro should be implicitely closed
  11   at the end of the enclosing block, e.g. .Bl It (El) Sh
  12   reminded by stsp@  in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200
  13
  14 - fix bad block nesting involving multiple identical explicit blocks
  15   see the OpenBSD mdoc_macro.c 1.47 commit message
  16
  17 - .Bl -column .Xo support is missing
  18   ultimate goal:
  19   restore .Xr and .Dv to
  20   lib/libc/compat-43/sigvec.3
  21   lib/libc/gen/signal.3
  22   lib/libc/sys/sigaction.2
  23
  24 - edge case: decide how to deal with blk_full bad nesting, e.g.
  25   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
  26   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
  27
  28 - auto-Bk in the SYNOPSIS
  29   patch from kristaps@  Fri, 16 Jul 2010 14:51:24 +0200
  30   to be revisited after OpenBSD 4.8 tree unlock
  31
  32 - implement \\
  33   in plain text, identical to \e
  34   as a macro argument, identical to \ i.e. escaping the next character
  35   We do not have macro definitions yet; if we implement them,
  36   \\ must behave in a macro def like in a macro argument,
  37   and when using the macro, it must expand yet again.
  38
  39 - look at bsd.lv tbl(1)
  40   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
  41   also look at the mail from Thomas Klausner wiz at NetBSD
  42     on Wed, 2 Jun 2010 11:01:29 +0200
  43   joerg@ has patches for this somewhere...
  44
  45 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
  46   These are a weird mixture of man(7) and custom autogenerated low-level
  47   roff stuff.  Figure out to what extent we can cope.
  48   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
  49   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
  50
  51 - implement blank `Bl -column', such as
  52   .Bl -column
  53   .It foo Ta bar
  54   .El
  55
  56 - explicitly disallow nested `Bl -column', which would clobber internal
  57   flags defined for struct mdoc_macro
  58
  59 - inside `.Bl -column' phrases, punctuation is handled like normal
  60   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
  61
  62 - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
  63   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
  64   but should give "ab ."
  65
  66 - set a meaningful default if no `Bl' list type is assigned
  67
  68 - have a blank `It' head for `Bl -tag' not puke
  69
  70 - prohibit `Nm' from having non-text HEAD children
  71   (e.g., NetBSD mDNSShared/dns-sd.1)
  72   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
  73
  74 - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
  75   noted by Alex Kozlov 08/06/10 23:05
  76
  77 - 'br\} doesn't correctly close scope.
  78   Noted by joerg@, 28/7/2010.
  79
  80 ************************************************************************
  81 * formatting issues: ugly output
  82 ************************************************************************
  83
  84 - perl(1) SYNOPSIS looks bad; reported by deraadt@
  85   1) man(7) seems to need SYNOPSIS .Nm blocks, too
  86
  87 - In .Bl -column,
  88   .It Em Authentication<tab>Key Length
  89   ought to render "Key Length" with emphasis, too,
  90   see OpenBSD iked.conf(5).
  91
  92 - empty phrases in .Bl column produce too few blanks
  93   try e.g. .Bl -column It Ta Ta
  94   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
  95
  96 - %A doesn't put an "and" before the final author name.
  97
  98 ************************************************************************
  99 * formatting issues: gratuitious differences
 100 ************************************************************************
 101
 102 - .%T should be quoted, not underlined, when .%J is also present,
 103   to better distinguish the contents of .%T and .%J,
 104   see for example OpenBSD cat(1)
 105
 106 - .It ${name Ns [ selector ] Ns }
 107   should be "${name[selector]}" not "${name [selector]}"
 108   This is parsed as
 109   text("${name") text("[") Ns() text(selector)...
 110   Opening punctuation should not fall out of .Ns.
 111   see for example OpenBSD csh(1)
 112
 113 - .%A should append the last author with " and " (if there are two)
 114   or ", and " (if there are more), not ", "
 115   see for example OpenBSD csh(1)
 116
 117 - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
 118   is just "o\bo".
 119   see for example OpenBSD ksh(1)
 120
 121 - .No text No ) is "text )", not "text)"
 122   see the terrible example
 123     case word in [[(]  pattern [| pattern] ... ) list ;; ] ... esac
 124   in OpenBSD ksh(1)
 125
 126 - .Sm should *not* produce as a blank line in .Bd -literal
 127   see for example "Brace expansion" in OpenBSD ksh(1)
 128
 129 - The characters "|" and "\*(Ba" should never be bold,
 130   not even in the middle of a word, e.g. ".Cm b\*(Bac" in
 131   "mknod [-m mode] name b|c major minor"
 132   in OpenBSD ksh(1)
 133
 134 - A bogus .Pp between two .It must not produce a double blank line,
 135   see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
 136   or in DIAGNOSTICS in init(8).
 137
 138 - .Bd -literal and .Bd -unfilled are *not* identical.
 139   In -literal, tabs are 8 spaces.
 140   In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
 141   See the CCDF_* display in OpenBSD ccdconfig(8).
 142
 143 - In .Bd -unfilled, .Pp should produce one blank line, not two;
 144   see the ccd.conf display in OpenBSD ccdconfig(8).
 145
 146 - .Nx 1.0a
 147   should be "NetBSD 1.0A", not "NetBSD 1.0a",
 148   see OpenBSD ccdconfig(8).
 149
 150 - In .Bl -tag, if a tag exceeds the right margin and must be continued
 151   on the next line, it must be indented by -width, not width+1;
 152   see "rule block|pass" in OpenBSD ifconfig(8).
 153
 154 - When .%T is used outside an .Rs context and with a trailing comma,
 155   there is no point in rendering two commata,
 156   see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).
 157
 158 - When .%T is used outside an .Rs context and without a trailing comma,
 159   no comma should be rendered at all,
 160   see the first paragraph of the DESCRIPTION in OpenBSD exports(5).
 161
 162 - Bogus .Pp before .Bl should not cause a double blank line,
 163   see "The route utility provides the following simple commands:"
 164   in OpenBSD route(8).
 165
 166 ************************************************************************
 167 * performance issues
 168 ************************************************************************
 169
 170 Several areas can be cleaned up to make mandoc even faster.  These are
 171
 172 - improve hashing mechanism for macros (quite important: performance)
 173
 174 - improve hashing mechanism for characters (not as important)
 175
 176 - the PDF file is HUGE: this can be reduced by using relative offsets
 177
 178 ************************************************************************
 179 * structural issues
 180 ************************************************************************
 181
 182 - rendering frontend code can calculate widths only for plain strings,
 183   not for strings containing escape sequences.  For example, this
 184   hinders calculation of the indent required for .Nm \&[ in text(1).
 185   comments from kristaps@  Wed, 21 Jul 2010 23:26:08 +0200
 186
 187 - another example of the same problem:
 188   .Bl -tag -width "\eD{format}XX" -compact
 189   in OpenBSD ksh(1) gives the wrong width
 190   because "\e" is one character in groff, two in mandoc
 191
 192 - Now that `ds' is minimally supported, we can get rid of some
 193   predefined strings.  \*(C+ has already been thrown out.  Track these
 194   down and whack them.  Look in e.g. gcc.1 for the top-level `ds'
 195   invocations.  These are reproduced across most crappy GNU manuals.