mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.240 and 1.290

version 1.240, 2017/07/19 21:48:37

version 1.290, 2019/04/01 15:57:29

Line 52 are mere guesses, and some may be wrong.

found by naddy@ in xloadimage(1)

loc ** exist *** algo * size * imp *

- .nr third argument (auto-increment step size, requires \n+)

found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700

loc * exist * algo * size * imp **

- .ns (no-space mode) occurs in xine-config(1)

when implementing this, also let .TH set it

reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500

loc *** exist *** algo *** size ** imp *

- .while and .shift

found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200

loc * exist ** algo ** size ** imp **

- \n+ and \n- numerical register increment and decrement

found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700

loc * exist * algo * size * imp **

- \w'' improve width measurements

would not be very useful without an expression parser, see below

needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100

loc ** exist *** algo *** size * imp ***

- \\ in high-level macro arguments

Currently, \\ is expanded in two situations:

1) macro and string definition (roff.c setstrn())

2) macro argument parsing (mandoc.c mandoc_getarg())

For user defined macros, the second happens in time because of ROFF_REPARSE.

But for standard high-level macros, it only happens after entering the

high level parsers, which is too late because the code doesn't get

back to roff.c roff_res() from that point. Because this requires

distinguishing requests, user-defined macros and standard macros

on the roff_res() level, it is hard to solve without the parser reorg.

Found by naddy@ in devel/cutils cobfusc(1) Mon, 16 Feb 2015 19:10:52 +0100

loc *** exist *** algo *** size ** imp *

- using undefined strings or macros defines them to be empty

wl@ Mon, 14 Nov 2011 14:37:01 +0000

loc * exist * algo * size * imp *

--- missing mdoc features ----------------------------------------------

- .Bl -column .Xo support is missing

Line 106 are mere guesses, and some may be wrong.

Line 77 are mere guesses, and some may be wrong.

from jmc@ Wed, 14 Jul 2010 18:10:32 +0100

loc * exist *** algo *** size ** imp **

- .Bd -centered implies -filled, not -unfilled, which is not

easy to implement; it requires code similar to .ce, which

we don't have either.

Besides, groff has bug causing text right *before* .Bd -centered

to be centered as well.

loc *** exist *** algo ** size ** imp ** (parser reorg would help)

- .Bd -filled should not be the same as .Bd -ragged, but align both

the left and right margin. In groff, it is implemented in terms

of .ad b, which we don't have either. Found in cksum(1).

Line 146 are mere guesses, and some may be wrong.

Line 110 are mere guesses, and some may be wrong.

is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."

but should give "ab ."

- check whether it is correct that `D1' uses INDENT+1;

does it need its own constant?

loc * exist ** algo ** size * imp **

- prohibit `Nm' from having non-text HEAD children

(e.g., NetBSD mDNSShared/dns-sd.1)

(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)

Line 170 are mere guesses, and some may be wrong.

Line 130 are mere guesses, and some may be wrong.

uqs@ Thu, 2 Jun 2011 11:33:35 +0200

loc * exist ** algo *** size * imp **

--- missing man features -----------------------------------------------

- groff_www(7) .MTO and .URL

These macros were used by the GNU grep(1) man page.

The groff_www(7) manual page itself uses them, too.

We should probably *not* add them to mandoc.

Just mentioning this here to keep track of the abuse.

Laura Morales <lauretas at mail dot com> 20 Apr 2018 07:33:02 +0200

loc ** exist * algo * size ** imp *

--- missing tbl features -----------------------------------------------

- the "s" layout column specifier is used for placement of data

- vertical centering in cells vertically spanned with ^

into columns, but ignored during column width calculations

pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200

synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400

loc * exist *** algo *** size ** imp *

loc * exist ** algo *** size * imp **

- support mdoc(7) and man(7) macros inside tbl(7) code;

probably requires the parser reorg and letting tbl(7)

Line 184 are mere guesses, and some may be wrong.

Line 153 are mere guesses, and some may be wrong.

