mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.63 and 1.82

-version 1.63, 2010/10/29 13:05:27
+version 1.82, 2011/01/23 15:35:10
 Line 7
 Line 7
 Line 7
  * parser bugs
  ************************************************************************
+ - .TP before .SH is still FATAL in man(7)
+   reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500
  - the roff parser doesn't tolerate additional characters between
    a macro and the \} terminating a conditional block, e.g.
    .if n \{
    .br \}
    reported by ulrich spoerlein  Tue, 19 Oct 2010 20:39:50 +0200
- - .BI "string string " word punct in gettext(3)
+ ************************************************************************
-   add bogus line breaks (rep by naddy@)
+ * formatter bugs
-   committed; currently working on IP and TP?
+ ************************************************************************
-   and what about B and I?
  ************************************************************************
  * 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
+ - .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@
+ - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
+   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
+ - pod2man expects `tr' to be implemented for \*(-- to work
+ --- missing mdoc features ----------------------------------------------
  - fix bad block nesting involving multiple identical explicit blocks
    see the OpenBSD mdoc_macro.c 1.47 commit message
-Line 40
+Line 65
 Line 40
 Line 65
    .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
    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.
- - implement basic non-parametric .de to support e.g. sox(1)
-   .de SP
-   .if t .sp .5
-   .if n .sp
-   ..
-   .de EX
-   .SP
-   .nf
-   .ft CW
-   ..
-   .de EE
-   .ft R
-   .SP
-   .fi
-   ..
-   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
- - 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
- - port OpenBSD tbl integration bsd.lv, probably cleaning it up
- - 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
    .Bl -column
    .It foo Ta bar
-Line 106
+Line 99
 Line 106
 Line 99
    (e.g., NetBSD mDNSShared/dns-sd.1)
    (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
- - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
+ --- missing man features -----------------------------------------------
-   noted by Alex Kozlov 08/06/10 23:05
- - Have `Sh', `It', `Ss' and others complain if `Pp' is invoked prior to
-   close (in the post validation) or prior to open (pre).  This noted by
-   jmc@ a thousand years ago.
- - xloadimage(1) wants .ti (temporary indent), rep by naddy@
  - bashbug(1) complains "line scope broken" after
    .SM
    .B something
    should either just work or be a warning
    reported by naddy@
+ - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
+   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
+ --- 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
+ --- 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
+ - 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
  ************************************************************************
+ - 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
  - perl(1) SYNOPSIS looks bad; reported by deraadt@
 ) man(7) seems to need SYNOPSIS .Nm blocks, too
-Line 144
+Line 165
 Line 144
 Line 165
  * formatting issues: gratuitious 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.
  - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
    is just "o\bo".
-Line 160
+Line 181
 Line 160
 Line 181
  - 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).
+   Also have `It' complain if `Pp' is invoked at certain times (not
+   -compact?).
- - .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).
  - .Nx 1.0a
    should be "NetBSD 1.0A", not "NetBSD 1.0a",
    see OpenBSD ccdconfig(8).
-Line 182
+Line 200
 Line 182
 Line 200
    should be indented, see e.g. rpc(3);
    reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
- - It seems that .TP does not want TWOSPACE after the tag;
+ - Header lines of excessive length:
-   see bashbug(1); reported by naddy@
+   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
  ************************************************************************
+ * error reporting issues
+ ************************************************************************
+ ************************************************************************
  * performance issues
  ************************************************************************
-Line 200  Several areas can be cleaned up to make mandoc even fa
+Line 224  Several areas can be cleaned up to make mandoc even fa
 Line 200  Several areas can be cleaned up to make mandoc even fa
 Line 224  Several areas can be cleaned up to make mandoc even fa
  ************************************************************************
  * structural issues
  ************************************************************************
+ - Find better ways to prevent endless loops
+   in roff(7) macro and string expansion.

CVSweb