Annotation of mandoc/TODO, Revision 1.1
1.1 ! kristaps 1:
! 2: Before trying to fix anything from this list,
! 3: check against -current mandoc from OpenBSD CVS.
! 4: Sometimes, i'm a bit behind marking entries FIXED.
! 5:
! 6: In general, i keep FIXED entries for some time
! 7: and remove them when they turn into old news.
! 8:
! 9: ************************************************************************
! 10: * missing features
! 11: ************************************************************************
! 12:
! 13: - explicit blocks with missing end macro should be implicitely closed
! 14: at the end of the enclosing block, e.g. .Bl It (El) Sh
! 15: reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
! 16:
! 17: - .Bl -column .Xo support is missing
! 18: ultimate goal:
! 19: restore .Xr and .Dv to
! 20: lib/libc/compat-43/sigvec.3
! 21: lib/libc/gen/signal.3
! 22: lib/libc/sys/sigaction.2
! 23:
! 24: - .Bk / .Ek is broken, e.g.
! 25: $ man ssh
! 26: [...]
! 27: ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-b bind_address] [-c cipher_spec] [-D
! 28: [bind_address:]port] [-e escape_char] [-F configfile] [-I pkcs11]
! 29: reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
! 30: also reported by jmc@ earlier
! 31:
! 32: - man(7) .TH should recognize "3p" as a section number
! 33: found in usr.bin/pkg_add OpenBSD::Getopt
! 34:
! 35: - implement \\
! 36: in plain text, identical to \e
! 37: as a macro argument, identical to \ i.e. escaping the next character
! 38: We do not have macro definitions yet; if we implement them,
! 39: \\ must behave in a macro def like in a macro argument,
! 40: and when using the macro, it must expand yet again.
! 41:
! 42: - look at bsd.lv tbl(1)
! 43: from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200
! 44:
! 45: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
! 46: These are a weird mixture of man(7) and custom autogenerated low-level
! 47: roff stuff. Figure out to what extent we can cope.
! 48: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
! 49: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
! 50:
! 51:
! 52: - FIXED OpenBSD term.h 1.16 term.c 1.30 mdoc_term.c 1.75 schwarze 23.4.10
! 53: handle tab characters outside literal context, e.g. usb(4)
! 54: reported by jmc@ Mon, 19 Apr 2010 07:42:12 +0100
! 55:
! 56: - FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9
! 57: man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15
! 58: man_term.c 1.28 man_html.c 1.9 schwarze 25.4.
! 59: implement .if .ie .el
! 60: noticed by espie@ Fri, 23 Apr 2010 17:10:35 +0200
! 61:
! 62: - FIXED bsd.lv libman.h 1.31 libmdoc.h 1.34 man.c 1.60 mdoc.c 1.123
! 63: kristaps@ 8.4.10
! 64: FIXED OpenBSD libman.h 1.17 libmdoc.h 1.28 man.c 1.26 mdoc.c 1.45
! 65: schwarze@ 8.5.10
! 66: groff handles \." just like .\"
! 67: Thus, mandoc must also ignore such lines.
! 68: For an example, see tr(1).
! 69: reported by Claus Assmann Mon, 5 Apr 2010 08:46:30 -0700
! 70:
! 71:
! 72: ************************************************************************
! 73: * formatting issues: ugly output
! 74: ************************************************************************
! 75:
! 76: - outside list context, text following .Sm off
! 77: seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
! 78: .Sm off
! 79: .Xo
! 80: .Op Ar bind_address No /
! 81: .Ar port
! 82: .Xc
! 83: .Sm on
! 84: or by enclosing
! 85: reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
! 86:
! 87: - do not break the line after "--", it's probably a long option
! 88: reminded by stsp in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
! 89:
! 90: - in .Bl -column .It, "\t" seems to be synonymous to " Ta ",
! 91: see sysctl(3) for many examples;
! 92: mishandling this results in spurious quotes at EOL
! 93: reminded by guenther@ Mon, 26 Apr 2010 01:16:52 -0700
! 94:
! 95: - URGENT, this is making many kernel manuals look bad:
! 96: .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
! 97: autoconf.9:
! 98: .Sh DIRECT CONFIGURATION
! 99: .nr nS 1
! 100: .Ft "struct device *"
! 101: .Fn config_found_sm "struct device *parent"
! 102: groff:
! 103: DIRECT CONFIGURATION
! 104: struct device *
! 105: config_found_sm(struct device *parent, ...
! 106: reported by sthen Tue, 20 Apr 2010 13:42:51 +0100
! 107:
! 108: - indentation got lost in SYNOPSIS, e.g.
! 109: SYNOPSIS
! 110: date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
! 111: - [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
! 112: + [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
! 113: reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
! 114:
! 115: - empty phrases in .Bl column produce too few blanks
! 116: try e.g. .Bl -column It Ta Ta
! 117: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
! 118:
! 119:
! 120: - FIXED on bsd.lv for mdoc, need to merge and test in OpenBSD
! 121: kristaps@ Mon, 10 May 2010 03:12:44 +0200
! 122: man fix still pending!
! 123: in literal displays, ignore the right margin
! 124: reminded by stsp in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
! 125:
! 126: - FIXED on bsd.lv, need to merge and test in OpenBSD
! 127: kristaps@ Mon, 10 May 2010 02:59:40 +0200
! 128: do not mark \*(Ba and | up
! 129: e.g. .Op Fl c Ar string \*(Ba Fl s \*(Ba Ar file Op Ar argument ...
! 130: The first should not be in an .Ar font.
! 131: The second must not end up as -|.
! 132: When fixing, check whether this is a specific problem with this
! 133: character, or whether other characters are affected, too.
! 134: reminded by jmc@ Sat, 24 Apr 2010 06:54:26 +0100
! 135:
! 136:
! 137: ************************************************************************
! 138: * formatting issues: gratuitious differences
! 139: ************************************************************************
! 140:
! 141: - in literal context, groff disables the right margin
! 142: an example: syslog.conf.5 EXAMPLES section
! 143: reported by jmc Tue, 13 Apr 2010 10:12:15 +0100
! 144: solution: raise termp->maxrmargin in literal context
! 145:
! 146: - lines containing blank characters, and nothing else,
! 147: in literal context (.Bd -literal):
! 148: groff outputs just blank lines "\n"
! 149: mandoc outputs blanks to the left margin,
! 150: then the number of balnks minus one
! 151:
! 152:
! 153: - FIXED bsd.lv mdoc_html.c 1.61 mdoc_term.c 1.117 kristaps@ 8.4.10
! 154: FIXED OpenBSD mdoc_html.c 1.12 mdoc_term.c 1.76 schwarze@ 8.5.10
! 155: mandoc .%T changed from quoted to underlined
! 156: reported by jmc Mon, 10 Aug 2009 05:50:21 +0100
! 157:
! 158:
! 159: ************************************************************************
! 160: * parser errors without any effect on formatting
! 161: ************************************************************************
! 162:
! 163: - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree
! 164:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to TODO CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc