8000 pkgconf manpage is incomplete · Issue #257 · pkgconf/pkgconf · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

pkgconf manpage is incomplete #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tachi107 opened this issue Aug 1, 2022 · 4 comments
Open

pkgconf manpage is incomplete #257

Tachi107 opened this issue Aug 1, 2022 · 4 comments

Comments

@Tachi107
Copy link
Contributor
Tachi107 commented Aug 1, 2022

Hi, the pkgconf(1) manpage lacks some information when compared to the pkg-config(1) manpage.

For example, it doesn't mention where .pc files are searched, lacks the PKG-CONFIG DERIVED VARIABLES section, and doesn't mention the existence of some command line options like --print-errors.

@kaniini, you mentioned in #220 (comment) that it'd be nice to convert pkgconf's manpages to scdoc, and I think that you could take the opportunity to do both things at once :)

If you think it's ok to switch to scdoc, I may look into it. I've been looking for a way to write manpages in a human-writable format for quite some time, while not hindering bootstrappability of C/C++ projects, and scdoc seems a really nice tool for the job.

Cc: @andrewshadura

@kaniini
Copy link
Member
kaniini commented Aug 1, 2022

This would be nice to have for the upcoming release but I probably won’t have time to work on it, as I am busy with more urgent work at the moment and preparing to move my family cross country. But if you want to work on it there are probably plenty of folks who will be glad to review it.

@Tachi107
Copy link
Contributor Author
Tachi107 commented Aug 1, 2022

Perfect, I was just waiting for an ok from you. Adding this to my todo list :D

@bapt
Copy link
Member
bapt commented Sep 1, 2023

why switching to scdoc ? mdoc is a pretty easy markup, I would understand when writing from scratch, but for people using mandoc, having manpages in mdoc format allows pretty powerful searches etc as the markup is rich, thise would be lost will scdoc.

@Tachi107
Copy link
Contributor Author
Tachi107 commented Sep 3, 2023

After learning a bit more about scdoc and mdoc, I agree with bapt's point. While mdoc arguably isn't "pretty easy markup" compared to scdoc if you never wrote roff manpages, it still isn't that hard and its semantic macros make the manual page more flexible and give it a uniform look that scdoc lacks.

I'll close my scodc pull request as soon as I'll find my treehouse.systems credentials - it never got any attention anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants
0