From f6af10e8eb735a31931e23c477baf9c2c7011675 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Sun, 9 Apr 2017 15:26:58 +0200 Subject: [PATCH 01/13] configure.ac : add --with-doc(s)=all={yes,no,skip,auto} to manch e.g. man=skip etc. syntax --- configure.ac | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/configure.ac b/configure.ac index 6f8a40c4d3..c664f87571 100644 --- a/configure.ac +++ b/configure.ac @@ -673,16 +673,16 @@ NUT_REPORT_FEATURE([build and install documentation], [${nut_with_doc}], [], [WITH_ASCIIDOC], [Define to enable Asciidoc support]) case "${nut_with_doc}" in - yes|all) + yes|all|all=yes) nut_doc_build_list="man html-single html-chunked pdf" ;; - auto) + auto|all=auto) nut_doc_build_list="man=auto html-single=auto html-chunked=auto pdf=auto" ;; - skip) + skip|all=skip) nut_doc_build_list="man=skip html-single=skip html-chunked=skip pdf=skip" ;; - no) + no|all=no) nut_doc_build_list="" ;; dnl If user passed --with-doc='' they they want nothing, right? From 6c327c9547475bf8d61ea45f8b818469307186a9 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Sun, 9 Apr 2017 17:18:01 +0200 Subject: [PATCH 02/13] docs/Makefile.am : typo fix not-building FAQ.chunked --- docs/Makefile.am | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index e388360262..026045f9d4 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -55,7 +55,7 @@ ASCIIDOC_HTML_SINGLE = user-manual.html \ ASCIIDOC_HTML_CHUNKED = user-manual.chunked \ developer-guide.chunked \ packager-guide.chunked \ - FAQ.html + FAQ.chunked ASCIIDOC_PDF = user-manual.pdf \ developer-guide.pdf \ From 8d964f1d4dfab3fb2a97a40cfcfba5475cc7c9ce Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Sun, 9 Apr 2017 17:07:24 +0200 Subject: [PATCH 03/13] Add "make check" for generated (or "released" pre-built) docs --- configure.ac | 10 ++++++++++ docs/Makefile.am | 40 +++++++++++++++++++++++++++++++++++++- docs/man/Makefile.am | 46 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 95 insertions(+), 1 deletion(-) diff --git a/configure.ac b/configure.ac index c664f87571..a447fd2bc2 100644 --- a/configure.ac +++ b/configure.ac @@ -860,6 +860,15 @@ esac NUT_REPORT_FEATURE([build specific documentation format(s)], [${nut_with_doc}], [${DOC_BUILD_LIST}], [WITH_DOCS], [Define to enable overall documentation generation]) +# To cater for less portable make's, precalculate the target list +# for "make check" in "docs/" here... +DOC_CHECK_LIST="" +if test "${nut_with_doc}" = yes ; then + for V in $DOC_BUILD_LIST ; do + DOC_CHECK_LIST="$DOC_CHECK_LIST check-$V" + done +fi + WITH_MANS=no SKIP_MANS=no if echo "${DOC_BUILD_LIST}" | grep -w "man" >/dev/null ; then @@ -1487,6 +1496,7 @@ AC_SUBST(LIBMODBUS_LIBS) AC_SUBST(LIBIPMI_CFLAGS) AC_SUBST(LIBIPMI_LIBS) AC_SUBST(DOC_BUILD_LIST) +AC_SUBST(DOC_CHECK_LIST) AC_SUBST(LIBWRAP_CFLAGS) AC_SUBST(LIBWRAP_LIBS) AC_SUBST(LIBLTDL_CFLAGS) diff --git a/docs/Makefile.am b/docs/Makefile.am index 026045f9d4..d634b5f3cc 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -68,6 +68,8 @@ SUFFIXES = .txt .html .pdf all: doc +check-local: @DOC_CHECK_LIST@ + doc: @DOC_BUILD_LIST@ pdf: $(ASCIIDOC_PDF) @@ -75,8 +77,44 @@ pdf: $(ASCIIDOC_PDF) html-single: $(ASCIIDOC_HTML_SINGLE) html-chunked: $(ASCIIDOC_HTML_CHUNKED) +# the "for" loops might better use $^ but it might be not portable +check-pdf: $(ASCIIDOC_PDF) + @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + for F in $(ASCIIDOC_PDF) ; do \ + test -s "$$F" && { file "$$F" | egrep 'PDF document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + done; if test -n "$$FAILED" ; then \ + echo "FAILED PDF sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ + fi; echo "PASSED PDF sanity check"; exit 0 + +check-html-single: $(ASCIIDOC_HTML_SINGLE) + @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + for F in $(ASCIIDOC_HTML_SINGLE) ; do \ + test -s "$$F" && { file "$$F" | egrep '(XML|HTML).*document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + done; if test -n "$$FAILED" ; then \ + echo "FAILED HTML-single sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ + fi; echo "PASSED HTML-single sanity check"; exit 0 + +check-html-chunked: $(ASCIIDOC_HTML_CHUNKED) + @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + for D in $(ASCIIDOC_HTML_CHUNKED); do \ + for F in "$$D"/*.html ; do \ + test -s "$$F" && { file "$$F" | egrep '(XML|HTML).*document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + done; \ + for F in "$$D"/*.css ; do \ + test -s "$$F" && { egrep 'CSS stylesheet' "$$F" > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + done; \ + done; if test -n "$$FAILED" ; then \ + echo "FAILED HTML-chunked sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ + fi; echo "PASSED HTML-chunked sanity check"; exit 0 + +# 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: + cd $(top_builddir)/docs/man/ && $(MAKE) -f Makefile $@ + clean-local: - rm -rf *.pdf *.html *.chunked docbook-xsl.css *.bak + rm -f *.pdf *.html docbook-xsl.css + rm -rf *.chunked *.bak ### TODO: automatic dependency generation # Add other directory deps (not for local EXTRA_DIST) and generated contents diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index 01702aa25c..ea85be7b26 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -639,6 +639,52 @@ all: html-man: $(HTML_MANS) index.html +if WITH_MANS +if ! SKIP_MANS +check-local: check-man +else +check-local: check-man-txt check-man-pages + echo "Man-page generation was SKIPPED per user request, so pregenerated pages were sanity-checked (if any)" >&@ +endif +else +check-local: check-man-txt check-man-pages + echo "Man-page generation was not done, so pregenerated pages were sanity-checked (if any)" >&@ +endif + +check-man: check-man-txt check-man-pages check-html-man + +# the "for" loops might better use $^ but it might be not portable +check-man-html: check-html-man + +check-html-man: $(HTML_MANS) index.html + @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + for F in $(HTML_MANS) index.html ; do \ + test -s "$$F" && { file "$$F" | egrep '(XML|HTML).*document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + done; if test -n "$$FAILED" ; then \ + echo "FAILED HTML-man sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ + fi; echo "PASSED HTML-man sanity check"; exit 0 + +# Note: many man-pages here have code samples and are mis-identified as C code +check-man-page: check-man-pages + +check-man-pages: $(MAN_MANS) + @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + for F in $(MAN_MANS) ; do \ + test -s "$$F" && { file "$$F" | egrep '(troff.* input|C source, ASCII text)' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + done; if test -n "$$FAILED" ; then \ + echo "FAILED man-page sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ + fi; echo "PASSED man-page sanity check"; exit 0 + +check-man-source: check-man-txt + +check-man-txt: $(SRC_ALL_PAGES) + @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + for F in $(SRC_ALL_PAGES) ; do \ + test -s "$$F" && { file "$$F" | egrep '(ASCII|UTF-8|Unicode).* text' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + done; if test -n "$$FAILED" ; then \ + echo "FAILED man-source sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ + fi; echo "PASSED man-source sanity check"; exit 0 + CLEANFILES = *.xml *.html SUFFIXES = .txt .html .1 .3 .5 .8 From e98b1eb73fb58240b294aae2927bf5ca91d4ab32 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Sun, 9 Apr 2017 21:54:48 +0200 Subject: [PATCH 04/13] docs/man/Makefile.am : fix check-man-txt for distcheck --- docs/man/Makefile.am | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index ea85be7b26..a092316fc1 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -679,6 +679,7 @@ check-man-source: check-man-txt check-man-txt: $(SRC_ALL_PAGES) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + cd $(abs_srcdir) || exit; \ for F in $(SRC_ALL_PAGES) ; do \ test -s "$$F" && { file "$$F" | egrep '(ASCII|UTF-8|Unicode).* text' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ From 04f1ecc9c72addeaa24fcf58d682d928d7d18d12 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Sun, 9 Apr 2017 22:33:52 +0200 Subject: [PATCH 05/13] docs/man/Makefile.am : fix check-man-pages for distcheck --- docs/man/Makefile.am | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index a092316fc1..cd835c6962 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -667,12 +667,18 @@ check-html-man: $(HTML_MANS) index.html # Note: many man-pages here have code samples and are mis-identified as C code check-man-page: check-man-pages +# Man-pages may be pre-generated (srcdir), or re-built (builddir) check-man-pages: $(MAN_MANS) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ for F in $(MAN_MANS) ; do \ - test -s "$$F" && { file "$$F" | egrep '(troff.* input|C source, ASCII text)' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + ( test -s "$(abs_srcdir)/$$F" && { file "$(abs_srcdir)/$$F" | egrep '(troff.* input|C source, ASCII text)' > /dev/null ; } ) || \ + ( test -s "$(abs_builddir)/$$F" && { file "$(abs_builddir)/$$F" | egrep '(troff.* input|C source, ASCII text)' > /dev/null ; } ) || \ + FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ - echo "FAILED man-page sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ + echo "FAILED man-page sanity check for:$$FAILED" >&2 ; \ + ( echo "SRCDIR:"; cd "$(abs_srcdir)/" && file $$FAILED ; \ + echo "BUILDDIR:"; cd "$(abs_builddir)/" && file $$FAILED ; \ + ) >&2 ; exit 1; \ fi; echo "PASSED man-page sanity check"; exit 0 check-man-source: check-man-txt From 74f19fc94f2d1e80924430c900d5daa364132880 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Sun, 9 Apr 2017 22:47:56 +0200 Subject: [PATCH 06/13] docs/man/Makefile.am : fix check-man-html for distcheck --- docs/man/Makefile.am | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index cd835c6962..9e46327d79 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -656,9 +656,9 @@ check-man: check-man-txt check-man-pages check-html-man # the "for" loops might better use $^ but it might be not portable check-man-html: check-html-man -check-html-man: $(HTML_MANS) index.html +check-html-man: $(HTML_MANS) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ - for F in $(HTML_MANS) index.html ; do \ + for F in $(HTML_MANS) ; do \ test -s "$$F" && { file "$$F" | egrep '(XML|HTML).*document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ echo "FAILED HTML-man sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ From df0a98f1ca7e88f05ddf7bbdac8e693a7d9ec067 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Mon, 10 Apr 2017 11:01:44 +0200 Subject: [PATCH 07/13] Update Makefile.am Some systems detect text sources as "ISO-8859 English" text - please them. --- docs/man/Makefile.am | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index 9e46327d79..2f3cb70dd7 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -687,7 +687,7 @@ check-man-txt: $(SRC_ALL_PAGES) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ cd $(abs_srcdir) || exit; \ for F in $(SRC_ALL_PAGES) ; do \ - test -s "$$F" && { file "$$F" | egrep '(ASCII|UTF-8|Unicode).* text' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + test -s "$$F" && { file "$$F" | egrep '(ASCII|UTF-8|Unicode|ISO-8859|English).* text' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ echo "FAILED man-source sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ fi; echo "PASSED man-source sanity check"; exit 0 From 0c99dda1a57d614975fb3288643ba71d3b45a0f7 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Mon, 10 Apr 2017 15:55:22 +0200 Subject: [PATCH 08/13] Some systems detect man-pages as "ASCII text" - please them --- docs/man/Makefile.am | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index 2f3cb70dd7..99e3221197 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -671,8 +671,8 @@ check-man-page: check-man-pages check-man-pages: $(MAN_MANS) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ for F in $(MAN_MANS) ; do \ - ( test -s "$(abs_srcdir)/$$F" && { file "$(abs_srcdir)/$$F" | egrep '(troff.* input|C source, ASCII text)' > /dev/null ; } ) || \ - ( test -s "$(abs_builddir)/$$F" && { file "$(abs_builddir)/$$F" | egrep '(troff.* input|C source, ASCII text)' > /dev/null ; } ) || \ + ( test -s "$(abs_srcdir)/$$F" && { file "$(abs_srcdir)/$$F" | egrep '(troff.* input|C source|ASCII text)' > /dev/null ; } ) || \ + ( test -s "$(abs_builddir)/$$F" && { file "$(abs_builddir)/$$F" | egrep '(troff.* input|C source|ASCII text)' > /dev/null ; } ) || \ FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ echo "FAILED man-page sanity check for:$$FAILED" >&2 ; \ From 2726117b3b49a14ea10e648798c5914cf1092348 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Mon, 10 Apr 2017 21:39:16 +0200 Subject: [PATCH 09/13] Some systems detect html-pages as "XML" - please them too --- docs/Makefile.am | 4 ++-- docs/man/Makefile.am | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index d634b5f3cc..2bfb852195 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -89,7 +89,7 @@ check-pdf: $(ASCIIDOC_PDF) check-html-single: $(ASCIIDOC_HTML_SINGLE) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ for F in $(ASCIIDOC_HTML_SINGLE) ; do \ - test -s "$$F" && { file "$$F" | egrep '(XML|HTML).*document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + test -s "$$F" && { file "$$F" | egrep '(XML|HTML.*document)' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ echo "FAILED HTML-single sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ fi; echo "PASSED HTML-single sanity check"; exit 0 @@ -98,7 +98,7 @@ check-html-chunked: $(ASCIIDOC_HTML_CHUNKED) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ for D in $(ASCIIDOC_HTML_CHUNKED); do \ for F in "$$D"/*.html ; do \ - test -s "$$F" && { file "$$F" | egrep '(XML|HTML).*document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + test -s "$$F" && { file "$$F" | egrep '(XML|HTML.*document)' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; \ for F in "$$D"/*.css ; do \ test -s "$$F" && { egrep 'CSS stylesheet' "$$F" > /dev/null ; } || FAILED="$$FAILED $$F" ; \ diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index 99e3221197..1c232246a6 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -659,7 +659,7 @@ check-man-html: check-html-man check-html-man: $(HTML_MANS) @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ for F in $(HTML_MANS) ; do \ - test -s "$$F" && { file "$$F" | egrep '(XML|HTML).*document' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ + test -s "$$F" && { file "$$F" | egrep '(XML|HTML.*document)' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ echo "FAILED HTML-man sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ fi; echo "PASSED HTML-man sanity check"; exit 0 From 903517f4ff57b771135d23b709267f97776f1ebf Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Mon, 12 Oct 2020 14:03:44 +0200 Subject: [PATCH 10/13] Update configure.ac Whitespace mess --- configure.ac | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/configure.ac b/configure.ac index b2a6141713..975476e726 100644 --- a/configure.ac +++ b/configure.ac @@ -902,7 +902,7 @@ NUT_REPORT_FEATURE([build specific documentation format(s)], [${nut_with_doc}], DOC_CHECK_LIST="" if test "${nut_with_doc}" = yes ; then for V in $DOC_BUILD_LIST ; do - DOC_CHECK_LIST="$DOC_CHECK_LIST check-$V" + DOC_CHECK_LIST="$DOC_CHECK_LIST check-$V" done fi From eb6c6dbd6851ce0048061dce9ca6002924260ae8 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Thu, 15 Oct 2020 19:38:57 +0200 Subject: [PATCH 11/13] docs/man/Makefile.am : typo fix ">&@" => ">&2" for stderr --- docs/man/Makefile.am | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index 0c6b6aed0e..e04d4c0331 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -724,11 +724,11 @@ if ! SKIP_MANS check-local: check-man else check-local: check-man-txt check-man-pages - echo "Man-page generation was SKIPPED per user request, so pregenerated pages were sanity-checked (if any)" >&@ + echo "Man-page generation was SKIPPED per user request, so pregenerated pages were sanity-checked (if any)" >&2 endif else check-local: check-man-txt check-man-pages - echo "Man-page generation was not done, so pregenerated pages were sanity-checked (if any)" >&@ + echo "Man-page generation was not done, so pregenerated pages were sanity-checked (if any)" >&2 endif check-man: check-man-txt check-man-pages check-html-man From 6e6a74894c6a9d0ad860141cf314d6e117ca4393 Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Thu, 15 Oct 2020 19:39:54 +0200 Subject: [PATCH 12/13] docs/man/Makefile.am : in check-man-* targets, count the checked files (to see better the cases where none were available) --- docs/man/Makefile.am | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index e04d4c0331..9dd7200ad6 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -737,20 +737,22 @@ check-man: check-man-txt check-man-pages check-html-man check-man-html: check-html-man check-html-man: $(HTML_MANS) - @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + @FAILED=""; CHECKED=0; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ for F in $(HTML_MANS) ; do \ + CHECKED="`expr $$CHECKED + 1`"; \ test -s "$$F" && { file "$$F" | egrep '(XML|HTML.*document)' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ echo "FAILED HTML-man sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ - fi; echo "PASSED HTML-man sanity check"; exit 0 + fi; echo "PASSED HTML-man sanity check (checked $$CHECKED files)"; exit 0 # Note: many man-pages here have code samples and are mis-identified as C code check-man-page: check-man-pages # Man-pages may be pre-generated (srcdir), or re-built (builddir) check-man-pages: $(MAN_MANS) - @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + @FAILED=""; CHECKED=0; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ for F in $(MAN_MANS) ; do \ + CHECKED="`expr $$CHECKED + 1`"; \ ( test -s "$(abs_srcdir)/$$F" && { file "$(abs_srcdir)/$$F" | egrep '(troff.* input|C source|ASCII text)' > /dev/null ; } ) || \ ( test -s "$(abs_builddir)/$$F" && { file "$(abs_builddir)/$$F" | egrep '(troff.* input|C source|ASCII text)' > /dev/null ; } ) || \ FAILED="$$FAILED $$F" ; \ @@ -759,18 +761,19 @@ check-man-pages: $(MAN_MANS) ( echo "SRCDIR:"; cd "$(abs_srcdir)/" && file $$FAILED ; \ echo "BUILDDIR:"; cd "$(abs_builddir)/" && file $$FAILED ; \ ) >&2 ; exit 1; \ - fi; echo "PASSED man-page sanity check"; exit 0 + fi; echo "PASSED man-page sanity check (checked $$CHECKED files)"; exit 0 check-man-source: check-man-txt check-man-txt: $(SRC_ALL_PAGES) - @FAILED=""; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ + @FAILED=""; CHECKED=0; LANG=C; LC_ALL=C; export LANG; export LC_ALL; \ cd $(abs_srcdir) || exit; \ for F in $(SRC_ALL_PAGES) ; do \ + CHECKED="`expr $$CHECKED + 1`"; \ test -s "$$F" && { file "$$F" | egrep '(ASCII|UTF-8|Unicode|ISO-8859|English).* text' > /dev/null ; } || FAILED="$$FAILED $$F" ; \ done; if test -n "$$FAILED" ; then \ echo "FAILED man-source sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \ - fi; echo "PASSED man-source sanity check"; exit 0 + fi; echo "PASSED man-source sanity check (checked $$CHECKED files)"; exit 0 CLEANFILES = *.xml *.html From 16dc3721c95066d573665fece80009b954c8795d Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Sun, 25 Oct 2020 02:28:33 +0100 Subject: [PATCH 13/13] docs/man/Makefile.am : @echo diagnostic messages without a trace by default --- docs/man/Makefile.am | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am index 9dd7200ad6..235e333251 100644 --- a/docs/man/Makefile.am +++ b/docs/man/Makefile.am @@ -686,7 +686,7 @@ if ! SKIP_MANS # runs ./configure --with-doc=skip (or --with-doc=man=skip specifically) EXTRA_DIST += dist dist: - echo "ERROR: Manpage building was disabled by configure script, and these pages are required for our proper 'make dist'" >&2 ; false + @echo "ERROR: Manpage building was disabled by configure script, and these pages are required for our proper 'make dist'" >&2 ; false endif endif @@ -724,11 +724,11 @@ if ! SKIP_MANS check-local: check-man else check-local: check-man-txt check-man-pages - echo "Man-page generation was SKIPPED per user request, so pregenerated pages were sanity-checked (if any)" >&2 + @echo "Man-page generation was SKIPPED per user request, so pregenerated pages were sanity-checked (if any)" >&2 endif else check-local: check-man-txt check-man-pages - echo "Man-page generation was not done, so pregenerated pages were sanity-checked (if any)" >&2 + @echo "Man-page generation was not done, so pregenerated pages were sanity-checked (if any)" >&2 endif check-man: check-man-txt check-man-pages check-html-man