ntirpc icon indicating copy to clipboard operation
ntirpc copied to clipboard

Don't abuse mdoc(7) Tn for structs

Open nabijaczleweli opened this issue 3 years ago • 6 comments

The rest of the code variably uses Ft/Vt

nabijaczleweli avatar Oct 26 '22 20:10 nabijaczleweli

.Tn has never been used for "type names", that's a documentation blunder backsolved from the macro name. The correct usage corresponds to the correct documentation: "Tn macro - Trade Name Macro" (4.4BSD tmac/doc) — i.e. you use it to get a smaller font, most often for an acronym. No clue where you're getting the Fortran thing.

nabijaczleweli avatar Oct 27 '22 13:10 nabijaczleweli

https://linux.die.net/man/7/mdoc

dang avatar Oct 27 '22 14:10 dang

Great. That text appeared spontaneously in 1999 and got killed from the groff distribution in 2001, because it has no basis in fact, instead replaced with the modern-day-equivalent "The ‘.Vt’ macro may be used whenever a type is referenced."

nabijaczleweli avatar Oct 27 '22 14:10 nabijaczleweli

Hmm... Groff doesn't seem to document either tn or vt. Can you point me to the docs for these? Not that it matters much, since the man pages for ntirpc are largely unmaintained, and not installed.

dang avatar Oct 27 '22 15:10 dang

https://manpages.debian.org/bullseye/groff/groff_mdoc.7.en.html#Trade_Names_(or_Acronyms_and_Type_Names) (but do note that groff's mdoc(7) descends from the 4.4BSD one and so inherits the "type names" backsolve) and https://manpages.debian.org/bullseye/mandoc/mandoc_mdoc.7.en.html#Tn

nabijaczleweli avatar Oct 27 '22 15:10 nabijaczleweli