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

Annotation of mandoc/TODO, Revision 1.247

1.1       kristaps    1: ************************************************************************
1.37      kristaps    2: * Official mandoc TODO.
1.247   ! schwarze    3: * $Id: TODO,v 1.246 2017/07/24 11:15:12 schwarze Exp $
1.27      kristaps    4: ************************************************************************
1.145     schwarze    5:
1.184     schwarze    6: Many issues are annotated for difficulty as follows:
                      7:
                      8:  - loc = locality of the issue
                      9:     *    single file issue, affects file only, or very few
                     10:     **   single module issue, affects several files of one module
                     11:     ***  cross-module issue, significantly impacts multiple modules
                     12:          and may require substantial changes to internal interfaces
                     13:  - exist = difficulty of the existing code in this area
                     14:     *    affected code is straightforward and easy to read and change
                     15:     **   affected code is somewhat complex, but once you understand
                     16:          the design, not particularly difficult to understand
                     17:     ***  affected code uses a special, exceptionally tricky design
                     18:  - algo = difficulty of the new algorithm to be written
                     19:     *    the required logic and code is straightforward
                     20:     **   the required logic is somewhat complex and needs a careful design
                     21:     ***  the required logic is exceptionally tricky,
                     22:          maybe an approach to solve that is not even known yet
                     23:  - size = the amount of code to be written or changed
                     24:     *    a small number of lines (at most 100, usually much less)
                     25:     **   a considerable amount of code (several dozen to a few hundred)
                     26:     ***  a large amount of code (many hundreds, maybe thousands)
                     27:  - imp = importance of the issue
                     28:     *    mostly for completeness
                     29:     **   would be nice to have
                     30:     ***  issue causes considerable inconvenience
                     31:
                     32: Obviously, as the issues have not been solved yet, these annotations
                     33: are mere guesses, and some may be wrong.
1.101     schwarze   34:
1.61      schwarze   35: ************************************************************************
1.1       kristaps   36: * missing features
                     37: ************************************************************************
1.70      kristaps   38:
1.79      schwarze   39: --- missing roff features ----------------------------------------------
                     40:
1.82      schwarze   41: - .ad (adjust margins)
                     42:   .ad l -- adjust left margin only (flush left)
                     43:   .ad r -- adjust right margin only (flush right)
                     44:   .ad c -- center text on line
                     45:   .ad b -- adjust both margins (alias: .ad n)
                     46:   .na   -- temporarily disable adjustment without changing the mode
                     47:   .ad   -- re-enable adjustment without changing the mode
                     48:   Adjustment mode is ignored while in no-fill mode (.nf).
1.184     schwarze   49:   loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
1.150     schwarze   50:
                     51: - .fc (field control)
                     52:   found by naddy@ in xloadimage(1)
1.184     schwarze   53:   loc **  exist ***  algo *  size *  imp *
1.198     schwarze   54:
1.160     schwarze   55: - .nr third argument (auto-increment step size, requires \n+)
                     56:   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
1.184     schwarze   57:   loc *  exist *  algo *  size *  imp **
1.160     schwarze   58:
1.80      schwarze   59: - .ns (no-space mode) occurs in xine-config(1)
1.205     schwarze   60:   when implementing this, also let .TH set it
1.80      schwarze   61:   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
1.184     schwarze   62:   loc ***  exist ***  algo ***  size **  imp *
1.61      schwarze   63:
1.198     schwarze   64: - .while and .shift
1.154     schwarze   65:   found by jca@ in ratpoison(1)  Sun, 30 Jun 2013 12:01:09 +0200
1.184     schwarze   66:   loc *  exist **  algo **  size **  imp **
1.155     schwarze   67:
1.160     schwarze   68: - \n+ and \n- numerical register increment and decrement
                     69:   found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
1.184     schwarze   70:   loc *  exist *  algo *  size *  imp **
1.201     schwarze   71:
1.184     schwarze   72: - \w'' improve width measurements
1.167     schwarze   73:   would not be very useful without an expression parser, see below
                     74:   needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
