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

Annotation of mandoc/TODO, Revision 1.34

1.1       kristaps    1: ************************************************************************
1.27      kristaps    2: * Official mandoc TODO.  May not be quite up to date.
1.34    ! kristaps    3: * $Id: TODO,v 1.33 2010/07/25 18:22:18 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.1       kristaps   43:
                     44: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
                     45:   These are a weird mixture of man(7) and custom autogenerated low-level
                     46:   roff stuff.  Figure out to what extent we can cope.
                     47:   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
                     48:   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
                     49:
1.10      kristaps   50: - implement blank `Bl -column', such as
                     51:   .Bl -column
                     52:   .It foo Ta bar
                     53:   .El
1.11      kristaps   54:
                     55: - explicitly disallow nested `Bl -column', which would clobber internal
                     56:   flags defined for struct mdoc_macro
1.12      kristaps   57:
                     58: - set a meaningful default if no `Bl' list type is assigned
1.13      kristaps   59:
                     60: - have a blank `It' head for `Bl -tag' not puke
1.20      kristaps   61:
                     62: - prohibit `Nm' from having non-text HEAD children
                     63:   (e.g., NetBSD mDNSShared/dns-sd.1)
                     64:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.10      kristaps   65:
1.1       kristaps   66: ************************************************************************
                     67: * formatting issues: ugly output
                     68: ************************************************************************
1.33      schwarze   69:
1.28      schwarze   70: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29      kristaps   71:   1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1       kristaps   72:
                     73: - empty phrases in .Bl column produce too few blanks
                     74:   try e.g. .Bl -column It Ta Ta
                     75:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
                     76:
                     77: ************************************************************************
                     78: * formatting issues: gratuitious differences
                     79: ************************************************************************
                     80:
1.19      schwarze   81: - none reported right now (yet schwarze@ knows of some)
1.1       kristaps   82:
1.9       kristaps   83: ************************************************************************
                     84: * performance issues
                     85: ************************************************************************
                     86:
                     87: Several areas can be cleaned up to make mandoc even faster.  These are
                     88:
                     89: - improve hashing mechanism for macros (quite important: performance)
                     90:
                     91: - improve hashing mechanism for characters (not as important)
1.23      kristaps   92:
                     93: ************************************************************************
                     94: * structural issues
                     95: ************************************************************************
1.33      schwarze   96:
                     97: - rendering frontend code can calculate widths only for plain strings,
                     98:   not for strings containing escape sequences.  For example, this
                     99:   hinders calculation of the indent required for .Nm \&[ in text(1).
                    100:   comments from kristaps@  Wed, 21 Jul 2010 23:26:08 +0200
                    101:

CVSweb