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

Diff for /mandoc/TODO between version 1.42 and 1.143

version 1.42, 2010/08/20 22:51:29 version 1.143, 2012/10/12 16:45:34
Line 7 
Line 7 
 * missing features  * missing features
 ************************************************************************  ************************************************************************
   
 - explicit blocks with missing end macro should be implicitely closed  --- missing roff features ----------------------------------------------
   at the end of the enclosing block, e.g. .Bl It (El) Sh  
   reminded by stsp@  in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200  
   
   - roff.c should treat \n(.H>23 and \n(.V>19 in the pod2man(1)
     preamble as true, see for example AUTHORS in MooseX::Getopt.3p
     reported by Andreas Voegele <mail at andreasvoegele dot com>
     Tue, 22 Nov 2011 15:34:47 +0100 on ports@
   
   - .ad (adjust margins)
     .ad l -- adjust left margin only (flush left)
     .ad r -- adjust right margin only (flush right)
     .ad c -- center text on line
     .ad b -- adjust both margins (alias: .ad n)
     .na   -- temporarily disable adjustment without changing the mode
     .ad   -- re-enable adjustment without changing the mode
     Adjustment mode is ignored while in no-fill mode (.nf).
   
   - .it (line traps) occur in mysql(1), yasm_arch(7)
     generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
     reported by brad@  Sat, 15 Jan 2011 15:48:18 -0500
   
   - .ns (no-space mode) occurs in xine-config(1)
     reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
   
   - xloadimage(1) wants .ti (temporary indent), rep by naddy@
     reported again by bentley@ in nmh(1)  Mon, 23 Apr 2012 13:38:28 -0600
     also uses .ce (center N lines) and .fc (field control)
   
   - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
     reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
   
   - \c (interrupted text) should prevent the line break
     even inside .Bd literal; that occurs in chat(8)
   
   - using undefined strings or macros defines them to be empty
     wl@  Mon, 14 Nov 2011 14:37:01 +0000
   
   --- missing mdoc features ----------------------------------------------
   
 - fix bad block nesting involving multiple identical explicit blocks  - fix bad block nesting involving multiple identical explicit blocks
   see the OpenBSD mdoc_macro.c 1.47 commit message    see the OpenBSD mdoc_macro.c 1.47 commit message
   
Line 25 
Line 59 
   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)    .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100    from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
   
 - auto-Bk in the SYNOPSIS  - \\ is now implemented correctly
   patch from kristaps@  Fri, 16 Jul 2010 14:51:24 +0200    * when defining strings and macros using .ds and .de
   to be revisited after OpenBSD 4.8 tree unlock    * when parsing roff(7) and man(7) macro arguments
     It does not yet work in mdoc(7) macro arguments
     because libmdoc does not yet use mandoc_getarg().
     Also check what happens in plain text, it must be identical to \e.
   
 - implement \\  - .Bd -filled should not be the same as .Bd -ragged, but align both
   in plain text, identical to \e    the left and right margin.  In groff, it is implemented in terms
   as a macro argument, identical to \ i.e. escaping the next character    of .ad b, which we don't have either.  Found in cksum(1).
   We do not have macro definitions yet; if we implement them,  
   \\ must behave in a macro def like in a macro argument,  
   and when using the macro, it must expand yet again.  
   
 - look at bsd.lv tbl(1)  
   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200  
   also look at the mail from Thomas Klausner wiz at NetBSD  
     on Wed, 2 Jun 2010 11:01:29 +0200  
   joerg@ has patches for this somewhere...  
   
 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)  
   These are a weird mixture of man(7) and custom autogenerated low-level  
   roff stuff.  Figure out to what extent we can cope.  
   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200  
   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100  
   
 - implement blank `Bl -column', such as  - implement blank `Bl -column', such as
   .Bl -column    .Bl -column
   .It foo Ta bar    .It foo Ta bar
