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

Annotation of mandoc/TODO, Revision 1.166

1.1       kristaps    1: ************************************************************************
1.37      kristaps    2: * Official mandoc TODO.
1.166   ! schwarze    3: * $Id: TODO,v 1.165 2014/02/14 23:24:26 schwarze Exp $
1.27      kristaps    4: ************************************************************************
1.145     schwarze    5:
                      6: ************************************************************************
                      7: * crashes
                      8: ************************************************************************
                      9:
1.158     schwarze   10: None known.
1.101     schwarze   11:
1.61      schwarze   12: ************************************************************************
1.1       kristaps   13: * missing features
                     14: ************************************************************************
1.70      kristaps   15:
1.79      schwarze   16: --- missing roff features ----------------------------------------------
                     17:
1.82      schwarze   18: - .ad (adjust margins)
                     19:   .ad l -- adjust left margin only (flush left)
                     20:   .ad r -- adjust right margin only (flush right)
                     21:   .ad c -- center text on line
                     22:   .ad b -- adjust both margins (alias: .ad n)
                     23:   .na   -- temporarily disable adjustment without changing the mode
                     24:   .ad   -- re-enable adjustment without changing the mode
                     25:   Adjustment mode is ignored while in no-fill mode (.nf).
1.150     schwarze   26:
                     27: - .fc (field control)
                     28:   found by naddy@ in xloadimage(1)
                     29:
1.159     schwarze   30: - .ll (line length)
                     31:   found by naddy@ in textproc/enchant(1)  Sat, 12 Oct 2013 03:27:10 +0200
                     32:
1.160     schwarze   33: - .nr third argument (auto-increment step size, requires \n+)
                     34:   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
                     35:
1.80      schwarze   36: - .ns (no-space mode) occurs in xine-config(1)
                     37:   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
1.61      schwarze   38:
1.81      schwarze   39: - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
                     40:   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
1.150     schwarze   41:
                     42: - .ti (temporary indent)
                     43:   found by naddy@ in xloadimage(1)
                     44:   found by bentley@ in nmh(1)  Mon, 23 Apr 2012 13:38:28 -0600
1.154     schwarze   45:
                     46: - .while and .shift
                     47:   found by jca@ in ratpoison(1)  Sun, 30 Jun 2013 12:01:09 +0200
1.79      schwarze   48:
1.132     schwarze   49: - \c (interrupted text) should prevent the line break
                     50:   even inside .Bd literal; that occurs in chat(8)
1.155     schwarze   51:   also found in cclive(1) - DocBook output
                     52:
                     53: - \h horizontal move
                     54:   found in cclive(1) DocBook output
                     55:   Anthony J. Bentley on discuss@  Sat, 21 Sep 2013 22:29:34 -0600
1.125     schwarze   56:
1.160     schwarze   57: - \n+ and \n- numerical register increment and decrement
                     58:   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
                     59:
1.125     schwarze   60: - using undefined strings or macros defines them to be empty
                     61:   wl@  Mon, 14 Nov 2011 14:37:01 +0000
1.98      schwarze   62:
1.79      schwarze   63: --- missing mdoc features ----------------------------------------------
                     64:
1.18      schwarze   65: - fix bad block nesting involving multiple identical explicit blocks
                     66:   see the OpenBSD mdoc_macro.c 1.47 commit message
                     67:
1.1       kristaps   68: - .Bl -column .Xo support is missing
                     69:   ultimate goal:
                     70:   restore .Xr and .Dv to
                     71:   lib/libc/compat-43/sigvec.3
                     72:   lib/libc/gen/signal.3
                     73:   lib/libc/sys/sigaction.2
                     74:
1.28      schwarze   75: - edge case: decide how to deal with blk_full bad nesting, e.g.
                     76:   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
                     77:   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
                     78:
1.74      schwarze   79: - \\ is now implemented correctly
                     80:   * when defining strings and macros using .ds and .de
                     81:   * when parsing roff(7) and man(7) macro arguments
                     82:   It does not yet work in mdoc(7) macro arguments
                     83:   because libmdoc does not yet use mandoc_getarg().
                     84:   Also check what happens in plain text, it must be identical to \e.
1.82      schwarze   85:
                     86: - .Bd -filled should not be the same as .Bd -ragged, but align both
                     87:   the left and right margin.  In groff, it is implemented in terms
                     88:   of .ad b, which we don't have either.  Found in cksum(1).
1.22      schwarze   89:
1.10      kristaps   90: - implement blank `Bl -column', such as
                     91:   .Bl -column
                     92:   .It foo Ta bar
                     93:   .El
1.11      kristaps   94:
                     95: - explicitly disallow nested `Bl -column', which would clobber internal
                     96:   flags defined for struct mdoc_macro
1.102     schwarze   97:
                     98: - In .Bl -column .It, the end of the line probably has to be regarded
                     99:   as an implicit .Ta, if there could be one, see the following mildly
                    100:   ugly code from login.conf(5):
                    101:     .Bl -column minpasswordlen program xetcxmotd
                    102:     .It path Ta path Ta value of Dv _PATH_DEFPATH
                    103:     .br
                    104:     Default search path.
                    105:   reported by Michal Mazurek <akfaew at jasminek dot net>
                    106:   via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.42      schwarze  107:
                    108: - inside `.Bl -column' phrases, punctuation is handled like normal
                    109:   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
                    110:
                    111: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
                    112:   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
                    113:   but should give "ab ."
1.12      kristaps  114:
                    115: - set a meaningful default if no `Bl' list type is assigned
1.13      kristaps  116:
                    117: - have a blank `It' head for `Bl -tag' not puke
1.20      kristaps  118:
                    119: - prohibit `Nm' from having non-text HEAD children
                    120:   (e.g., NetBSD mDNSShared/dns-sd.1)
                    121:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109     schwarze  122:
                    123: - When there is free text in the SYNOPSIS and that free text contains
                    124:   the .Nm macro, groff somehow understands to treat the .Nm as an in-line
                    125:   macro, while mandoc treats it as a block macro and breaks the line.
                    126:   No idea how the logic for distinguishing in-line and block instances
                    127:   should be, needs investigation.
                    128:   uqs@  Thu, 2 Jun 2011 11:03:51 +0200
                    129:   uqs@  Thu, 2 Jun 2011 11:33:35 +0200
1.57      kristaps  130:
1.79      schwarze  131: --- missing man features -----------------------------------------------
                    132:
1.119     kristaps  133: - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
1.80      schwarze  134:
1.79      schwarze  135: --- missing tbl features -----------------------------------------------
                    136:
                    137: - implement basic non-parametric .de to support e.g. sox(1)
                    138:   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
                    139:   *** sox(1) still doesn't work, tbl(1) errors need investigation
1.105     kristaps  140:
                    141: - allow standalone `.' to be interpreted as an end-of-layout
                    142:   delimiter instead of being thrown away as a no-op roff line
                    143:   reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
1.79      schwarze  144:
                    145: --- missing misc features ----------------------------------------------
1.159     schwarze  146:
                    147: - italic correction (\/) in PostScript mode
                    148:   Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
1.153     schwarze  149:
                    150: - The whatis(1) utility looks for whole words in Nm.
                    151:   If the file name of a page does not agree with the contents of any
                    152:   of its Nm macros (e.g. pool(9)), add the file name as an Nm entry
                    153:   to the mandoc.db as well, such that whatis(1) finds it.
                    154:   If there is a page with a file name that does not appear as a substring
                    155:   neither in Nm nor in Nd, the same fix would allow finding that page
                    156:   with apropos(1) using the file name as a key, as well.
                    157:   Issue reported by tedu@  Fri, 05 Jul 2013 21:15:23 -0400
