Skip to content

Fix generation of docs/man/linkman*.txt files #2976

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

Merged
merged 9 commits into from
Jun 3, 2025

Conversation

jimklimov
Copy link
Member

@jimklimov jimklimov commented Jun 2, 2025

Closes: networkupstools/nut-website#60

Adds a configure --enable-docs-man-for-progs-built-only toggle to deliver man pages for only built programs or all of them (as needed for docs sites).

A lot more can be enhanced on top of this vehicle, but the pressing problem is having the full list of drivers in overview page, seen at https://networkupstools.org/docs/man/nut.html on site.

jimklimov added 9 commits June 2, 2025 13:55
…kman-*.txt to pick up new driver lists in persistent NUT building workspaces [networkupstools/nut-website#60]

Signed-off-by: Jim Klimov <[email protected]>
…-enable-docs-man-for-progs-built-only=<yes|no> [networkupstools/nut-website#60]

Signed-off-by: Jim Klimov <[email protected]>
…o parse all files (even if we do not build some programs here) [networkupstools/nut-website#60]

Signed-off-by: Jim Klimov <[email protected]>
…r ensure `configure --enable-docs-man-for-progs-built-only=no` for dist/distcheck builds [networkupstools/nut-website#60]

Signed-off-by: Jim Klimov <[email protected]>
…PROGS toggle for linkman*.txt generation [networkupstools/nut-website#60]

Probably a lot more can be enhanced later, to also consider this in delivery
of HTML MAN page renders, or finer-grained selections for even more optional
drivers (nhs_ser on linux), clients (Python UI), development-only tools (like
sockdebug), or platform-specific progs (nut.exe), etc.

Signed-off-by: Jim Klimov <[email protected]>
…apt to varying configure choices)

Signed-off-by: Jim Klimov <[email protected]>
@jimklimov jimklimov added this to the 2.8.4 milestone Jun 2, 2025
@jimklimov jimklimov added bug enhancement documentation CI Entries related to continuous integration infrastructure (here CI = tools + scripts + recipes) labels Jun 2, 2025
@AppVeyorBot
Copy link

@jimklimov jimklimov merged commit 8c45b56 into networkupstools:master Jun 3, 2025
29 of 30 checks passed
@jimklimov jimklimov deleted the issue-nut-website-60 branch June 3, 2025 06:41
jimklimov added a commit to jimklimov/nut that referenced this pull request Jun 4, 2025
jimklimov added a commit to jimklimov/nut that referenced this pull request Jun 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug CI Entries related to continuous integration infrastructure (here CI = tools + scripts + recipes) documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

nut.html overview page is missing some drivers
2 participants