Line 56 
Line 78 
 - explicitly disallow nested `Bl -column', which would clobber internal  - explicitly disallow nested `Bl -column', which would clobber internal
   flags defined for struct mdoc_macro    flags defined for struct mdoc_macro
   
   - In .Bl -column .It, the end of the line probably has to be regarded
     as an implicit .Ta, if there could be one, see the following mildly
     ugly code from login.conf(5):
       .Bl -column minpasswordlen program xetcxmotd
       .It path Ta path Ta value of Dv _PATH_DEFPATH
       .br
       Default search path.
     reported by Michal Mazurek <akfaew at jasminek dot net>
     via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
   
 - inside `.Bl -column' phrases, punctuation is handled like normal  - inside `.Bl -column' phrases, punctuation is handled like normal
   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."    text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
   
Line 71 
Line 103 
   (e.g., NetBSD mDNSShared/dns-sd.1)    (e.g., NetBSD mDNSShared/dns-sd.1)
   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)    (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
   
 - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments  - When there is free text in the SYNOPSIS and that free text contains
   noted by Alex Kozlov 08/06/10 23:05    the .Nm macro, groff somehow understands to treat the .Nm as an in-line
     macro, while mandoc treats it as a block macro and breaks the line.
     No idea how the logic for distinguishing in-line and block instances
     should be, needs investigation.
     uqs@  Thu, 2 Jun 2011 11:03:51 +0200
     uqs@  Thu, 2 Jun 2011 11:33:35 +0200
   
 - 'br\} doesn't correctly close scope.  --- missing man features -----------------------------------------------
   Noted by joerg@, 28/7/2010.  
   - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
     reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
   
   - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
   
   --- missing tbl features -----------------------------------------------
   
   - implement basic non-parametric .de to support e.g. sox(1)
     reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
     *** sox(1) still doesn't work, tbl(1) errors need investigation
   
   - allow standalone `.' to be interpreted as an end-of-layout
     delimiter instead of being thrown away as a no-op roff line
     reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
   
   --- missing misc features ----------------------------------------------
   
   - clean up escape sequence handling, creating three classes:
     (1) fully implemented, or parsed and ignored without loss of content
     (2) unimplemented, potentially causing loss of content
         or serious mangling of formatting (e.g. \n) -> ERROR
         see textproc/mgdiff(1) for nice examples
     (3) undefined, just output the character -> perhaps WARNING
   
   - The \t escape sequence is the same as a literal tab, see for example
     the ASCII table in hexdump(1) where
       .Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo
       .It \&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq
     produces
       000 nul  001 soh  002 stx  003 etx  004 eot  005 enq
     and the example in oldrdist(1)
   
   - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
     These are a weird mixture of man(7) and custom autogenerated low-level
     roff stuff.  Figure out to what extent we can cope.
     For details, see http://docutils.sourceforge.net/rst.html
     noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
     reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
   
   - check compatibility with Plan9:
     http://swtch.com/usr/local/plan9/tmac/tmac.an
     http://swtch.com/plan9port/man/man7/man.html
     "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
   
 ************************************************************************  ************************************************************************
 * formatting issues: ugly output  * formatting issues: ugly output
 ************************************************************************  ************************************************************************
   
 - perl(1) SYNOPSIS looks bad; reported by deraadt@  - a column list with blank `Ta' cells triggers a spurrious
   1) man(7) seems to need SYNOPSIS .Nm blocks, too    start-with-whitespace printing of a newline
   
   - double quotes inside double quotes are escaped by doubling them
     implement this in mdoc(7), too
     so far, we only have it in roff(7) and man(7)
     reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500
   
 - In .Bl -column,  - In .Bl -column,
   .It Em Authentication<tab>Key Length    .It Em Authentication<tab>Key Length
   ought to render "Key Length" with emphasis, too,    ought to render "Key Length" with emphasis, too,
   see OpenBSD iked.conf(5).    see OpenBSD iked.conf(5).
     reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
   
 - empty phrases in .Bl column produce too few blanks  - empty phrases in .Bl column produce too few blanks
   try e.g. .Bl -column It Ta Ta    try e.g. .Bl -column It Ta Ta
   reported by millert Fri, 02 Apr 2010 16:13:46 -0400    reported by millert Fri, 02 Apr 2010 16:13:46 -0400
   
 - %A doesn't put an "and" before the final author name.  - .%T can have trailing punctuation.  Currently, it puts the trailing
     punctuation into a trailing MDOC_TEXT element inside its own scope.
     That element should rather be outside its scope, such that the
     punctuation does not get underlines.  This is not trivial to
     implement because .%T then needs some features of in_line_eoln() -
     slurp all arguments into one single text element - and one feature
     of in_line() - put trailing punctuation out of scope.
     Found in mount_nfs(8) and exports(5), search for "Appendix".
   
   - in enclosures, mandoc sometimes fancies a bogus end of sentence
     reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
   
   - Trailing isolated dots lack EOS for some macros.
     This cannot use mandoc_eos() because groff only does EOS
     for isolated dots at least in some of these cases.
     Affected macros included those using in_line_eoln().
     Make sure to fix open(2)
     without breaking fstat(1), ksh(1), tzset(3) and UKC(8).
     reported by Nicolas Joly  Fri, 12 Oct 2012 17:00:36 +0200
   
 ************************************************************************  ************************************************************************
 * formatting issues: gratuitious differences  * formatting issues: gratuitous differences
 ************************************************************************  ************************************************************************
   
 - .%T should be quoted, not underlined, when .%J is also present,  - .Rv (and probably .Ex) print different text if an `Nm' has been named
   to better distinguish the contents of .%T and .%J,    or not (run a manual without `Nm blah' to see this).  I'm not sure
   see for example OpenBSD cat(1)    that this exists in the wild, but it's still an error.
   
 - .It ${name Ns [ selector ] Ns }  
   should be "${name[selector]}" not "${name [selector]}"  
   This is parsed as  
   text("${name") text("[") Ns() text(selector)...  
   Opening punctuation should not fall out of .Ns.  
   see for example OpenBSD csh(1)  
   
 - .%A should append the last author with " and " (if there are two)  
   or ", and " (if there are more), not ", "  
   see for example OpenBSD csh(1)  
   
 - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet  - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
   is just "o\bo".    is just "o\bo".
   see for example OpenBSD ksh(1)    see for example OpenBSD ksh(1)
   
 - .No text No ) is "text )", not "text)"  - .Pp between two .It in .Bl -column should produce one,
   see the terrible example    not two blank lines, see e.g. login.conf(5).
     case word in [[(]  pattern [| pattern] ... ) list ;; ] ... esac    reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
   in OpenBSD ksh(1)    reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
   
 - .Sm should *not* produce as a blank line in .Bd -literal  - If the *first* line after .It is .Pp, break the line right after
   see for example "Brace expansion" in OpenBSD ksh(1)    the tag, do not pad with space characters before breaking.
     See the description of the a, c, and i commands in sed(1).
   
 - The characters "|" and "\*(Ba" should never be bold,  - If the first line after .It is .D1, do not assert a blank line
   not even in the middle of a word, e.g. ".Cm b\*(Bac" in    in between, see for example tmux(1).
   "mknod [-m mode] name b|c major minor"    reported by nicm@  13 Jan 2011 00:18:57 +0000
   in OpenBSD ksh(1)  
   
 - A bogus .Pp between two .It must not produce a double blank line,  
   see between -R and -r in OpenBSD rm(1), before "update" in mount(8),  
   or in DIAGNOSTICS in init(8).  
   
 - .Bd -literal and .Bd -unfilled are *not* identical.  
   In -literal, tabs are 8 spaces.  
   In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.  
   See the CCDF_* display in OpenBSD ccdconfig(8).  
   
 - In .Bd -unfilled, .Pp should produce one blank line, not two;  
   see the ccd.conf display in OpenBSD ccdconfig(8).  
   
 - .Nx 1.0a  - .Nx 1.0a
   should be "NetBSD 1.0A", not "NetBSD 1.0a",    should be "NetBSD 1.0A", not "NetBSD 1.0a",
   see OpenBSD ccdconfig(8).    see OpenBSD ccdconfig(8).
