libpathconv: Document library in the man pages
ClosedPublic
Actions

Authored by tembun_bk.ru on Dec 13 2025, 4:59 PM.

Details

Reviewers

ziaee
imp

Group Reviewers

manpages
docs

Commits

rGb2b49011988f: libpathconv: Document library in the man pages
rG2c75ac14d7e9: libpathconv: Document library in the man pages

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

tembun_bk.ru created this revision.Dec 13 2025, 4:59 PM

Herald added a subscriber: imp. · View Herald TranscriptDec 13 2025, 4:59 PM

@ziaee I'm sorry, but I'm not sure, whom should I also request the review from?

imp added inline comments.Dec 13 2025, 5:03 PM

contrib/mandoc/lib.in
95 ↗	(On Diff #167971)	What does this enable?

whom should I also request the review from?

I use git log on the file or directory in question and see who's been working on the logic. In this case, nobody's really touched it since Julian over half a decade ago. So, src-comitters (like you did) is probably a good move.

contrib/mandoc/lib.in
95 ↗	(On Diff #167971)	It puts additional text in the library section, but the library section was deprecated by upstream
lib/libpathconv/abs2rel.3
33	The library section is deprecated, upstream is saying to put the Lb macro at the top of SYNOPSIS.
lib/libpathconv/rel2abs.3
32	The library section is deprecated, upstream is saying to put the Lb macro at the top of SYNOPSIS.

I use git log on the file or directory in question and see who's been working on the logic. In this case, nobody's really touched it since Julian over half a decade ago. So, src-comitters (like you did) is probably a good move.

OK, thanks for the advice!

tembun_bk.ru added inline comments.Dec 13 2025, 5:55 PM

contrib/mandoc/lib.in
95 ↗	(On Diff #167971)	Does it mean that information (library descriptions) from this file is not needed anymore? So, as I can see, if we put .Lb in SYNOPSIS section, it will print /* -lname */ and nothing else. If that's enough, then OK, I'm just not sure.

ziaee added inline comments.Dec 13 2025, 6:11 PM

contrib/mandoc/lib.in
95 ↗	(On Diff #167971)	Hm, that's not clear yet. Reposting here for visibility, from another thread. This is everything I know: This advice comes from the mdoc(7) manual [^0]. I imported this change from upstream mdoc.7 version 1.298 [^1] which says: LIBRARY The name of the library containing the documented functions. Using this section is no longer recommended. If any Lb macro is needed, put it at the beginning of the SYNOPSIS section instead. It seems to have first been proposed on the groff mailing list [^2]. I tried to notify everyone with a mail to freebsd-current@ [^3] in June when when I imported the change in commit 4c07abdbacf4 [^4], but nobody said anything. [^0]: https://man.freebsd.org/cgi/man.cgi?query=mdoc&apropos=0&sektion=0&manpath=FreeBSD+16.0-CURRENT&arch=default&format=html [^1]: https://cvsweb.bsd.lv/mandoc/mdoc.7?rev=1.298&content-type=text/x-cvsweb-markup&sortby=date [^2]: https://lists.gnu.org/archive/html/groff/2025-06/msg00004.html [^3]: https://lists.freebsd.org/archives/freebsd-current/2025-June/007907.html [^4]: https://cgit.freebsd.org/src/log/?qt=range&q=4c07abdbacf4&showmsg=1

I removed all committers from reviewers because most of us cannot contribute here.

imp added inline comments.Dec 13 2025, 6:33 PM

contrib/mandoc/lib.in
95 ↗	(On Diff #167971)	Yea. I asked because I thought it was obsolete. And also changes contrib. We have a complex history with mdoc and it struck me as unlikely to be accepted upstream. If it wasn't critical, i thought it would be best to drop it.