[BACK]Return to TODO CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/TODO, Revision 1.43

1.1       kristaps    1: ************************************************************************
1.37      kristaps    2: * Official mandoc TODO.
1.43    ! kristaps    3: * $Id: TODO,v 1.42 2010/08/20 22:51:29 schwarze Exp $
1.27      kristaps    4: ************************************************************************
                      5:
                      6: ************************************************************************
1.1       kristaps    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:
1.18      schwarze   14: - fix bad block nesting involving multiple identical explicit blocks
                     15:   see the OpenBSD mdoc_macro.c 1.47 commit message
                     16:
1.1       kristaps   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:
1.28      schwarze   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:
1.1       kristaps   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.
1.22      schwarze   38:
1.1       kristaps   39: - look at bsd.lv tbl(1)
                     40:   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
1.17      schwarze   41:   also look at the mail from Thomas Klausner wiz at NetBSD
                     42:     on Wed, 2 Jun 2010 11:01:29 +0200
1.35      kristaps   43:   joerg@ has patches for this somewhere...
1.1       kristaps   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:
1.10      kristaps   51: - implement blank `Bl -column', such as
                     52:   .Bl -column
                     53:   .It foo Ta bar
                     54:   .El
1.11      kristaps   55:
                     56: - explicitly disallow nested `Bl -column', which would clobber internal
                     57:   flags defined for struct mdoc_macro
1.42      schwarze   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 ."
1.12      kristaps   65:
                     66: - set a meaningful default if no `Bl' list type is assigned
1.13      kristaps   67:
                     68: - have a blank `It' head for `Bl -tag' not puke
1.20      kristaps   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)
1.36      kristaps   73:
                     74: - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
                     75:   noted by Alex Kozlov 08/06/10 23:05
1.41      kristaps   76:
1.1       kristaps   77: ************************************************************************
                     78: * formatting issues: ugly output
                     79: ************************************************************************
1.33      schwarze   80:
1.28      schwarze   81: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29      kristaps   82:   1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1       kristaps   83:
1.39      schwarze   84: - In .Bl -column,
                     85:   .It Em Authentication<tab>Key Length
                     86:   ought to render "Key Length" with emphasis, too,
                     87:   see OpenBSD iked.conf(5).
                     88:
1.1       kristaps   89: - empty phrases in .Bl column produce too few blanks
                     90:   try e.g. .Bl -column It Ta Ta
                     91:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.35      kristaps   92:
                     93: - %A doesn't put an "and" before the final author name.
1.1       kristaps   94:
                     95: ************************************************************************
                     96: * formatting issues: gratuitious differences
                     97: ************************************************************************
                     98:
1.38      schwarze   99: - .%T should be quoted, not underlined, when .%J is also present,
                    100:   to better distinguish the contents of .%T and .%J,
                    101:   see for example OpenBSD cat(1)
                    102:
                    103: - .It ${name Ns [ selector ] Ns }
                    104:   should be "${name[selector]}" not "${name [selector]}"
                    105:   This is parsed as
                    106:   text("${name") text("[") Ns() text(selector)...
                    107:   Opening punctuation should not fall out of .Ns.
                    108:   see for example OpenBSD csh(1)
                    109:
                    110: - .%A should append the last author with " and " (if there are two)
                    111:   or ", and " (if there are more), not ", "
                    112:   see for example OpenBSD csh(1)
                    113:
                    114: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
                    115:   is just "o\bo".
                    116:   see for example OpenBSD ksh(1)
                    117:
                    118: - .No text No ) is "text )", not "text)"
                    119:   see the terrible example
                    120:     case word in [[(]  pattern [| pattern] ... ) list ;; ] ... esac
                    121:   in OpenBSD ksh(1)
                    122:
                    123: - .Sm should *not* produce as a blank line in .Bd -literal
                    124:   see for example "Brace expansion" in OpenBSD ksh(1)
                    125:
                    126: - The characters "|" and "\*(Ba" should never be bold,
                    127:   not even in the middle of a word, e.g. ".Cm b\*(Bac" in
                    128:   "mknod [-m mode] name b|c major minor"
                    129:   in OpenBSD ksh(1)
                    130:
                    131: - A bogus .Pp between two .It must not produce a double blank line,
1.39      schwarze  132:   see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
                    133:   or in DIAGNOSTICS in init(8).
                    134:
                    135: - .Bd -literal and .Bd -unfilled are *not* identical.
                    136:   In -literal, tabs are 8 spaces.
                    137:   In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
                    138:   See the CCDF_* display in OpenBSD ccdconfig(8).
                    139:
                    140: - In .Bd -unfilled, .Pp should produce one blank line, not two;
                    141:   see the ccd.conf display in OpenBSD ccdconfig(8).
                    142:
                    143: - .Nx 1.0a
                    144:   should be "NetBSD 1.0A", not "NetBSD 1.0a",
                    145:   see OpenBSD ccdconfig(8).
                    146:
                    147: - In .Bl -tag, if a tag exceeds the right margin and must be continued
                    148:   on the next line, it must be indented by -width, not width+1;
                    149:   see "rule block|pass" in OpenBSD ifconfig(8).
                    150:
                    151: - When .%T is used outside an .Rs context and with a trailing comma,
                    152:   there is no point in rendering two commata,
                    153:   see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).
                    154:
                    155: - When .%T is used outside an .Rs context and without a trailing comma,
                    156:   no comma should be rendered at all,
                    157:   see the first paragraph of the DESCRIPTION in OpenBSD exports(5).
                    158:
                    159: - Bogus .Pp before .Bl should not cause a double blank line,
                    160:   see "The route utility provides the following simple commands:"
                    161:   in OpenBSD route(8).
1.1       kristaps  162:
1.9       kristaps  163: ************************************************************************
                    164: * performance issues
                    165: ************************************************************************
                    166:
                    167: Several areas can be cleaned up to make mandoc even faster.  These are
                    168:
                    169: - improve hashing mechanism for macros (quite important: performance)
                    170:
                    171: - improve hashing mechanism for characters (not as important)
1.23      kristaps  172:
1.37      kristaps  173: - the PDF file is HUGE: this can be reduced by using relative offsets
                    174:
1.23      kristaps  175: ************************************************************************
                    176: * structural issues
                    177: ************************************************************************
1.33      schwarze  178:
                    179: - rendering frontend code can calculate widths only for plain strings,
                    180:   not for strings containing escape sequences.  For example, this
                    181:   hinders calculation of the indent required for .Nm \&[ in text(1).
                    182:   comments from kristaps@  Wed, 21 Jul 2010 23:26:08 +0200
1.38      schwarze  183:
                    184: - another example of the same problem:
                    185:   .Bl -tag -width "\eD{format}XX" -compact
                    186:   in OpenBSD ksh(1) gives the wrong width
                    187:   because "\e" is one character in groff, two in mandoc
                    188:
1.40      kristaps  189: - Now that `ds' is minimally supported, we can get rid of some
                    190:   predefined strings.  \*(C+ has already been thrown out.  Track these
                    191:   down and whack them.  Look in e.g. gcc.1 for the top-level `ds'
                    192:   invocations.  These are reproduced across most crappy GNU manuals.

CVSweb