mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.254 and 1.293

version 1.254, 2018/05/25 20:23:51

version 1.293, 2019/05/03 16:14:41

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

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 **

- \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

- .als only works for macros in mandoc, not for user-defined strings.

Currently, \\ is expanded in two situations:

Also, the "val" field in struct roffkv would have to be replaced

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

with a pointer to a reference-counted wrapper, and an alias

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

would have to point to the same wrapper as the original.

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

.als to undefined does nothing; the alias is not created.

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

.rm'ing the original leaves the alias to point to the old value.

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

.de .als .de changes both, but

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

.de .als .rm .de only changes the new value, not the alias.

distinguishing requests, user-defined macros and standard macros

Found in groffer(1) version 1.19

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

Jan Stary 20 Apr 2019 20:16:54 +0200

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

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

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

- check for missing roff escape sequences, implement those that are

- roff string condition comparisons fail when vars contain quotes:

trivial even if not usually appearing in manual pages, gracefully

.ds s '

ignore the non-trivial ones, document what they are supposed to do

.if '\*s'' \&...

and what mandoc does instead

hard to fix because of the basic architecture (string replacement

loc * exist ** algo * size * imp *

happens before roff(7) syntax parsing)

Found in groffer(1) version 1.19

Jan Stary 20 Apr 2019 20:16:54 +0200

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

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

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

Line 98 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 140 are mere guesses, and some may be wrong.

Line 131 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 168 are mere guesses, and some may be wrong.

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

- 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

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

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

--- 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 187 are mere guesses, and some may be wrong.

Line 174 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 229 are mere guesses, and some may be wrong.

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

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

- 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 358 are mere guesses, and some may be wrong.

Line 354 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 379 are mere guesses, and some may be wrong.

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

--- HTML issues --------------------------------------------------------

- @media queries to reduce indentation on low-res displays

some mails in the Viewport for man.openbsd.org thread

e.g. Adam Thompson 24 May 2018 15:09:00 -0500

- wrap Sh and Ss content into <div>

Laura Morales <lauretas at mail dot com> 21 Apr 2018 18:10:48 +0200

(Evaluate whether this is really useful and has no adverse

side effects before implementing; if it is possible,

it does seem cleaner.)

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

- format ".IP *" etc. as <ul> rather than <dl>

https://github.com/Debian/debiman/issues/67

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

- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal

space, see for example random(3). Introduced in

http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92

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

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

all over mdoc_macro.c and all subtly different.

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

- style message about suspicious uses of - vs. \- vs. \(mi

e.g. -1 is likely wrong (from the mdoclint TODO)

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

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

output without intervening whitespace, in particular after a

macro line (from the mdoclint TODO)

- mandoc_special does not really check the escape sequence,

- makewhatis -p complains about language subdirectories:

but just the overall format

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

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

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

* documentation issues

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

- dashes, hyphens, and minus signs in manual pages

jmc@ Fri, 28 Mar 2014 07:19:27 +0000

- mark macros as: page structure domain, manual domain, general text domain

is this useful?

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

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

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

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

with user-defined macros, leading to random breakage.

- Is it possible to further simplify ENDBODY_SPACE?

- Find better ways to prevent endless loops

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

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

- 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

CVSweb