Line 151 
Line 232 
   on the next line, it must be indented by -width, not width+1;    on the next line, it must be indented by -width, not width+1;
   see "rule block|pass" in OpenBSD ifconfig(8).    see "rule block|pass" in OpenBSD ifconfig(8).
   
 - When .%T is used outside an .Rs context and with a trailing comma,  - When the -width string contains macros, the macros must be rendered
   there is no point in rendering two commata,    before measuring the width, for example
   see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).      .Bl -tag -width ".Dv message"
     in magic(5), located in src/usr.bin/file, is the same
     as -width 7n, not -width 11n.
     The same applies to .Bl -column column widths;
     reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
   
 - When .%T is used outside an .Rs context and without a trailing comma,  - The \& zero-width character counts as output.
   no comma should be rendered at all,    That is, when it is alone on a line between two .Pp,
   see the first paragraph of the DESCRIPTION in OpenBSD exports(5).    we want three blank lines, not two as in mandoc.
   
 - Bogus .Pp before .Bl should not cause a double blank line,  - When .Fn arguments exceed one output line, all but the first
   see "The route utility provides the following simple commands:"    should be indented, see e.g. rpc(3);
   in OpenBSD route(8).    reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
     reported again by Nicolas Joly via wiz@  Sun, 18 Sep 2011 18:24:40 +0200
     Also, we don't want to break the line within the argument of:
     .Fa "chtype tl"
   
   - Header lines of excessive length:
     Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
     and document it in mdoc(7) and man(7) COMPATIBILITY
     found while talking to Chris Bennett
   
   - trailing whitespace must be ignored even when followed by a font escape,
     see for example
       makes
       \fBdig \fR
       operate in batch mode
     in dig(1).
   
 ************************************************************************  ************************************************************************
 * performance issues  * performance issues
 ************************************************************************  ************************************************************************
