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

Annotation of mandoc/TODO, Revision 1.305

1.1       kristaps    1: ************************************************************************
1.37      kristaps    2: * Official mandoc TODO.
1.305   ! schwarze    3: * $Id: TODO,v 1.304 2020/06/24 12:09:29 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.296     schwarze   34:
                     35: ************************************************************************
1.1       kristaps   36: * missing features
                     37: ************************************************************************
1.70      kristaps   38:
1.79      schwarze   39: --- missing roff features ----------------------------------------------
1.258     schwarze   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.80      schwarze   55: - .ns (no-space mode) occurs in xine-config(1)
1.205     schwarze   56:   when implementing this, also let .TH set it
1.80      schwarze   57:   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
1.184     schwarze   58:   loc ***  exist ***  algo ***  size **  imp *
1.201     schwarze   59:
1.184     schwarze   60: - \w'' improve width measurements
1.167     schwarze   61:   would not be very useful without an expression parser, see below
                     62:   needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
1.184     schwarze   63:   loc **  exist ***  algo ***  size *  imp ***
1.291     schwarze   64:
                     65: - .als only works for macros in mandoc, not for user-defined strings.
                     66:   Also, the "val" field in struct roffkv would have to be replaced
                     67:   with a pointer to a reference-counted wrapper, and an alias
                     68:   would have to point to the same wrapper as the original.
                     69:   .als to undefined does nothing; the alias is not created.
                     70:   .rm'ing the original leaves the alias to point to the old value.
                     71:   .de .als .de changes both, but
                     72:   .de .als .rm .de only changes the new value, not the alias.
                     73:   Found in groffer(1) version 1.19
                     74:   Jan Stary 20 Apr 2019 20:16:54 +0200
                     75:   loc *  exist **  algo **  size **  imp *
                     76:
                     77: - roff string condition comparisons fail when vars contain quotes:
                     78:   .ds s '
                     79:   .if '\*s'' \&...
                     80:   hard to fix because of the basic architecture (string replacement
                     81:   happens before roff(7) syntax parsing)
                     82:   Found in groffer(1) version 1.19
                     83:   Jan Stary 20 Apr 2019 20:16:54 +0200
                     84:   loc *  exist ***  algo ***  size **  imp *