1.184     schwarze   75:   loc **  exist ***  algo ***  size *  imp ***
1.203     schwarze   76:
                     77: - \\ in high-level macro arguments
                     78:   Currently, \\ is expanded in two situations:
                     79:   1) macro and string definition (roff.c setstrn())
                     80:   2) macro argument parsing (mandoc.c mandoc_getarg())
                     81:   For user defined macros, the second happens in time because of ROFF_REPARSE.
                     82:   But for standard high-level macros, it only happens after entering the
                     83:   high level parsers, which is too late because the code doesn't get
                     84:   back to roff.c roff_res() from that point.  Because this requires
                     85:   distinguishing requests, user-defined macros and standard macros
                     86:   on the roff_res() level, it is hard to solve without the parser reorg.
                     87:   Found by naddy@ in devel/cutils cobfusc(1)  Mon, 16 Feb 2015 19:10:52 +0100
                     88:   loc ***  exist ***  algo ***  size **  imp *
1.167     schwarze   89:
1.125     schwarze   90: - using undefined strings or macros defines them to be empty
                     91:   wl@  Mon, 14 Nov 2011 14:37:01 +0000
1.184     schwarze   92:   loc *  exist *  algo *  size *  imp *
1.167     schwarze   93:
1.79      schwarze   94: --- missing mdoc features ----------------------------------------------
1.18      schwarze   95:
1.1       kristaps   96: - .Bl -column .Xo support is missing
                     97:   ultimate goal:
                     98:   restore .Xr and .Dv to
                     99:   lib/libc/compat-43/sigvec.3
                    100:   lib/libc/gen/signal.3
                    101:   lib/libc/sys/sigaction.2
1.184     schwarze  102:   loc *  exist ***  algo ***  size *  imp **
1.1       kristaps  103:
1.28      schwarze  104: - edge case: decide how to deal with blk_full bad nesting, e.g.
                    105:   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
                    106:   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
1.184     schwarze  107:   loc *  exist ***  algo ***  size **  imp **
1.28      schwarze  108:
1.174     schwarze  109: - .Bd -centered implies -filled, not -unfilled, which is not
                    110:   easy to implement; it requires code similar to .ce, which
                    111:   we don't have either.
                    112:   Besides, groff has bug causing text right *before* .Bd -centered
                    113:   to be centered as well.
1.184     schwarze  114:   loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
1.174     schwarze  115:
1.82      schwarze  116: - .Bd -filled should not be the same as .Bd -ragged, but align both
                    117:   the left and right margin.  In groff, it is implemented in terms
                    118:   of .ad b, which we don't have either.  Found in cksum(1).
1.184     schwarze  119:   loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
1.22      schwarze  120:
1.10      kristaps  121: - implement blank `Bl -column', such as
                    122:   .Bl -column
                    123:   .It foo Ta bar
                    124:   .El
1.184     schwarze  125:   loc *  exist ***  algo ***  size *  imp *
1.11      kristaps  126:
                    127: - explicitly disallow nested `Bl -column', which would clobber internal
                    128:   flags defined for struct mdoc_macro
1.184     schwarze  129:   loc *  exist *  algo *  size *  imp **
1.102     schwarze  130:
                    131: - In .Bl -column .It, the end of the line probably has to be regarded
                    132:   as an implicit .Ta, if there could be one, see the following mildly
                    133:   ugly code from login.conf(5):
                    134:     .Bl -column minpasswordlen program xetcxmotd
                    135:     .It path Ta path Ta value of Dv _PATH_DEFPATH
                    136:     .br
                    137:     Default search path.
                    138:   reported by Michal Mazurek <akfaew at jasminek dot net>
                    139:   via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.184     schwarze  140:   loc *  exist ***  algo **  size *  imp **