loc *** exist ** algo *** size ** imp ***

- look at the POSIX manuals in the books/man-pages-posix port,

they use some unsupported tbl(7) features.

they use some unsupported tbl(7) features, mostly macros in tbl(7).

loc * exist ** algo ** size ** imp ***

- look what Joerg Schilling manual pages use

Thu, 19 Mar 2015 18:31:48 +0100

- use Unicode U+2500 to U+256C for table borders

in tbl(7) -Tutf-8 output

suggested by bentley@ Tue, 14 Oct 2014 04:10:55 -0600

loc * exist ** algo * size * imp **

--- missing eqn features -----------------------------------------------

- In a matrix, break the output line after each matrix line.

Found in the discussion at CDBUG 2015.

Found in the discussion at CDBUG 2015. Suggested by Avi Weinstock.

Suggested by Avi Weinstock.

This may not be the ideal solution after all: eqn(7) matrices

loc * exist * algo * size * imp **

are lists of columns, so Avi's proposal would show each *column*

on its own *line*, which is likely to cause confusion.

A better solution, but much harder to implement, would be to

actually show the coordinates of column vectors on different

terminal output lines, using the clumnated output facilities

developed for .Bl -tag, .Bl -column, and also used for tbl(7).

loc * exist * algo ** size ** imp **

- The "size" keyword is parsed, but ignored by the formatter.

loc * exist * algo * size * imp *

Line 219 are mere guesses, and some may be wrong.

Line 189 are mere guesses, and some may be wrong.

surrounded by blanks, not when it is part of an unquoted word.

Also, check whether there are more such cases (e.g., +?).

reported by bentley@ 20 Jun 2017 02:04:29 -0600

loc * exist ** algo ** size * imp *

- Primes, opprime, and '

bentley@ Thu, 13 Jul 2017 23:14:20 -0600

--- missing misc features ----------------------------------------------

- man 3am readline

does not work because man(1) only accepts digit + one letter,

otherwise explicit -s is currently required

https://github.com/void-linux/void-packages/issues/9868

loc * exist * algo * size * imp ***

- man 3 readline may show readline(3m)

because in manpage_compare, "3" and "3am" compare equal

https://github.com/void-linux/void-packages/issues/9868

probably requires putting string version of section into struct manpage

loc * exist ** algo * size * imp ***

- restore flags for result ordering, but only for man(1), not for apropos(1)

such that man 3 syslog show syslog.3 not klogctl.3

and such that man 3p acosl shows acosl.3p not acos.3p

https://github.com/void-linux/void-packages/issues/9868

loc * exist ** algo * size * imp ***

- dead .so links should be entered into the database to avoid:

man -M. lvm-config

man: outdated mandoc.db lacks lvm-config(8) entry, run makewhatis /co/void-man

https://github.com/void-linux/void-packages/issues/9868

loc * exist ** algo * size * imp **

- man -ks 1,8 route; kn@ Jul 13, 2018 orally

- italic correction (\/) in PostScript mode

Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46

loc ** exist ** algo * size * imp *

Line 354 are mere guesses, and some may be wrong.

Line 351 are mere guesses, and some may be wrong.

- a line starting with "\fB something" counts as starting with whitespace

and triggers a line break; found in audio/normalize-mp3(1)

This will become easier once escape sequences are represented

by syntax tree nodes.

loc ** exist * algo ** size * imp **

- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc

Line 436 are mere guesses, and some may be wrong.

Line 435 are mere guesses, and some may be wrong.

Probably, this should be fixed somewhere in termp_it_pre(), not sure.

loc * exist ** algo ** size * imp **

- .Nx 1.0a

should be "NetBSD 1.0A", not "NetBSD 1.0a",

see OpenBSD ccdconfig(8).

loc * exist * algo * size * imp **

- In .Bl -tag, if a tag exceeds the right margin and must be continued

on the next line, it must be indented by -width, not width+1;

see "rule block|pass" in OpenBSD ifconfig(8).