1.303     schwarze   85:
                     86: - mandoc replaces all ASCII control characters except tab and line feed
                     87:   with '?' during input.  It would be better to replace them with
                     88:   Unicode escapes in preconv_encode() or somewhere in the vicinity,
                     89:   such that the already existing better replacement strings show
                     90:   up in the output.  Emulating groff is not desirable: groff replaces
                     91:   0x00, 0x0b, and 0x0d to 0x1f with the empty string (bad because
                     92:   that's easy to overlook for the document author), 0x01 with '.'
                     93:   (very confusing), and passes through 0x02 to 0x08, 0x0c, and 0x7f
                     94:   raw (bad because that is insecure output).  Remember that 0x07 may
                     95:   need special handling because it is sometimes used for certain
                     96:   delimiters, so it may need handling *after* roff.c rather than before.
                     97:   reminded by John Gardner 16 Jun 2020 14:26:28 +1000
1.304     schwarze   98:   Actually, more ASCII control characters than just 0x07 may need
                     99:   later handling because they can for example be used in macro names.
                    100:   So they may need handling after roff(7) processing.
                    101:   pointed out by John Gardner 23 Jun 2020 18:28:08 +1000
1.305   ! schwarze  102:   more info from John Gardner 29 Jun 2020 19:54:04 +1000
1.303     schwarze  103:   loc **  exist **  algo **  size **  imp *
1.203     schwarze  104:
1.79      schwarze  105: --- missing mdoc features ----------------------------------------------
1.18      schwarze  106:
1.298     schwarze  107: - .Sh and .Ss should be parsed and partially callable, see groff_mdoc(7)
                    108:   reed at reedmedia dot net Sat, 21 Dec 2019 17:13:07 -0600
                    109:   loc **  exist **  algo **  size **  imp *
                    110:
1.1       kristaps  111: - .Bl -column .Xo support is missing
                    112:   ultimate goal:
                    113:   restore .Xr and .Dv to
                    114:   lib/libc/compat-43/sigvec.3
                    115:   lib/libc/gen/signal.3
                    116:   lib/libc/sys/sigaction.2
1.184     schwarze  117:   loc *  exist ***  algo ***  size *  imp **
1.1       kristaps  118:
1.28      schwarze  119: - edge case: decide how to deal with blk_full bad nesting, e.g.
                    120:   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
                    121:   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
1.184     schwarze  122:   loc *  exist ***  algo ***  size **  imp **
1.174     schwarze  123:
1.82      schwarze  124: - .Bd -filled should not be the same as .Bd -ragged, but align both
                    125:   the left and right margin.  In groff, it is implemented in terms
                    126:   of .ad b, which we don't have either.  Found in cksum(1).
1.184     schwarze  127:   loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
1.22      schwarze  128:
1.10      kristaps  129: - implement blank `Bl -column', such as
                    130:   .Bl -column
                    131:   .It foo Ta bar
                    132:   .El
1.184     schwarze  133:   loc *  exist ***  algo ***  size *  imp *
1.11      kristaps  134:
                    135: - explicitly disallow nested `Bl -column', which would clobber internal
                    136:   flags defined for struct mdoc_macro
1.184     schwarze  137:   loc *  exist *  algo *  size *  imp **
1.102     schwarze  138:
                    139: - In .Bl -column .It, the end of the line probably has to be regarded
                    140:   as an implicit .Ta, if there could be one, see the following mildly
                    141:   ugly code from login.conf(5):
                    142:     .Bl -column minpasswordlen program xetcxmotd
                    143:     .It path Ta path Ta value of Dv _PATH_DEFPATH
                    144:     .br
                    145:     Default search path.
                    146:   reported by Michal Mazurek <akfaew at jasminek dot net>
                    147:   via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.184     schwarze  148:   loc *  exist ***  algo **  size *  imp **
1.42      schwarze  149:
                    150: - inside `.Bl -column' phrases, punctuation is handled like normal
                    151:   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
                    152:
                    153: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
                    154:   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
                    155:   but should give "ab ."
1.12      kristaps  156:
1.20      kristaps  157: - prohibit `Nm' from having non-text HEAD children
                    158:   (e.g., NetBSD mDNSShared/dns-sd.1)
                    159:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109     schwarze  160:
1.174     schwarze  161: - support translated section names
                    162:   e.g. x11/scrotwm scrotwm_es.1:21:2: error: NAME section must be first
                    163:   that one uses NOMBRE because it is spanish...
                    164:   deraadt tends to think that section-dependent macro behaviour
                    165:   is a bad idea in the first place, so this may be irrelevant
1.184     schwarze  166:   loc **  exist **  algo **  size *  imp **
1.174     schwarze  167:
1.109     schwarze  168: - When there is free text in the SYNOPSIS and that free text contains
                    169:   the .Nm macro, groff somehow understands to treat the .Nm as an in-line
                    170:   macro, while mandoc treats it as a block macro and breaks the line.
                    171:   No idea how the logic for distinguishing in-line and block instances
                    172:   should be, needs investigation.
                    173:   uqs@  Thu, 2 Jun 2011 11:03:51 +0200
                    174:   uqs@  Thu, 2 Jun 2011 11:33:35 +0200
1.184     schwarze  175:   loc *  exist **  algo ***  size *  imp **
1.57      kristaps  176:
1.252     schwarze  177: --- missing man features -----------------------------------------------
1.258     schwarze  178:
1.252     schwarze  179: - groff_www(7) .MTO and .URL
                    180:   These macros were used by the GNU grep(1) man page.
1.258     schwarze  181:   The groff_www(7) manual page itself uses them, too.
1.252     schwarze  182:   We should probably *not* add them to mandoc.
                    183:   Just mentioning this here to keep track of the abuse.
                    184:   Laura Morales <lauretas at mail dot com> 20 Apr 2018 07:33:02 +0200
                    185:   loc **  exist *  algo *  size **  imp *
                    186:
1.79      schwarze  187: --- missing tbl features -----------------------------------------------
                    188:
1.255     schwarze  189: - vertical centering in cells vertically spanned with ^
                    190:   pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200
                    191:   loc *  exist ***  algo ***  size **  imp *
                    192:
1.208     schwarze  193: - support mdoc(7) and man(7) macros inside tbl(7) code;
                    194:   probably requires the parser reorg and letting tbl(7)
                    195:   use roff_node such that macro sets can mix;
1.233     schwarze  196:   informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100
1.208     schwarze  197:   loc ***  exist **  algo ***  size **  imp ***
                    198:
1.171     schwarze  199: - look at the POSIX manuals in the books/man-pages-posix port,
1.283     schwarze  200:   they use some unsupported tbl(7) features, mostly macros in tbl(7).
1.184     schwarze  201:   loc *  exist **  algo **  size **  imp ***
1.171     schwarze  202:
1.230     schwarze  203: - look what Joerg Schilling manual pages use
                    204:   Thu, 19 Mar 2015 18:31:48 +0100
1.255     schwarze  205:
1.182     schwarze  206: --- missing eqn features -----------------------------------------------
1.209     schwarze  207:
                    208: - In a matrix, break the output line after each matrix line.
1.287     schwarze  209:   Found in the discussion at CDBUG 2015.  Suggested by Avi Weinstock.
                    210:   This may not be the ideal solution after all: eqn(7) matrices
                    211:   are lists of columns, so Avi's proposal would show each *column*
                    212:   on its own *line*, which is likely to cause confusion.
                    213:   A better solution, but much harder to implement, would be to
                    214:   actually show the coordinates of column vectors on different
                    215:   terminal output lines, using the clumnated output facilities
                    216:   developed for .Bl -tag, .Bl -column, and also used for tbl(7).
                    217:   loc *  exist *  algo **  size **  imp **
1.182     schwarze  218:
                    219: - The "size" keyword is parsed, but ignored by the formatter.
1.184     schwarze  220:   loc *  exist *  algo *  size *  imp *
1.182     schwarze  221:
                    222: - The spacing characters `~', `^', and tab are currently ignored,
                    223:   see User's Guide (Second Edition) page 2 section 4.
1.184     schwarze  224:   loc *  exist *  algo **  size *  imp **
1.182     schwarze  225:
                    226: - Mark and lineup are parsed and ignored,
                    227:   see User's Guide (Second Edition) page 5 section 15.
1.184     schwarze  228:   loc **  exist **  algo **  size **  imp **
1.238     schwarze  229:
                    230: - GNU eqn converts some operators to special characters, for example,
                    231:   input HYPHEN-MINUS becomes output \(mi, unless it is part of a
                    232:   quoted word.  mandoc(1) only does this when the operator is
                    233:   surrounded by blanks, not when it is part of an unquoted word.
                    234:   Also, check whether there are more such cases (e.g., +?).
                    235:   reported by bentley@  20 Jun 2017 02:04:29 -0600
1.252     schwarze  236:   loc *  exist **  algo **  size *  imp *
1.182     schwarze  237:
1.239     schwarze  238: - Primes, opprime, and '
                    239:   bentley@  Thu, 13 Jul 2017 23:14:20 -0600
                    240:
1.79      schwarze  241: --- missing misc features ----------------------------------------------
1.301     schwarze  242:
                    243: - -T man does not handle eqn(7) and tbl(7)
                    244:   Stephen Gregoratto 16 Feb 2020 01:28:07 +1100
                    245:   loc **  exist **  algo **  size ***  imp **
1.255     schwarze  246:
                    247: - man -ks 1,8 route; kn@ Jul 13, 2018 orally
1.159     schwarze  248:
                    249: - italic correction (\/) in PostScript mode
                    250:   Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
1.184     schwarze  251:   loc **  exist **  algo *  size *  imp *
1.153     schwarze  252:
1.210     schwarze  253: - change the default PAGER to more -Es and use the pager
                    254:   even for apropos title line output; req by bapt@
                    255:   loc *  exist *  algo *  size *  imp ***
1.171     schwarze  256:
1.79      schwarze  257: - clean up escape sequence handling, creating three classes:
                    258:   (1) fully implemented, or parsed and ignored without loss of content
                    259:   (2) unimplemented, potentially causing loss of content
                    260:       or serious mangling of formatting (e.g. \n) -> ERROR
                    261:       see textproc/mgdiff(1) for nice examples
                    262:   (3) undefined, just output the character -> perhaps WARNING
1.184     schwarze  263:   loc ***  exist **  algo **  size **  imp *** (parser reorg helps)
1.83      schwarze  264:
1.174     schwarze  265: - kettenis wants base roff, ms, and me  Fri, 1 Jan 2010 22:13:15 +0100 (CET)
1.184     schwarze  266:   loc **  exist **  algo **  size ***  imp *
1.174     schwarze  267:
                    268: --- compatibility checks -----------------------------------------------
1.196     schwarze  269:
1.174     schwarze  270: - is .Bk implemented correctly in modern groff?
                    271:   sobrado@  Tue, 19 Apr 2011 22:12:55 +0200
                    272:
1.175     schwarze  273: - compare output to Heirloom roff, Solaris roff, and
                    274:   http://repo.or.cz/w/neatroff.git  http://litcave.rudi.ir/
1.178     schwarze  275:
                    276: - look at AT&T DWB http://www2.research.att.com/sw/download
                    277:   Carsten Kunze <carsten dot kunze at arcor dot de> has patches
                    278:   Mon, 4 Aug 2014 17:01:28 +0200
1.230     schwarze  279:   ported version: https://github.com/n-t-roff/DWB3.3
                    280:   Carsten Kunze  Wed, 22 Apr 2015 11:21:43 +0200
1.174     schwarze  281:
1.79      schwarze  282: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
                    283:   These are a weird mixture of man(7) and custom autogenerated low-level
                    284:   roff stuff.  Figure out to what extent we can cope.
1.80      schwarze  285:   For details, see http://docutils.sourceforge.net/rst.html
1.79      schwarze  286:   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
                    287:   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
1.160     schwarze  288:
1.174     schwarze  289: - look at pages generated from ronn(1) github.com/rtomayko/ronn
                    290:   (based on markdown)
                    291:
1.160     schwarze  292: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
                    293:   First impression is not that bad.
1.172     schwarze  294:
                    295: - look at pages generated by pandoc; see
                    296:   https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
                    297:   porting planned by kili@  Thu, 19 Jun 2014 19:46:28 +0200
1.71      schwarze  298:
                    299: - check compatibility with Plan9:
                    300:   http://swtch.com/usr/local/plan9/tmac/tmac.an
                    301:   http://swtch.com/plan9port/man/man7/man.html
                    302:   "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63      schwarze  303:
1.207     schwarze  304: - check compatibility with COHERENT troff:
                    305:   http://www.nesssoftware.com/home/mwc/source.php
                    306:
1.174     schwarze  307: - check compatibility with the man(7) formatter
                    308:   https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
                    309:
1.186     schwarze  310: - check compatibility with
                    311:   http://ikiwiki.info/plugins/contrib/mandoc/
                    312:   https://github.com/schmonz/ikiwiki/compare/mandoc
                    313:   Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
1.295     schwarze  314:
                    315: - check compatibility with
                    316:   https://git.sr.ht/~sircmpwn/scdoc
1.186     schwarze  317:
1.230     schwarze  318: - check features of the Slackware man.conf(5) format
                    319:   Carsten Kunze  Wed, 11 Mar 2015 17:57:24 +0100
                    320:
1.1       kristaps  321: ************************************************************************
                    322: * formatting issues: ugly output
                    323: ************************************************************************
1.87      kristaps  324:
1.195     schwarze  325: - revisit empty in-line macros
                    326:   look at the difference between "Em x Em ." and "Sq x Em ."
                    327:   Carsten Kunze  Fri, 12 Dec 2014 00:15:41 +0100
                    328:   loc *** exist *** algo *** size * imp **
                    329:
                    330: - a column list with blank `Ta' cells triggers a spurious
1.87      kristaps  331:   start-with-whitespace printing of a newline
1.195     schwarze  332:
                    333: - In .Bl -column, .It a<tab>"b<tab>c"
                    334:   shows the quotes in groff, but not in mandoc
                    335:   loc * exist *** algo ** size * imp **
1.1       kristaps  336:
1.39      schwarze  337: - In .Bl -column,
                    338:   .It Em Authentication<tab>Key Length
                    339:   ought to render "Key Length" with emphasis, too,
                    340:   see OpenBSD iked.conf(5).
1.123     schwarze  341:   reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.184     schwarze  342:   loc *  exist ***  algo ***  size **  imp ***
1.39      schwarze  343:
1.1       kristaps  344: - empty phrases in .Bl column produce too few blanks
                    345:   try e.g. .Bl -column It Ta Ta
                    346:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.184     schwarze  347:   loc *  exist ***  algo ***  size *  imp **
1.48      schwarze  348:
1.83      schwarze  349: - .%T can have trailing punctuation.  Currently, it puts the trailing
                    350:   punctuation into a trailing MDOC_TEXT element inside its own scope.
                    351:   That element should rather be outside its scope, such that the
                    352:   punctuation does not get underlines.  This is not trivial to
                    353:   implement because .%T then needs some features of in_line_eoln() -
                    354:   slurp all arguments into one single text element - and one feature
                    355:   of in_line() - put trailing punctuation out of scope.
                    356:   Found in mount_nfs(8) and exports(5), search for "Appendix".
1.184     schwarze  357:   loc **  exist **  algo ***  size *  imp **
1.83      schwarze  358:
1.147     schwarze  359: - Trailing punctuation after .%T triggers EOS spacing, at least
                    360:   outside .Rs (eek!).  Simply setting ARGSFL_DELIM for .%T is not
                    361:   the right solution, it sends mandoc into an endless loop.
                    362:   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
1.184     schwarze  363:   loc *  exist **  algo **  size *  imp **
1.147     schwarze  364:
1.174     schwarze  365: - global variables in the SYNOPSIS of section 3 pages
                    366:   .Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...
                    367:   from kristaps@  Tue, 08 Jun 2010 11:13:32 +0200
1.239     schwarze  368:
                    369: - implicit whitespace around inline equations
                    370:   example code:  where '$times$' denotes matrix multiplication
                    371:   must not have an HTML line break, nor a blank, before <math>
                    372:   partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT},
                    373:   bentley@  Thu, 13 Jul 2017 19:00:59 -0600
1.174     schwarze  374:
1.48      schwarze  375: - in enclosures, mandoc sometimes fancies a bogus end of sentence
                    376:   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
1.184     schwarze  377:   loc *  exist **  algo ***  size *  imp ***
1.197     schwarze  378:
                    379: - a line starting with "\fB something" counts as starting with whitespace
                    380:   and triggers a line break; found in audio/normalize-mp3(1)
1.287     schwarze  381:   This will become easier once escape sequences are represented
                    382:   by syntax tree nodes.
1.197     schwarze  383:   loc **  exist *  algo **  size *  imp **
1.149     schwarze  384:
                    385: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
                    386:   reveals lots of bugs both in groff and mandoc...
                    387:   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
1.171     schwarze  388:
1.230     schwarze  389: --- PostScript and PDF issues ------------------------------------------
1.171     schwarze  390:
                    391: - PDF output doesn't use a monospaced font for .Bd -literal
                    392:   Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
                    393:   Search the text "Routing tables".
                    394:   Also check what PostScript mode does when fixing this.
                    395:   reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
1.186     schwarze  396:   instructions from juanfra@  Wed, 11 Jun 2014 02:21:01 +0200
                    397:     add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
                    398:     and change the /Name from /F0 to the new font (/F5 (?)).
1.230     schwarze  399:   re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100
1.186     schwarze  400:   loc *  exist **  algo **  size *  imp **
1.173     schwarze  401:
                    402: --- HTML issues --------------------------------------------------------
1.297     schwarze  403:
                    404: - get rid of the last handful of style= attributes such that
                    405:   Content-Security-Policy: can be enabled without unsafe-inline
                    406:   suggested by bentley@  Nov 10, 2019 at 06:02:49AM -0700
                    407:   loc *  exist *  algo *  size *  imp **
1.214     schwarze  408:
                    409: - .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
                    410:   space, see for example random(3).  Introduced in
                    411:   http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92
                    412:   reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
                    413:   loc **  exist **  algo **  size *  imp *
1.180     schwarze  414:
1.187     schwarze  415: - jsg on icb, Nov 3, 2014:
                    416:   try to guess Xr in man(7) for hyperlinking
1.226     schwarze  417:   and render them with <a class="Xr" href=...>
                    418:   https://github.com/Debian/debiman/issues/15
                    419:   loc *  exist *  algo **  size **  imp **
1.296     schwarze  420:
                    421: - space characters can end up in href= attributes, for example coming
                    422:   from the first .Xr argument (where they make no sense, but still);
                    423:   does this affect other characters, other source macros...?
                    424:   Jackson Pauls  29 Aug 2017 16:56:27 +0100
1.187     schwarze  425:
1.180     schwarze  426: - The tables used to render the three-part page headers actually force
                    427:   the width of the <body> to the max-width given for <html>.
                    428:   Not yet sure how to fix that...
                    429:   Observed by an Anonymous Coward on undeadly.org:
                    430:   http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
1.184     schwarze  431:   loc *  exist *  algo **  size *  imp ***
1.206     schwarze  432:
                    433: - generate <img> tags in HTML
                    434:   idea from florian@  Tue, 7 Apr 2015 00:26:28 +0000
                    435:   may be possible to implement with .Lk img://something.png alt_text
1.174     schwarze  436:
1.173     schwarze  437: - check https://github.com/trentm/mdocml
1.35      kristaps  438:
1.1       kristaps  439: ************************************************************************
1.104     kristaps  440: * formatting issues: gratuitous differences
1.1       kristaps  441: ************************************************************************
1.187     schwarze  442:
                    443: - .Fn reopens a new scope after punctuation in mandoc,
                    444:   but closes its scope for good in groff.
                    445:   Do we want to change mandoc or groff?
                    446:   Steffen Nurpmeso  Sat, 08 Nov 2014 13:34:59 +0100
                    447:   loc *  exist **  algo **  size *  imp **
1.230     schwarze  448:
1.174     schwarze  449: - In .Bl -enum -width 0n, groff continues one the same line after
                    450:   the number, mandoc breaks the line.
                    451:   mail to kristaps@  Mon, 20 Jul 2009 02:21:39 +0200
1.184     schwarze  452:   loc *  exist **  algo **  size *  imp **
1.174     schwarze  453:
1.103     schwarze  454: - .Pp between two .It in .Bl -column should produce one,
                    455:   not two blank lines, see e.g. login.conf(5).
                    456:   reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
1.129     schwarze  457:   reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.184     schwarze  458:   loc *  exist ***  algo **  size *  imp **
1.39      schwarze  459:
1.83      schwarze  460: - If the *first* line after .It is .Pp, break the line right after
                    461:   the tag, do not pad with space characters before breaking.
                    462:   See the description of the a, c, and i commands in sed(1).
1.184     schwarze  463:   loc *  exist **  algo **  size *  imp **
1.83      schwarze  464:
                    465: - If the first line after .It is .D1, do not assert a blank line
                    466:   in between, see for example tmux(1).
                    467:   reported by nicm@  13 Jan 2011 00:18:57 +0000
1.184     schwarze  468:   loc *  exist **  algo **  size *  imp **
1.147     schwarze  469:
                    470: - Trailing punctuation after .It should trigger EOS spacing.
                    471:   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
                    472:   Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.184     schwarze  473:   loc *  exist **  algo **  size *  imp **
1.83      schwarze  474:
                    475: - When the -width string contains macros, the macros must be rendered
                    476:   before measuring the width, for example
                    477:     .Bl -tag -width ".Dv message"
                    478:   in magic(5), located in src/usr.bin/file, is the same
                    479:   as -width 7n, not -width 11n.
1.129     schwarze  480:   The same applies to .Bl -column column widths;
                    481:   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157     schwarze  482:   reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
1.234     schwarze  483:   reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@
1.184     schwarze  484:   loc ***  exist ***  algo ***  size **  imp ***
1.157     schwarze  485:   An easy partial fix would be to just skip the first word if it starts
                    486:   with a dot, including any following white space, when measuring.
1.184     schwarze  487:   loc *  exist *  algo *  size *  imp ***
1.83      schwarze  488:
1.56      schwarze  489: - The \& zero-width character counts as output.
                    490:   That is, when it is alone on a line between two .Pp,
                    491:   we want three blank lines, not two as in mandoc.
1.184     schwarze  492:   loc **  exist **  algo **  size *  imp **
1.83      schwarze  493:
1.205     schwarze  494: - Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
                    495:   with .ps and .nf/.fi produce execessive blank lines, see libJudy
1.207     schwarze  496:   and graphics/dcmtk.  The parser reorg may help with this.
1.83      schwarze  497:
                    498: - trailing whitespace must be ignored even when followed by a font escape,
1.198     schwarze  499:   see for example
1.83      schwarze  500:     makes
                    501:     \fBdig \fR
                    502:     operate in batch mode
                    503:   in dig(1).
1.184     schwarze  504:   loc **  exist **  algo **  size *  imp **
1.166     schwarze  505:
                    506: ************************************************************************
                    507: * warning issues
                    508: ************************************************************************
1.251     schwarze  509:
                    510: - warn about duplicate .Sh/.Ss heads
                    511:   gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200
1.252     schwarze  512:   loc *  exist *  algo *  size *  imp **
1.216     schwarze  513:
1.245     schwarze  514: - style message about macros inside .Bd -literal and .Dl, in particular
                    515:   font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO)
                    516:
1.246     schwarze  517: - style message about mismatches between the section number in the
                    518:   file name (if it is known) and the section number in .Dt
                    519:   (from the mdoclint TODO)
                    520:
1.245     schwarze  521: - style message about NULL without .Dv (from the mdoclint TODO)
                    522:
                    523: - style message about error constants without .Er (from the mdoclint TODO)
                    524:
1.211     schwarze  525: - warn when .Sh or .Ss contain other macros
                    526:   Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034
1.210     schwarze  527:   loc *  exist *  algo *  size *  imp **
1.188     schwarze  528:
1.245     schwarze  529: - style message about violations of the convention
1.246     schwarze  530:   .An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO)
1.245     schwarze  531:
1.188     schwarze  532: - warn about attempts to call non-callable macros
                    533:   Steffen Nurpmeso  Tue, 11 Nov 2014 22:55:16 +0100
                    534:   Note that formatting is inconsistent in groff.
                    535:   .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
                    536:   Relatively hard because the relevant code is scattered
                    537:   all over mdoc_macro.c and all subtly different.
                    538:   loc **  exist **  algo **  size **  imp **
1.245     schwarze  539:
1.246     schwarze  540: - warn about punctuation - e.g. ',' and ';' - at the beginning
                    541:   of a text line, if it is likely intended to follow the preceding
                    542:   output without intervening whitespace, in particular after a
                    543:   macro line (from the mdoclint TODO)
1.257     schwarze  544:
                    545: - makewhatis -p complains about language subdirectories:
                    546:   /usr/local/man//ru: Unknown directory part
                    547:
1.174     schwarze  548:
                    549: ************************************************************************
                    550: * documentation issues
                    551: ************************************************************************
                    552:
                    553: - mark macros as: page structure domain, manual domain, general text domain
                    554:   is this useful?
                    555:
                    556: - mention /usr/share/misc/mdoc.template in mdoc(7)?
1.185     schwarze  557:
                    558: - Is all the content from http://www.std.com/obi/BSD/doc/usd/28.tbl/tbl
                    559:   covered in tbl(7)?
1.1       kristaps  560:
1.9       kristaps  561: ************************************************************************
                    562: * performance issues
                    563: ************************************************************************
                    564:
1.37      kristaps  565: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115     kristaps  566:
1.23      kristaps  567: ************************************************************************
                    568: * structural issues
                    569: ************************************************************************
1.221     schwarze  570:
                    571: - POSIX says in the documentation of sysconf(3) that PATH_MAX
                    572:   is allowed to be so large that it is a bad idea to use it
                    573:   for sizing static buffers.  So use dynamic buffers throughout.
                    574:   See the file test-PATH_MAX.c for details.
                    575:   Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,
                    576:   https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624
1.67      schwarze  577:
1.241     schwarze  578: - Is it possible to further simplify ENDBODY_SPACE?
                    579:
1.67      schwarze  580: - Find better ways to prevent endless loops
                    581:   in roff(7) macro and string expansion.
1.241     schwarze  582:
                    583: - make buffers for parsing functions const
                    584:   christos@ via wiz@  Fri, 18 Dec 2015 17:10:01 +0100
1.186     schwarze  585:
                    586: - struct mparse refactoring
                    587:   Steffen Nurpmeso  Thu, 04 Sep 2014 12:50:00 +0200
1.170     schwarze  588:
1.179     kristaps  589: ************************************************************************
                    590: * CGI issues
                    591: ************************************************************************
                    592:
1.302     schwarze  593:  - Inspect httpd(8) logs on man.openbsd.org and consider
                    594:    whether logging can be improved, where bad syntax comes from,
                    595:    and what needs to be done to get rid of COMPAT_OLDURI.
1.179     kristaps  596:  - Enable HTTP compression by detecting gzip encoding and filtering
                    597:    output through libz.
1.256     schwarze  598:  - Privilege separation (see OpenSSH).
1.179     kristaps  599:  - Enable caching support via HTTP 304 and If-Modified-Since.
1.181     kristaps  600:
1.192     schwarze  601: ************************************************************************
                    602: * to improve in the groff_mdoc(7) macros
                    603: ************************************************************************
1.298     schwarze  604:
                    605: - delete OS release verification from .Dx, .Fx, .Nx, .Ox etc.
                    606:   https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=629161
                    607:   also Branden Robinson 18 Dec 2019 00:59:52 +1100
1.299     schwarze  608:
                    609: - Can the distinction between .Vt and .Va be made stricter,
                    610:   recommending .Vt extern char * Ns Va optarg ; ?
                    611:   What about the block macro properties of .Vt in the SYNOPSIS?
                    612:   zeurkous 25 Dec 2019 08:48:36 +0100
1.252     schwarze  613:
                    614: - .Cd # arch1, arch2 in section 4 pages:
                    615:   find better way to indicate multiple architectures, maybe:
                    616:   allow .Dt vgafb 4 "macppc sparc64"
                    617:   already shown as "Device Drivers Manual (macppc sparc64)"
                    618:   for apropos, make that "vgafb(4) - macppc # sparc64" instead of "- all"
                    619:   groff can be made to show multiple arches, too, but it is
                    620:   tedious to do the string parsing in roff code...
                    621:   jmc@ 23 Apr 2018 07:24:52 +0100 [man for vgafb(4)...]
                    622:   loc **  exist **  algo *  size *  imp ***
1.192     schwarze  623:
                    624: - use uname(1) to set doc-default-operating-system at install time
                    625:   tobimensch  Mon, 1 Dec 2014 00:25:07 +0100
1.236     schwarze  626:
                    627: - apostrophe (39), circumflex (94), grave (96), tilde (126)
                    628:   in manuals: \(aq, \(ha, \`, \(ti
                    629:   Re: [Groff] ASCII Minus Sign in man Pages.
                    630:   bentley@ 26 Apr 2017 10:02:06 -0600
                    631:   Do we need to fix existing manuals?
                    632:   Do we need to fix the definition of the mdoc(7) language?

CVSweb