docs/man/index.txt, docs/man/Makefile.am, docs/man/.gitignore: report the effect of DOC_INSTALL_SELECTED_MANS_PROGS_BUILT on delivered docs and indexed man pages

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>

Author: jimklimov

docs/man/.gitignore

@@ -11,6 +11,7 @@
 /tmp/
 /linkman-driver-names.txt
 /linkman-drivertool-names.txt
+/linkman-docbuildmode-note.txt
 /linkman-*.txt.tmp
 /.check-html-man
 /.check-man-pages

docs/man/Makefile.am

@@ -1585,7 +1585,7 @@ endif !WITH_HTML_SINGLE
 # To regenerate these files, you may have to `make distclean` first
 # FIXME: Track also clients (e.g. NUT-Monitor UI, etc.), development-only tools
 #  (sockdebug), or platform-specific progs (nut.exe)
-LINKMAN_INCLUDE_GENERATED = linkman-driver-names.txt linkman-drivertool-names.txt
+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
 CLEANFILES = linkman-*.txt.tmp
 
@@ -1636,9 +1636,38 @@ linkman-drivertool-names.txt: Makefile
 	    rm -f "$(builddir)/$(@F).tmp" ; \
 	 fi
 
+# Doing this dynamically as here, so we may later deliver some more dynamic
+# content if desired (e.g. lists of built/not-built programs, date, version,
+# etc.). Or maybe not, we'll see :)
+if DOC_INSTALL_SELECTED_MANS_PROGS_BUILT
+
+linkman-docbuildmode-note.txt: Makefile
+	@echo "  GENERATE-LINKMAN	$@"
+	@(  echo 'NOTE: This build of NUT was configured to deliver only manual pages for programs that were actually built. For more information about the ecosystem please see '; \
+	    echo 'ifndef::website[]' ; \
+	    echo 'the NUT website listing at https://networkupstools.org/docs/man/index.html or ' ; \
+	    echo 'endif::website[]' ; \
+	    echo 'the sources of these pages at https://github.com/networkupstools/nut/tree/master/docs/man'; \
+	 ) > "$(builddir)/$(@F)"
+
+else !DOC_INSTALL_SELECTED_MANS_PROGS_BUILT
+
+linkman-docbuildmode-note.txt: Makefile
+	@echo "  GENERATE-LINKMAN	$@"
+	@(  echo 'NOTE: This build of NUT was configured to deliver all available manual'; \
+	    echo 'ifndef::website[]' ; \
+	    echo 'pages, and may include those for programs that were not actually built or installed.' ; \
+	    echo 'endif::website[]' ; \
+	    echo 'ifdef::website[]' ; \
+	    echo 'pages.' ; \
+	    echo 'endif::website[]' ; \
+	 ) > "$(builddir)/$(@F)"
+
+endif !DOC_INSTALL_SELECTED_MANS_PROGS_BUILT
+
 # Dependencies are about particular filenames, since over time
 # we might have several use-cases for LINKMAN_INCLUDE_GENERATED:
-$(LINKMAN_INCLUDE_CONSUMERS): linkman-driver-names.txt linkman-drivertool-names.txt
+$(LINKMAN_INCLUDE_CONSUMERS): linkman-driver-names.txt linkman-drivertool-names.txt linkman-docbuildmode-note.txt
 
 # These files are generated when we build from git source so not tracked in
 # git, and not part of tarball (to be in builddir) - so not in EXTRA_DIST.

docs/man/index.txt

@@ -7,6 +7,8 @@ endif::website[]
 User manual pages
 -----------------
 
+include::{builddir}linkman-docbuildmode-note.txt[]
+
 ifndef::in-nut-manpage[]
 NUT overview
 ~~~~~~~~~~~~

docs/nut.dict

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 3519 utf-8
+personal_ws-1.1 en 3520 utf-8
 AAC
 AAS
 ABI
@@ -1940,6 +1940,7 @@ dnf
 dnl
 dnsmasq
 docbook
+docbuildmode
 docdir
 docinfo
 docs