Skip to content

Fix driver man page listing to not include snippets #3260

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.

Sign up for GitHub

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
jimklimov merged 4 commits into from
Jan 16, 2026
Merged

Fix driver man page listing to not include snippets #3260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
528a361
docs/man/Makefile.am: linkman-driver-names.txt: do not refer to blaze…
jimklimov Jan 13, 2026
5ab22fc
docs/man/Makefile.am: do not list index.txt twice in SRC_ALL_PAGES
jimklimov Jan 13, 2026
a3c3a57
docs/man/Makefile.am: update LINKMAN_EXCLUDE_NONDRIVER preemptively b…
jimklimov Jan 13, 2026
0046246
tools/driver-list-format.sh: update the error message to stress expec…
jimklimov Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/man/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1520,8 +1520,7 @@ SRC_ALL_PAGES += \
$(SRC_CGI_PAGES) \
$(SRC_DEV_PAGES) \
$(SRC_DRIVERS_PAGES) \
networked_hostnames.txt \
index.txt
networked_hostnames.txt

# DIST_ALL_PAGES: Make sure pages are built for the archive (or
# inherited from earlier tarball this release is being built from);
Expand Down Expand Up @@ -1596,6 +1595,11 @@ endif !WITH_HTML_SINGLE
# (sockdebug), or platform-specific progs (nut.exe)
LINKMAN_INCLUDE_GENERATED = linkman-driver-names.txt linkman-drivertool-names.txt linkman-docbuildmode-note.txt
LINKMAN_INCLUDE_CONSUMERS = index.txt upsd.txt nutupsdrv.txt nut.txt
# Files that linkman-driver-names.txt would consider from LINKMAN_PAGES_DRIVERS
# that are only included snippets but not standalone driver pages.
# TOTHINK: Parse sources for `include::` hits dynamically to build (parts of) this regex?
LINKMAN_EXCLUDE_NONDRIVER = '^(nutupsdrv|blazer-common|nut_usb_addvars|networked_hostnames)\.txt$$'

CLEANFILES = linkman-*.txt.tmp*

# Note we can have a pre-built file from the tarball, sort of useful when
Expand All @@ -1606,7 +1610,7 @@ linkman-driver-names.txt: Makefile
@echo " GENERATE-LINKMAN $@"
@(LC_ALL=C; LANG=C; export LC_ALL LANG; \
for F in $(LINKMAN_PAGES_DRIVERS) ; do echo "$$F" ; done \
| $(EGREP) -v '^nutupsdrv\.txt$$' \
| $(EGREP) -v $(LINKMAN_EXCLUDE_NONDRIVER) \
| sort -n | uniq \
| sed 's,^\(.*\)\.txt$$,- linkman:\1[$(MAN_SECTION_CMD_SYS)],' ; \
) > "$(builddir)/$(@F).tmp.$$$$" || exit ; \
Expand Down
4 changes: 2 additions & 2 deletions tools/driver-list-format.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#
# Copyright (C)
# 2015-2016 Arnaud Quette <arnaud.quette@free.fr>
# 2025 Jim Klimov <jimklimov+nut@gmail.com>
# 2025-2026 Jim Klimov <jimklimov+nut@gmail.com>
#
################################################################################

Expand Down Expand Up @@ -86,7 +86,7 @@ do
# the fields may be empty (just two double-quotes).
BADLINES="`$EGREP -v \"${VALID_LINE}\" < \"${TMPBUILD_PATH}/${drvfile}.tabbed\"`"
if [ x"${BADLINES}" != x ] ; then
echo "$0: ERROR: markup of '${DRVLIST_PATH}/${drvfile}' needs to be fixed: some lines are not exactly 6 fields (and optional comment)" >&2
echo "$0: ERROR: markup of '${DRVLIST_PATH}/${drvfile}' needs to be fixed: some lines are not exactly 6 fields wrapped in quotes (and optional comment) and separated by TAB characters" >&2
echo "$BADLINES" | head -5
RES=1
false
Expand Down
Loading