loc * exist *** algo ** size * imp **

- When the -width string contains macros, the macros must be rendered

before measuring the width, for example

.Bl -tag -width ".Dv message"

Line 481 are mere guesses, and some may be wrong.

Line 470 are mere guesses, and some may be wrong.

* warning issues

************************************************************************

- warn about duplicate .Sh/.Ss heads

gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200

loc * exist * algo * size * imp **

- style message about macros inside .Bd -literal and .Dl, in particular

font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO)

- style message about mismatches between the section number in the

file name (if it is known) and the section number in .Dt

(from the mdoclint TODO)

- style message about NULL without .Dv (from the mdoclint TODO)

- style message about error constants without .Er (from the mdoclint TODO)

- warn when .Sh or .Ss contain other macros

Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034

loc * exist * algo * size * imp **

- style message about violations of the convention

.An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO)

- warn about attempts to call non-callable macros

Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100

Note that formatting is inconsistent in groff.

Line 493 are mere guesses, and some may be wrong.

Line 500 are mere guesses, and some may be wrong.

all over mdoc_macro.c and all subtly different.

loc ** exist ** algo ** size ** imp **

- mandoc_special does not really check the escape sequence,

- warn about punctuation - e.g. ',' and ';' - at the beginning

but just the overall format

of a text line, if it is likely intended to follow the preceding

loc ** exist ** algo *** size ** imp **

output without intervening whitespace, in particular after a

macro line (from the mdoclint TODO)

- -Tlint parser errors and warnings to stdout

- makewhatis -p complains about language subdirectories:

to tech@mdocml, naddy@ Wed, 28 Sep 2011 11:21:46 +0200

/usr/local/man//ru: Unknown directory part

wait! kristaps@ Sun, 02 Oct 2011 17:12:52 +0200

************************************************************************

* documentation issues

************************************************************************

Line 517 are mere guesses, and some may be wrong.

Line 525 are mere guesses, and some may be wrong.

* performance issues

************************************************************************

- Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?

from kristaps@ Sat, 09 Aug 2014 13:51:36 +0200

Several areas can be cleaned up to make mandoc even faster. These are

- the PDF file is HUGE: this can be reduced by using relative offsets

************************************************************************

Line 535 Several areas can be cleaned up to make mandoc even fa

Line 538 Several areas can be cleaned up to make mandoc even fa

Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624

- We use the input line number at several places to distinguish

- Is it possible to further simplify ENDBODY_SPACE?

same-line from different-line input. That plainly doesn't work

with user-defined macros, leading to random breakage.

- Find better ways to prevent endless loops

in roff(7) macro and string expansion.

- make buffers for parsing functions const

christos@ via wiz@ Fri, 18 Dec 2015 17:10:01 +0100

- struct mparse refactoring

Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200

Line 551 Several areas can be cleaned up to make mandoc even fa

Line 555 Several areas can be cleaned up to make mandoc even fa

- Enable HTTP compression by detecting gzip encoding and filtering

output through libz.

- Sandbox (see OpenSSH).

- Privilege separation (see OpenSSH).

- Enable caching support via HTTP 304 and If-Modified-Since.

- Have Mac OSX systems automatically disable -static compilation of the

CGI: -static isn't supported.

************************************************************************

* to improve in the groff_mdoc(7) macros

************************************************************************

- .Cd # arch1, arch2 in section 4 pages:

find better way to indicate multiple architectures, maybe:

allow .Dt vgafb 4 "macppc sparc64"

already shown as "Device Drivers Manual (macppc sparc64)"

for apropos, make that "vgafb(4) - macppc # sparc64" instead of "- all"

groff can be made to show multiple arches, too, but it is

tedious to do the string parsing in roff code...

jmc@ 23 Apr 2018 07:24:52 +0100 [man for vgafb(4)...]

loc ** exist ** algo * size * imp ***

- use uname(1) to set doc-default-operating-system at install time

tobimensch Mon, 1 Dec 2014 00:25:07 +0100

CVSweb