1.42      schwarze  141:
                    142: - inside `.Bl -column' phrases, punctuation is handled like normal
                    143:   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
                    144:
                    145: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
                    146:   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
                    147:   but should give "ab ."
1.12      kristaps  148:
1.174     schwarze  149: - check whether it is correct that `D1' uses INDENT+1;
                    150:   does it need its own constant?
1.184     schwarze  151:   loc *  exist **  algo **  size *  imp **
1.174     schwarze  152:
1.20      kristaps  153: - prohibit `Nm' from having non-text HEAD children
                    154:   (e.g., NetBSD mDNSShared/dns-sd.1)
                    155:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109     schwarze  156:
1.174     schwarze  157: - support translated section names
                    158:   e.g. x11/scrotwm scrotwm_es.1:21:2: error: NAME section must be first
                    159:   that one uses NOMBRE because it is spanish...
                    160:   deraadt tends to think that section-dependent macro behaviour
                    161:   is a bad idea in the first place, so this may be irrelevant
1.184     schwarze  162:   loc **  exist **  algo **  size *  imp **
1.174     schwarze  163:
1.109     schwarze  164: - When there is free text in the SYNOPSIS and that free text contains
                    165:   the .Nm macro, groff somehow understands to treat the .Nm as an in-line
                    166:   macro, while mandoc treats it as a block macro and breaks the line.
                    167:   No idea how the logic for distinguishing in-line and block instances
                    168:   should be, needs investigation.
                    169:   uqs@  Thu, 2 Jun 2011 11:03:51 +0200
                    170:   uqs@  Thu, 2 Jun 2011 11:33:35 +0200
1.184     schwarze  171:   loc *  exist **  algo ***  size *  imp **
1.57      kristaps  172:
1.79      schwarze  173: --- missing tbl features -----------------------------------------------
1.213     schwarze  174:
                    175: - the "s" layout column specifier is used for placement of data
                    176:   into columns, but ignored during column width calculations
                    177:   synaptics(4) found by tedu@  Mon, 17 Aug 2015 21:17:42 -0400
                    178:   loc *  exist **  algo ***  size *  imp **
1.79      schwarze  179:
1.208     schwarze  180: - support mdoc(7) and man(7) macros inside tbl(7) code;
                    181:   probably requires the parser reorg and letting tbl(7)
                    182:   use roff_node such that macro sets can mix;
1.233     schwarze  183:   informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100
1.208     schwarze  184:   loc ***  exist **  algo ***  size **  imp ***
                    185:
1.171     schwarze  186: - look at the POSIX manuals in the books/man-pages-posix port,
                    187:   they use some unsupported tbl(7) features.
1.184     schwarze  188:   loc *  exist **  algo **  size **  imp ***
1.171     schwarze  189:
1.230     schwarze  190: - look what Joerg Schilling manual pages use
                    191:   Thu, 19 Mar 2015 18:31:48 +0100
                    192:
1.183     schwarze  193: - use Unicode U+2500 to U+256C for table borders
                    194:   in tbl(7) -Tutf-8 output
                    195:   suggested by bentley@  Tue, 14 Oct 2014 04:10:55 -0600
1.184     schwarze  196:   loc *  exist **  algo *  size *  imp **
1.105     kristaps  197:
1.182     schwarze  198: --- missing eqn features -----------------------------------------------
1.209     schwarze  199:
                    200: - In a matrix, break the output line after each matrix line.
                    201:   Found in the discussion at CDBUG 2015.
                    202:   Suggested by Avi Weinstock.
                    203:   loc *  exist *  algo *  size *  imp **
1.182     schwarze  204:
                    205: - The "size" keyword is parsed, but ignored by the formatter.
1.184     schwarze  206:   loc *  exist *  algo *  size *  imp *
1.182     schwarze  207:
                    208: - The spacing characters `~', `^', and tab are currently ignored,
                    209:   see User's Guide (Second Edition) page 2 section 4.
1.184     schwarze  210:   loc *  exist *  algo **  size *  imp **
1.182     schwarze  211:
                    212: - Mark and lineup are parsed and ignored,
                    213:   see User's Guide (Second Edition) page 5 section 15.
