Skip to content

Commit 1a17e2a

Browse files
committed
{.,docs,docs/man}/Makefile.am: add "all-man" target to build all possible man pages (vs ones for enabled drivers), and weave this and check targets to parent makefiles
1 parent 6b787c1 commit 1a17e2a

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

Makefile.am

+8-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,14 @@ spellcheck spellcheck-interactive:
108108
(cd $(builddir)/data && $(MAKE) -s $@) || RES=$$? ; \
109109
exit $$RES
110110

111-
doc spellcheck-sortdict:
111+
# Note: the "all-docs" and "check-docs" targets may require tools not
112+
# found by `configure` script (and so avoided by conventional recipes)
113+
# such as PDF generators, so it should only be called at developer's
114+
# discretion, choice and risk. The "check-man" targets covers source
115+
# texts, man pages and HTML rendering of man pages, as enabled by tools.
116+
doc spellcheck-sortdict \
117+
all-docs check-docs \
118+
man all-man man-man check-man man-html all-html:
112119
cd $(srcdir)/docs && $(MAKE) $@
113120

114121
# This target adds syntax-checking for committed shell script files,

docs/Makefile.am

+5-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ doc: @DOC_BUILD_LIST@
8787

8888
# This target can be called by developers to go around the configure
8989
# script choices at their risk (e.g. missing tools are possible):
90-
docs: pdf html-single html-chunked man
90+
docs: pdf html-single html-chunked man-man html-man
9191

9292
all-docs: docs
9393

@@ -130,7 +130,10 @@ check-html-chunked: $(ASCIIDOC_HTML_CHUNKED)
130130

131131
# Note: usually the results from man-page check will be reported twice:
132132
# once as a SUBDIRS child makefile, and once via DOC_CHECK_LIST expansion
133-
check-man:
133+
# Note: default `make all` in the man directory caters to drivers etc.
134+
# chosen during configure script execution. The "all-man" and "all-html"
135+
# rules build everything documented.
136+
check-man all-man man-man all-html html-man:
134137
cd $(top_builddir)/docs/man/ && $(MAKE) -f Makefile $@
135138

136139
man:

docs/man/Makefile.am

+5-1
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,11 @@ HTML_MANS = \
735735

736736
all:
737737

738-
html-man: $(HTML_MANS) index.html
738+
all-html html-man: $(HTML_MANS) index.html
739+
740+
# Have a way to build all man pages, not just those that fit currently
741+
# configured drivers, daemons, developer aspect, etc.
742+
all-man man-man: $(MAN_MANS)
739743

740744
if WITH_MANS
741745
if ! SKIP_MANS

0 commit comments

Comments
 (0)