1.79      schwarze  158:
                    159: - clean up escape sequence handling, creating three classes:
                    160:   (1) fully implemented, or parsed and ignored without loss of content
                    161:   (2) unimplemented, potentially causing loss of content
                    162:       or serious mangling of formatting (e.g. \n) -> ERROR
                    163:       see textproc/mgdiff(1) for nice examples
                    164:   (3) undefined, just output the character -> perhaps WARNING
1.83      schwarze  165:
1.79      schwarze  166: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
                    167:   These are a weird mixture of man(7) and custom autogenerated low-level
                    168:   roff stuff.  Figure out to what extent we can cope.
1.80      schwarze  169:   For details, see http://docutils.sourceforge.net/rst.html
1.79      schwarze  170:   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
                    171:   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
1.160     schwarze  172:
                    173: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
                    174:   First impression is not that bad.
1.71      schwarze  175:
                    176: - check compatibility with Plan9:
                    177:   http://swtch.com/usr/local/plan9/tmac/tmac.an
                    178:   http://swtch.com/plan9port/man/man7/man.html
                    179:   "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63      schwarze  180:
1.1       kristaps  181: ************************************************************************
                    182: * formatting issues: ugly output
                    183: ************************************************************************
1.87      kristaps  184:
                    185: - a column list with blank `Ta' cells triggers a spurrious
                    186:   start-with-whitespace printing of a newline
1.1       kristaps  187:
1.39      schwarze  188: - In .Bl -column,
                    189:   .It Em Authentication<tab>Key Length
                    190:   ought to render "Key Length" with emphasis, too,
                    191:   see OpenBSD iked.conf(5).
1.123     schwarze  192:   reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.39      schwarze  193:
1.1       kristaps  194: - empty phrases in .Bl column produce too few blanks
                    195:   try e.g. .Bl -column It Ta Ta
                    196:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48      schwarze  197:
1.83      schwarze  198: - .%T can have trailing punctuation.  Currently, it puts the trailing
                    199:   punctuation into a trailing MDOC_TEXT element inside its own scope.
                    200:   That element should rather be outside its scope, such that the
                    201:   punctuation does not get underlines.  This is not trivial to
                    202:   implement because .%T then needs some features of in_line_eoln() -
                    203:   slurp all arguments into one single text element - and one feature
                    204:   of in_line() - put trailing punctuation out of scope.
                    205:   Found in mount_nfs(8) and exports(5), search for "Appendix".
                    206:
1.147     schwarze  207: - Trailing punctuation after .%T triggers EOS spacing, at least
                    208:   outside .Rs (eek!).  Simply setting ARGSFL_DELIM for .%T is not
                    209:   the right solution, it sends mandoc into an endless loop.
                    210:   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
                    211:
1.48      schwarze  212: - in enclosures, mandoc sometimes fancies a bogus end of sentence
                    213:   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
1.149     schwarze  214:
                    215: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
                    216:   reveals lots of bugs both in groff and mandoc...
                    217:   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
1.35      kristaps  218:
1.1       kristaps  219: ************************************************************************
1.104     kristaps  220: * formatting issues: gratuitous differences
1.1       kristaps  221: ************************************************************************
1.65      kristaps  222:
                    223: - .Rv (and probably .Ex) print different text if an `Nm' has been named
                    224:   or not (run a manual without `Nm blah' to see this).  I'm not sure
                    225:   that this exists in the wild, but it's still an error.
1.38      schwarze  226:
                    227: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
                    228:   is just "o\bo".
                    229:   see for example OpenBSD ksh(1)
1.103     schwarze  230:
                    231: - .Pp between two .It in .Bl -column should produce one,
                    232:   not two blank lines, see e.g. login.conf(5).
                    233:   reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
1.129     schwarze  234:   reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.39      schwarze  235:
1.83      schwarze  236: - If the *first* line after .It is .Pp, break the line right after
                    237:   the tag, do not pad with space characters before breaking.
                    238:   See the description of the a, c, and i commands in sed(1).
                    239:
                    240: - If the first line after .It is .D1, do not assert a blank line
                    241:   in between, see for example tmux(1).
                    242:   reported by nicm@  13 Jan 2011 00:18:57 +0000
1.147     schwarze  243:
                    244: - Trailing punctuation after .It should trigger EOS spacing.
                    245:   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
                    246:   Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.83      schwarze  247:
1.39      schwarze  248: - .Nx 1.0a
                    249:   should be "NetBSD 1.0A", not "NetBSD 1.0a",
                    250:   see OpenBSD ccdconfig(8).
1.83      schwarze  251:
1.39      schwarze  252: - In .Bl -tag, if a tag exceeds the right margin and must be continued
                    253:   on the next line, it must be indented by -width, not width+1;
                    254:   see "rule block|pass" in OpenBSD ifconfig(8).
1.56      schwarze  255:
1.83      schwarze  256: - When the -width string contains macros, the macros must be rendered
                    257:   before measuring the width, for example
                    258:     .Bl -tag -width ".Dv message"
                    259:   in magic(5), located in src/usr.bin/file, is the same
                    260:   as -width 7n, not -width 11n.
1.129     schwarze  261:   The same applies to .Bl -column column widths;
                    262:   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157     schwarze  263:   reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
                    264:   An easy partial fix would be to just skip the first word if it starts
                    265:   with a dot, including any following white space, when measuring.
1.83      schwarze  266:
1.56      schwarze  267: - The \& zero-width character counts as output.
                    268:   That is, when it is alone on a line between two .Pp,
                    269:   we want three blank lines, not two as in mandoc.
1.83      schwarze  270:
1.64      schwarze  271: - Header lines of excessive length:
                    272:   Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
                    273:   and document it in mdoc(7) and man(7) COMPATIBILITY
                    274:   found while talking to Chris Bennett
1.83      schwarze  275:
                    276: - trailing whitespace must be ignored even when followed by a font escape,
                    277:   see for example
                    278:     makes
                    279:     \fBdig \fR
                    280:     operate in batch mode
                    281:   in dig(1).
1.166   ! schwarze  282:
        !           283: ************************************************************************
        !           284: * warning issues
        !           285: ************************************************************************
        !           286:
        !           287: - check that MANDOCERR_BADTAB is thrown in the right cases,
        !           288:   i.e. when finding a literal tab character in fill mode,
        !           289:   and possibly change the wording of the warning message
        !           290:   to refer to fill mode, not literal mode
        !           291:   See the mail from Werner LEMBERG on the groff list,
        !           292:   Fri, 14 Feb 2014 18:54:42 +0100 (CET)
1.1       kristaps  293:
1.9       kristaps  294: ************************************************************************
                    295: * performance issues
                    296: ************************************************************************
                    297:
                    298: Several areas can be cleaned up to make mandoc even faster.  These are
                    299:
                    300: - improve hashing mechanism for macros (quite important: performance)
                    301:
                    302: - improve hashing mechanism for characters (not as important)
1.23      kristaps  303:
1.37      kristaps  304: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115     kristaps  305:
                    306: - instead of re-initialising the roff predefined-strings set before each
                    307:   parse, create a read-only version the first time and copy it
1.37      kristaps  308:
1.23      kristaps  309: ************************************************************************
                    310: * structural issues
                    311: ************************************************************************
1.122     schwarze  312:
                    313: - We use the input line number at several places to distinguish
                    314:   same-line from different-line input.  That plainly doesn't work
                    315:   with user-defined macros, leading to random breakage.
1.67      schwarze  316:
                    317: - Find better ways to prevent endless loops
                    318:   in roff(7) macro and string expansion.
1.91      schwarze  319:
1.96      schwarze  320: - Finish cleanup of date handling.
1.91      schwarze  321:   Decide which formats should be recognized where.
                    322:   Update both mdoc(7) and man(7) documentation.
                    323:   Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100

CVSweb