1.184     schwarze  214:   loc **  exist **  algo **  size **  imp **
1.238     schwarze  215:
                    216: - GNU eqn converts some operators to special characters, for example,
                    217:   input HYPHEN-MINUS becomes output \(mi, unless it is part of a
                    218:   quoted word.  mandoc(1) only does this when the operator is
                    219:   surrounded by blanks, not when it is part of an unquoted word.
                    220:   Also, check whether there are more such cases (e.g., +?).
                    221:   reported by bentley@  20 Jun 2017 02:04:29 -0600
1.182     schwarze  222:
1.239     schwarze  223: - Primes, opprime, and '
                    224:   bentley@  Thu, 13 Jul 2017 23:14:20 -0600
                    225:
1.79      schwarze  226: --- missing misc features ----------------------------------------------
1.159     schwarze  227:
                    228: - italic correction (\/) in PostScript mode
                    229:   Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
1.184     schwarze  230:   loc **  exist **  algo *  size *  imp *
1.153     schwarze  231:
1.210     schwarze  232: - change the default PAGER to more -Es and use the pager
                    233:   even for apropos title line output; req by bapt@
                    234:   loc *  exist *  algo *  size *  imp ***
1.171     schwarze  235:
1.79      schwarze  236: - clean up escape sequence handling, creating three classes:
                    237:   (1) fully implemented, or parsed and ignored without loss of content
                    238:   (2) unimplemented, potentially causing loss of content
                    239:       or serious mangling of formatting (e.g. \n) -> ERROR
                    240:       see textproc/mgdiff(1) for nice examples
                    241:   (3) undefined, just output the character -> perhaps WARNING
1.184     schwarze  242:   loc ***  exist **  algo **  size **  imp *** (parser reorg helps)
1.83      schwarze  243:
1.174     schwarze  244: - kettenis wants base roff, ms, and me  Fri, 1 Jan 2010 22:13:15 +0100 (CET)
1.184     schwarze  245:   loc **  exist **  algo **  size ***  imp *
1.174     schwarze  246:
                    247: --- compatibility checks -----------------------------------------------
1.196     schwarze  248:
1.174     schwarze  249: - is .Bk implemented correctly in modern groff?
                    250:   sobrado@  Tue, 19 Apr 2011 22:12:55 +0200
                    251:
1.175     schwarze  252: - compare output to Heirloom roff, Solaris roff, and
                    253:   http://repo.or.cz/w/neatroff.git  http://litcave.rudi.ir/
1.178     schwarze  254:
                    255: - look at AT&T DWB http://www2.research.att.com/sw/download
                    256:   Carsten Kunze <carsten dot kunze at arcor dot de> has patches
                    257:   Mon, 4 Aug 2014 17:01:28 +0200
1.230     schwarze  258:   ported version: https://github.com/n-t-roff/DWB3.3
                    259:   Carsten Kunze  Wed, 22 Apr 2015 11:21:43 +0200
1.174     schwarze  260:
1.79      schwarze  261: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
                    262:   These are a weird mixture of man(7) and custom autogenerated low-level
                    263:   roff stuff.  Figure out to what extent we can cope.
1.80      schwarze  264:   For details, see http://docutils.sourceforge.net/rst.html
1.79      schwarze  265:   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
                    266:   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
1.160     schwarze  267:
1.174     schwarze  268: - look at pages generated from ronn(1) github.com/rtomayko/ronn
                    269:   (based on markdown)
                    270:
1.160     schwarze  271: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
                    272:   First impression is not that bad.
1.172     schwarze  273:
                    274: - look at pages generated by pandoc; see
                    275:   https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
                    276:   porting planned by kili@  Thu, 19 Jun 2014 19:46:28 +0200
1.71      schwarze  277:
                    278: - check compatibility with Plan9:
                    279:   http://swtch.com/usr/local/plan9/tmac/tmac.an
                    280:   http://swtch.com/plan9port/man/man7/man.html
                    281:   "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63      schwarze  282:
1.207     schwarze  283: - check compatibility with COHERENT troff:
                    284:   http://www.nesssoftware.com/home/mwc/source.php
                    285:
1.174     schwarze  286: - check compatibility with the man(7) formatter
                    287:   https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
                    288:
1.186     schwarze  289: - check compatibility with
                    290:   http://ikiwiki.info/plugins/contrib/mandoc/
                    291:   https://github.com/schmonz/ikiwiki/compare/mandoc
                    292:   Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
                    293:
1.230     schwarze  294: - check features of the Slackware man.conf(5) format
                    295:   Carsten Kunze  Wed, 11 Mar 2015 17:57:24 +0100
                    296:
1.1       kristaps  297: ************************************************************************
                    298: * formatting issues: ugly output
                    299: ************************************************************************
1.87      kristaps  300:
1.195     schwarze  301: - revisit empty in-line macros
                    302:   look at the difference between "Em x Em ." and "Sq x Em ."
                    303:   Carsten Kunze  Fri, 12 Dec 2014 00:15:41 +0100
                    304:   loc *** exist *** algo *** size * imp **
                    305:
                    306: - a column list with blank `Ta' cells triggers a spurious
1.87      kristaps  307:   start-with-whitespace printing of a newline
1.195     schwarze  308:
                    309: - In .Bl -column, .It a<tab>"b<tab>c"
                    310:   shows the quotes in groff, but not in mandoc
                    311:   loc * exist *** algo ** size * imp **
1.1       kristaps  312:
1.39      schwarze  313: - In .Bl -column,
                    314:   .It Em Authentication<tab>Key Length
                    315:   ought to render "Key Length" with emphasis, too,
                    316:   see OpenBSD iked.conf(5).
1.123     schwarze  317:   reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.184     schwarze  318:   loc *  exist ***  algo ***  size **  imp ***
1.39      schwarze  319:
1.1       kristaps  320: - empty phrases in .Bl column produce too few blanks
                    321:   try e.g. .Bl -column It Ta Ta
                    322:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.184     schwarze  323:   loc *  exist ***  algo ***  size *  imp **
1.48      schwarze  324:
1.83      schwarze  325: - .%T can have trailing punctuation.  Currently, it puts the trailing
                    326:   punctuation into a trailing MDOC_TEXT element inside its own scope.
                    327:   That element should rather be outside its scope, such that the
                    328:   punctuation does not get underlines.  This is not trivial to
                    329:   implement because .%T then needs some features of in_line_eoln() -
                    330:   slurp all arguments into one single text element - and one feature
                    331:   of in_line() - put trailing punctuation out of scope.
                    332:   Found in mount_nfs(8) and exports(5), search for "Appendix".
1.184     schwarze  333:   loc **  exist **  algo ***  size *  imp **
1.83      schwarze  334:
1.147     schwarze  335: - Trailing punctuation after .%T triggers EOS spacing, at least
                    336:   outside .Rs (eek!).  Simply setting ARGSFL_DELIM for .%T is not
                    337:   the right solution, it sends mandoc into an endless loop.
                    338:   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
1.184     schwarze  339:   loc *  exist **  algo **  size *  imp **
1.147     schwarze  340:
1.174     schwarze  341: - global variables in the SYNOPSIS of section 3 pages
                    342:   .Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...
                    343:   from kristaps@  Tue, 08 Jun 2010 11:13:32 +0200
1.239     schwarze  344:
                    345: - implicit whitespace around inline equations
                    346:   example code:  where '$times$' denotes matrix multiplication
                    347:   must not have an HTML line break, nor a blank, before <math>
                    348:   partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT},
                    349:   bentley@  Thu, 13 Jul 2017 19:00:59 -0600
1.174     schwarze  350:
1.48      schwarze  351: - in enclosures, mandoc sometimes fancies a bogus end of sentence
                    352:   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
1.184     schwarze  353:   loc *  exist **  algo ***  size *  imp ***
1.197     schwarze  354:
                    355: - a line starting with "\fB something" counts as starting with whitespace
                    356:   and triggers a line break; found in audio/normalize-mp3(1)
                    357:   loc **  exist *  algo **  size *  imp **
1.149     schwarze  358:
                    359: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
                    360:   reveals lots of bugs both in groff and mandoc...
                    361:   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
1.171     schwarze  362:
1.230     schwarze  363: --- PostScript and PDF issues ------------------------------------------
1.171     schwarze  364:
                    365: - PDF output doesn't use a monospaced font for .Bd -literal
                    366:   Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
                    367:   Search the text "Routing tables".
                    368:   Also check what PostScript mode does when fixing this.
                    369:   reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
1.186     schwarze  370:   instructions from juanfra@  Wed, 11 Jun 2014 02:21:01 +0200
                    371:     add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
                    372:     and change the /Name from /F0 to the new font (/F5 (?)).
1.230     schwarze  373:   re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100
1.186     schwarze  374:   loc *  exist **  algo **  size *  imp **
1.173     schwarze  375:
                    376: --- HTML issues --------------------------------------------------------
1.247   ! schwarze  377:
        !           378: - format ".IP *" etc. as <ul> rather than <dl>
        !           379:   https://github.com/Debian/debiman/issues/67
        !           380:   loc ** exist ** algo ** size * imp ***
1.214     schwarze  381:
                    382: - .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
                    383:   space, see for example random(3).  Introduced in
                    384:   http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92
                    385:   reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
                    386:   loc **  exist **  algo **  size *  imp *
1.180     schwarze  387:
1.187     schwarze  388: - jsg on icb, Nov 3, 2014:
                    389:   try to guess Xr in man(7) for hyperlinking
1.226     schwarze  390:   and render them with <a class="Xr" href=...>
                    391:   https://github.com/Debian/debiman/issues/15
                    392:   loc *  exist *  algo **  size **  imp **
1.187     schwarze  393:
1.180     schwarze  394: - The tables used to render the three-part page headers actually force
                    395:   the width of the <body> to the max-width given for <html>.
                    396:   Not yet sure how to fix that...
                    397:   Observed by an Anonymous Coward on undeadly.org:
                    398:   http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
1.184     schwarze  399:   loc *  exist *  algo **  size *  imp ***
1.206     schwarze  400:
                    401: - generate <img> tags in HTML
                    402:   idea from florian@  Tue, 7 Apr 2015 00:26:28 +0000
                    403:   may be possible to implement with .Lk img://something.png alt_text
1.174     schwarze  404:
1.173     schwarze  405: - check https://github.com/trentm/mdocml
1.35      kristaps  406:
1.1       kristaps  407: ************************************************************************
1.104     kristaps  408: * formatting issues: gratuitous differences
1.1       kristaps  409: ************************************************************************
1.187     schwarze  410:
                    411: - .Fn reopens a new scope after punctuation in mandoc,
                    412:   but closes its scope for good in groff.
                    413:   Do we want to change mandoc or groff?
                    414:   Steffen Nurpmeso  Sat, 08 Nov 2014 13:34:59 +0100
                    415:   loc *  exist **  algo **  size *  imp **
1.230     schwarze  416:
1.174     schwarze  417: - In .Bl -enum -width 0n, groff continues one the same line after
                    418:   the number, mandoc breaks the line.
                    419:   mail to kristaps@  Mon, 20 Jul 2009 02:21:39 +0200
1.184     schwarze  420:   loc *  exist **  algo **  size *  imp **
1.174     schwarze  421:
1.103     schwarze  422: - .Pp between two .It in .Bl -column should produce one,
                    423:   not two blank lines, see e.g. login.conf(5).
                    424:   reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
1.129     schwarze  425:   reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.184     schwarze  426:   loc *  exist ***  algo **  size *  imp **
1.39      schwarze  427:
1.83      schwarze  428: - If the *first* line after .It is .Pp, break the line right after
                    429:   the tag, do not pad with space characters before breaking.
                    430:   See the description of the a, c, and i commands in sed(1).
1.184     schwarze  431:   loc *  exist **  algo **  size *  imp **
1.83      schwarze  432:
                    433: - If the first line after .It is .D1, do not assert a blank line
                    434:   in between, see for example tmux(1).
                    435:   reported by nicm@  13 Jan 2011 00:18:57 +0000
1.184     schwarze  436:   loc *  exist **  algo **  size *  imp **
1.147     schwarze  437:
                    438: - Trailing punctuation after .It should trigger EOS spacing.
                    439:   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
                    440:   Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.184     schwarze  441:   loc *  exist **  algo **  size *  imp **
1.83      schwarze  442:
                    443: - When the -width string contains macros, the macros must be rendered
                    444:   before measuring the width, for example
                    445:     .Bl -tag -width ".Dv message"
                    446:   in magic(5), located in src/usr.bin/file, is the same
                    447:   as -width 7n, not -width 11n.
1.129     schwarze  448:   The same applies to .Bl -column column widths;
                    449:   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157     schwarze  450:   reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
1.234     schwarze  451:   reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@
1.184     schwarze  452:   loc ***  exist ***  algo ***  size **  imp ***
1.157     schwarze  453:   An easy partial fix would be to just skip the first word if it starts
                    454:   with a dot, including any following white space, when measuring.
1.184     schwarze  455:   loc *  exist *  algo *  size *  imp ***
1.83      schwarze  456:
1.56      schwarze  457: - The \& zero-width character counts as output.
                    458:   That is, when it is alone on a line between two .Pp,
                    459:   we want three blank lines, not two as in mandoc.
1.184     schwarze  460:   loc **  exist **  algo **  size *  imp **
1.83      schwarze  461:
1.205     schwarze  462: - Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
                    463:   with .ps and .nf/.fi produce execessive blank lines, see libJudy
1.207     schwarze  464:   and graphics/dcmtk.  The parser reorg may help with this.
1.83      schwarze  465:
                    466: - trailing whitespace must be ignored even when followed by a font escape,
1.198     schwarze  467:   see for example
1.83      schwarze  468:     makes
                    469:     \fBdig \fR
                    470:     operate in batch mode
                    471:   in dig(1).
1.184     schwarze  472:   loc **  exist **  algo **  size *  imp **
1.166     schwarze  473:
                    474: ************************************************************************
                    475: * warning issues
                    476: ************************************************************************
1.216     schwarze  477:
1.245     schwarze  478: - style message about macros inside .Bd -literal and .Dl, in particular
                    479:   font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO)
                    480:
1.246     schwarze  481: - style message about mismatches between the section number in the
                    482:   file name (if it is known) and the section number in .Dt
                    483:   (from the mdoclint TODO)
                    484:
1.245     schwarze  485: - style message about NULL without .Dv (from the mdoclint TODO)
                    486:
                    487: - style message about error constants without .Er (from the mdoclint TODO)
                    488:
1.211     schwarze  489: - warn when .Sh or .Ss contain other macros
                    490:   Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034
1.210     schwarze  491:   loc *  exist *  algo *  size *  imp **
1.188     schwarze  492:
1.245     schwarze  493: - style message about violations of the convention
1.246     schwarze  494:   .An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO)
1.245     schwarze  495:
1.188     schwarze  496: - warn about attempts to call non-callable macros
                    497:   Steffen Nurpmeso  Tue, 11 Nov 2014 22:55:16 +0100
                    498:   Note that formatting is inconsistent in groff.
                    499:   .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
                    500:   Relatively hard because the relevant code is scattered
                    501:   all over mdoc_macro.c and all subtly different.
                    502:   loc **  exist **  algo **  size **  imp **
1.245     schwarze  503:
                    504: - style message about suspicious uses of - vs. \- vs. \(mi
                    505:   e.g. -1 is likely wrong (from the mdoclint TODO)
1.246     schwarze  506:
                    507: - warn about punctuation - e.g. ',' and ';' - at the beginning
                    508:   of a text line, if it is likely intended to follow the preceding
                    509:   output without intervening whitespace, in particular after a
                    510:   macro line (from the mdoclint TODO)
1.174     schwarze  511:
                    512: - mandoc_special does not really check the escape sequence,
                    513:   but just the overall format
1.184     schwarze  514:   loc **  exist **  algo ***  size **  imp **
1.174     schwarze  515:
                    516: ************************************************************************
                    517: * documentation issues
                    518: ************************************************************************
                    519:
1.241     schwarze  520: - dashes, hyphens, and minus signs in manual pages
                    521:   jmc@ Fri, 28 Mar 2014 07:19:27 +0000
                    522:
1.174     schwarze  523: - mark macros as: page structure domain, manual domain, general text domain
                    524:   is this useful?
                    525:
                    526: - mention /usr/share/misc/mdoc.template in mdoc(7)?
1.185     schwarze  527:
                    528: - Is all the content from http://www.std.com/obi/BSD/doc/usd/28.tbl/tbl
                    529:   covered in tbl(7)?
1.1       kristaps  530:
1.9       kristaps  531: ************************************************************************
                    532: * performance issues
                    533: ************************************************************************
                    534:
1.37      kristaps  535: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115     kristaps  536:
1.23      kristaps  537: ************************************************************************
                    538: * structural issues
                    539: ************************************************************************
1.221     schwarze  540:
                    541: - POSIX says in the documentation of sysconf(3) that PATH_MAX
                    542:   is allowed to be so large that it is a bad idea to use it
                    543:   for sizing static buffers.  So use dynamic buffers throughout.
                    544:   See the file test-PATH_MAX.c for details.
                    545:   Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,
                    546:   https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624
1.122     schwarze  547:
                    548: - We use the input line number at several places to distinguish
                    549:   same-line from different-line input.  That plainly doesn't work
                    550:   with user-defined macros, leading to random breakage.
1.67      schwarze  551:
1.241     schwarze  552: - Is it possible to further simplify ENDBODY_SPACE?
                    553:
1.67      schwarze  554: - Find better ways to prevent endless loops
                    555:   in roff(7) macro and string expansion.
1.241     schwarze  556:
                    557: - make buffers for parsing functions const
                    558:   christos@ via wiz@  Fri, 18 Dec 2015 17:10:01 +0100
1.186     schwarze  559:
                    560: - struct mparse refactoring
                    561:   Steffen Nurpmeso  Thu, 04 Sep 2014 12:50:00 +0200
1.170     schwarze  562:
1.179     kristaps  563: ************************************************************************
                    564: * CGI issues
                    565: ************************************************************************
                    566:
                    567:  - Enable HTTP compression by detecting gzip encoding and filtering
                    568:    output through libz.
                    569:  - Sandbox (see OpenSSH).
                    570:  - Enable caching support via HTTP 304 and If-Modified-Since.
                    571:  - Have Mac OSX systems automatically disable -static compilation of the
                    572:    CGI: -static isn't supported.
1.181     kristaps  573:
1.192     schwarze  574: ************************************************************************
                    575: * to improve in the groff_mdoc(7) macros
                    576: ************************************************************************
                    577:
                    578: - use uname(1) to set doc-default-operating-system at install time
                    579:   tobimensch  Mon, 1 Dec 2014 00:25:07 +0100
1.236     schwarze  580:
                    581: - apostrophe (39), circumflex (94), grave (96), tilde (126)
                    582:   in manuals: \(aq, \(ha, \`, \(ti
                    583:   Re: [Groff] ASCII Minus Sign in man Pages.
                    584:   bentley@ 26 Apr 2017 10:02:06 -0600
                    585:   Do we need to fix existing manuals?
                    586:   Do we need to fix the definition of the mdoc(7) language?

CVSweb