Skip to content

Commit

Permalink
{.,docs,docs/man}/Makefile.am: add "all-man" target to build all poss…
Browse files Browse the repository at this point in the history
…ible man pages (vs ones for enabled drivers), and weave this and check targets to parent makefiles
  • Loading branch information
jimklimov committed Mar 31, 2022
1 parent 6b787c1 commit 1a17e2a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
9 changes: 8 additions & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,14 @@ spellcheck spellcheck-interactive:
(cd $(builddir)/data && $(MAKE) -s $@) || RES=$$? ; \
exit $$RES

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

# This target adds syntax-checking for committed shell script files,
Expand Down
7 changes: 5 additions & 2 deletions docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ doc: @DOC_BUILD_LIST@

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

all-docs: docs

Expand Down Expand Up @@ -130,7 +130,10 @@ check-html-chunked: $(ASCIIDOC_HTML_CHUNKED)

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

man:
Expand Down
6 changes: 5 additions & 1 deletion docs/man/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -735,7 +735,11 @@ HTML_MANS = \

all:

html-man: $(HTML_MANS) index.html
all-html html-man: $(HTML_MANS) index.html

# Have a way to build all man pages, not just those that fit currently
# configured drivers, daemons, developer aspect, etc.
all-man man-man: $(MAN_MANS)

if WITH_MANS
if ! SKIP_MANS
Expand Down

0 comments on commit 1a17e2a

Please sign in to comment.