Line 175  Several areas can be cleaned up to make mandoc even fa
Line 275  Several areas can be cleaned up to make mandoc even fa
   
 - the PDF file is HUGE: this can be reduced by using relative offsets  - the PDF file is HUGE: this can be reduced by using relative offsets
   
   - instead of re-initialising the roff predefined-strings set before each
     parse, create a read-only version the first time and copy it
   
 ************************************************************************  ************************************************************************
 * structural issues  * structural issues
 ************************************************************************  ************************************************************************
   
 - rendering frontend code can calculate widths only for plain strings,  - We use the input line number at several places to distinguish
   not for strings containing escape sequences.  For example, this    same-line from different-line input.  That plainly doesn't work
   hinders calculation of the indent required for .Nm \&[ in text(1).    with user-defined macros, leading to random breakage.
   comments from kristaps@  Wed, 21 Jul 2010 23:26:08 +0200  
   
 - another example of the same problem:  - Find better ways to prevent endless loops
   .Bl -tag -width "\eD{format}XX" -compact    in roff(7) macro and string expansion.
   in OpenBSD ksh(1) gives the wrong width  
   because "\e" is one character in groff, two in mandoc  - Finish cleanup of date handling.
     Decide which formats should be recognized where.
 - Now that `ds' is minimally supported, we can get rid of some    Update both mdoc(7) and man(7) documentation.
   predefined strings.  \*(C+ has already been thrown out.  Track these    Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100
   down and whack them.  Look in e.g. gcc.1 for the top-level `ds'  
   invocations.  These are reproduced across most crappy GNU manuals.  
Legend:
Removed from v.1.42  
changed lines
  Added in v.1.143
CVSweb