Fix Makefile cleanup

Makefile.am

@@ -51,9 +51,48 @@ memcheck distcheck-valgrind:
 distcleancheck:
 	@:
 
-clean-local:
-	rm -f *-spellchecked
-	rm -f cppcheck*.xml
+# Quick alias for root dir recipe:
+realclean: maintainer-clean
+
+# Files made by our targets:
+CLEANFILES = *-spellchecked cppcheck*.xml
+DISTCLEANFILES = ChangeLog
+
+# Most of the files generated by custom rules in the configure script
+# or by autogen.sh are cleaned by the Makefile.am in their directories.
+# Files below are re-created by running `configure` script and may be
+# wiped by a `make distclean`:
+DISTCLEANFILES += config.log configure~
+#???# configure.ac~
+DISTCLEANFILES += include/config.h.in~
+
+# Files made by autotools and common rituals of the configure script,
+# these are needed to run the configure script itself so are not wiped
+# by a mere `make distclean`; most of these are copied by autotools
+# from their installation, or made by `automake` etc. on the system
+# which generates `configure`; rebuilding NUT after deleting these
+# requires `autogen.sh` script to be re-run (and tools available):
+MAINTAINERCLEANFILES = INSTALL
+MAINTAINERCLEANFILES += aclocal.m4 config.guess config.sub
+MAINTAINERCLEANFILES += configure
+MAINTAINERCLEANFILES += depcomp install-sh ltmain.sh missing test-driver
+MAINTAINERCLEANFILES += m4/libtool.m4 m4/ltoptions.m4 m4/ltsugar.m4 m4/ltversion.m4 m4/lt~obsolete.m4
+MAINTAINERCLEANFILES += Makefile.in include/config.h.in
+
+# Do not let $SUBDIRS/Makefile rules delete their local .deps because
+# this breaks our ability to clean up (e.g. some common/.../*.Plo files
+# are included by generated Makefiles from other subdirectories, so they
+# should be available during their clean-up). Just in case, we make sure
+# here that their sub-distcleans complete first.
+distclean-local:
+	@for DIR in $(SUBDIRS) ; do \
+		if test -f "$${DIR}/Makefile" ; then \
+			echo "  DISTCLEAN  in $${DIR}" >&2 ; \
+			( cd "$${DIR}" && $(MAKE) -s distclean ) || exit ; \
+		fi ; \
+	 done
+	rm -rf .inst tmp autom4te.cache
+	find "$(builddir)" -type d -name '.deps' | while read DIR ; do rm -rf "$${DIR}" ; done
 
 # Hook the documentation building and validating recipes
 # Note: these are optionally available (as determined during configure runs)
@@ -122,7 +161,7 @@ endif !HAVE_CPPCHECK
 
 # ----------------------------------------------------------------------
 # Automatically generate the ChangeLog from Git logs:
-MAINTAINERCLEAN_FILES = ChangeLog
+MAINTAINERCLEANFILES += ChangeLog
 
 # Older boundary of the ChangeLog commits range
 # It can be a tag ('v2.2.0'), a commit hash, a date, ...
@@ -141,6 +180,9 @@ ChangeLog: tools/gitlog2changelog.py dummy-stamp
 nut_version.h include/nut_version.h:
 	cd $(abs_top_builddir)/include && $(MAKE) nut_version.h
 
+tools/gitlog2changelog.py: tools/gitlog2changelog.py.in
+	cd $(@D) && $(MAKE) -s $(@F)
+
 # ----------------------------------------------------------------------
 # Maintainers targets: distribution signature and hashes
 dist-sig:
@@ -206,6 +248,23 @@ snmp build-snmp install-snmp install-snmp-mgr install-snmp-man:
 setver:
 	@echo "Error: 'make setver' no longer exists."
 	@echo "Edit configure.ac to set version number."
+
+# Clean the dist tarball and packages
+MAINTAINERCLEANFILES_DISTBALL = nut-*.tar.gz
+# HP-UX:
+MAINTAINERCLEANFILES_PACKAGES = NUT_HPUX_package@PACKAGE_VERSION@.depot
+# AIX as below, and RedHat-compatible (cover binary and source packages):
+MAINTAINERCLEANFILES_PACKAGES += nut*rpm
+# Debian-compatible (cover binary and source packages):
+MAINTAINERCLEANFILES_PACKAGES += nut*deb
+# Solaris SVR4 package archives:
+MAINTAINERCLEANFILES_PACKAGES += NUT_solaris_*_package@PACKAGE_VERSION@.local.gz
+# Newer Solaris IPS (aka "pkg(5)" format archives)
+MAINTAINERCLEANFILES_PACKAGES += *.p5p
+
+MAINTAINERCLEANFILES += $(MAINTAINERCLEANFILES_DISTBALL)
+MAINTAINERCLEANFILES += $(MAINTAINERCLEANFILES_PACKAGES)
+
 package:
 	DESTDIR="$(abs_builddir)/_install_pkgprotodir" ; export DESTDIR; \
 	rm -rf "$$DESTDIR"; \

ci_build.sh

@@ -220,6 +220,19 @@ configure_nut() {
         CONFIGURE_SCRIPT=./configure.bat
     fi
 
+    if [ ! -s "$CONFIGURE_SCRIPT" ]; then
+        # Note: modern auto(re)conf requires pkg-config to generate the configure
+        # script, so to stage the situation of building without one (as if on an
+        # older system) we have to remove it when we already have the script.
+        # This matches the use-case of distro-building from release tarballs that
+        # include all needed pre-generated files to rely less on OS facilities.
+        if [ "$CI_OS_NAME" = "windows" ] ; then
+            $CI_TIME ./autogen.sh || true
+        else
+            $CI_TIME ./autogen.sh ### 2>/dev/null
+        fi || exit
+    fi
+
     # Help copy-pasting build setups from CI logs to terminal:
     local CONFIG_OPTS_STR="`for F in "${CONFIG_OPTS[@]}" ; do echo "'$F' " ; done`" ### | tr '\n' ' '`"
     echo "=== CONFIGURING NUT: $CONFIGURE_SCRIPT ${CONFIG_OPTS_STR}"
@@ -252,6 +265,29 @@ build_to_only_catch_errors() {
     return 0
 }
 
+optional_maintainer_clean_check() {
+    if [ "${DO_MAINTAINER_CLEAN_CHECK-}" = "no" ] ; then
+        echo "Skipping maintainer-clean check because recipe/developer said so"
+    else
+        [ -z "$CI_TIME" ] || echo "`date`: Starting maintainer-clean check of currently tested project..."
+
+        # Note: currently Makefile.am has just a dummy "distcleancheck" rule
+        $CI_TIME $MAKE VERBOSE=1 DISTCHECK_FLAGS="$DISTCHECK_FLAGS" $PARMAKE_FLAGS maintainer-clean || return
+
+        echo "=== Are GitIgnores good after '$MAKE maintainer-clean'? (should have no output below)"
+        git status --ignored -s || true
+        echo "==="
+
+        if [ -n "`git status --ignored -s`" ] && [ "$CI_REQUIRE_GOOD_GITIGNORE" != false ]; then
+            echo "FATAL: There are changes in some files listed above - tracked sources should be updated in the PR, and build products should be added to a .gitignore file, everything made should be cleaned and no tracked files should be removed!" >&2
+            git diff || true
+            echo "==="
+            return 1
+        fi
+    fi
+    return 0
+}
+
 echo "Processing BUILD_TYPE='${BUILD_TYPE}' ..."
 
 echo "Build host settings:"
@@ -642,7 +678,7 @@ default|default-alldrv|default-alldrv:no-distcheck|default-all-errors|default-sp
     else
         $CI_TIME ./autogen.sh ### 2>/dev/null
     fi
-    if [ "$NO_PKG_CONFIG" == "true" ] && [ "$CI_OS_NAME" = "linux" ] ; then
+    if [ "$NO_PKG_CONFIG" == "true" ] && [ "$CI_OS_NAME" = "linux" ] && (command -v dpkg) ; then
         echo "NO_PKG_CONFIG==true : BUTCHER pkg-config for this test case" >&2
         sudo dpkg -r --force all pkg-config
     fi
@@ -678,6 +714,9 @@ default|default-alldrv|default-alldrv:no-distcheck|default-all-errors|default-sp
                 echo "CCache stats after build:"
                 ccache -s
             fi
+
+            optional_maintainer_clean_check || exit
+
             echo "=== Exiting after the custom-build target '$MAKE $BUILD_TGT' succeeded OK"
             exit 0
             ;;
@@ -777,6 +816,11 @@ default|default-alldrv|default-alldrv:no-distcheck|default-all-errors|default-sp
                     RES=$?
                     FAILED="${FAILED} NUT_SSL_VARIANT=${NUT_SSL_VARIANT}[build]"
                 }
+
+                optional_maintainer_clean_check || {
+                    RES=$?
+                    FAILED="${FAILED} NUT_SSL_VARIANT=${NUT_SSL_VARIANT}[maintainer_clean]"
+                }
             done
             # TODO: Similar loops for other variations like TESTING,
             # MGE SHUT vs other serial protocols, libusb version...
@@ -827,9 +871,18 @@ default|default-alldrv|default-alldrv:no-distcheck|default-all-errors|default-sp
         echo "=== Are GitIgnores good after '$MAKE distcheck'? (should have no output below)"
         git status -s || true
         echo "==="
+
+        if [ -n "`git status -s`" ] && [ "$CI_REQUIRE_GOOD_GITIGNORE" != false ]; then
+            echo "FATAL: There are changes in some files listed above - tracked sources should be updated in the PR, and build products should be added to a .gitignore file!" >&2
+            git diff || true
+            echo "==="
+            exit 1
+        fi
         )
     fi
 
+    optional_maintainer_clean_check || exit
+
     if [ "$HAVE_CCACHE" = yes ]; then
         echo "CCache stats after build:"
         ccache -s

clients/Makefile.am

@@ -94,3 +94,10 @@ libnutclientstub_la_LIBADD = libnutclient.la
 else
 EXTRA_DIST += nutclientmem.h nutclientmem.cpp
 endif
+
+MAINTAINERCLEANFILES = Makefile.in
+
+# NOTE: Do not clean ".deps" in SUBDIRS of the main project,
+# the root Makefile.am takes care of that!
+#clean-local:
+#	rm -rf $(builddir)/.deps

common/Makefile.am

@@ -20,3 +20,10 @@ libcommonclient_la_SOURCES = common.c state.c str.c
 # using LTLIBOBJS. Refer to configure.in/.ac -> AC_REPLACE_FUNCS
 libcommon_la_LIBADD = libparseconf.la @LTLIBOBJS@
 libcommonclient_la_LIBADD = libparseconf.la @LTLIBOBJS@
+
+MAINTAINERCLEANFILES = Makefile.in
+
+# NOTE: Do not clean ".deps" in SUBDIRS of the main project,
+# the root Makefile.am takes care of that!
+#clean-local:
+#	rm -rf $(builddir)/.deps

conf/Makefile.am

@@ -19,9 +19,6 @@ nodist_sysconf_DATA = upssched.conf.sample upsmon.conf.sample
 SPELLCHECK_SRC = $(dist_sysconf_DATA) \
  upssched.conf.sample.in upsmon.conf.sample.in
 
-clean-local:
-	rm -f *.pdf *.html *-spellchecked
-
 # NOTE: Due to portability, we do not use a GNU percent-wildcard extension:
 #%-spellchecked: % Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT)
 #	$(MAKE) -s -f $(top_builddir)/docs/Makefile SPELLCHECK_SRC_ONE="$<" SPELLCHECK_DIR="$(srcdir)" $@
@@ -38,3 +35,7 @@ clean-local:
 
 spellcheck spellcheck-interactive spellcheck-sortdict:
 	$(MAKE) -f $(top_builddir)/docs/Makefile SPELLCHECK_SRC="$(SPELLCHECK_SRC)" SPELLCHECK_DIR="$(srcdir)" $@
+
+
+MAINTAINERCLEANFILES = Makefile.in
+CLEANFILES = *.pdf *.html *-spellchecked

data/Makefile.am

@@ -6,9 +6,6 @@ dist_data_DATA = cmdvartab
 nodist_data_DATA = driver.list
 EXTRA_DIST = evolution500.seq epdu-managed.dev
 
-clean-local:
-	rm -f *.pdf *.html *-spellchecked
-
 # NOTE: Due to portability, we do not use a GNU percent-wildcard extension:
 #%-spellchecked: % Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT)
 #	$(MAKE) -s -f $(top_builddir)/docs/Makefile SPELLCHECK_SRC_ONE="$<" SPELLCHECK_DIR="$(srcdir)" $@
@@ -18,3 +15,6 @@ cmdvartab-spellchecked: cmdvartab Makefile.am $(top_srcdir)/docs/Makefile.am $(a
 
 spellcheck spellcheck-interactive spellcheck-sortdict:
 	$(MAKE) -f $(top_builddir)/docs/Makefile SPELLCHECK_SRC="cmdvartab" SPELLCHECK_DIR="$(srcdir)" $@
+
+MAINTAINERCLEANFILES = Makefile.in
+CLEANFILES = *.pdf *.html *-spellchecked

data/html/Makefile.am

@@ -1,7 +1,11 @@
-# Network UPS Tools: data/html                                                  
+# Network UPS Tools: data/html
 # install these only if configured --with-cgi
 if WITH_CGI
  dist_html_DATA = index.html bottom.html nut-banner.png
  nodist_html_DATA = header.html
 endif
 EXTRA_DIST = README
+
+MAINTAINERCLEANFILES = Makefile.in
+# Generated by configure script:
+DISTCLEANFILES = header.html

docs/Makefile.am

@@ -1,4 +1,4 @@
-DISTCLEANFILES =
+MAINTAINERCLEANFILES = Makefile.in
 EXTRA_DIST =
 
 # Is "egrep == grep -E" always valid? (maybe all a job for configure.ac)
@@ -136,8 +136,10 @@ check-man:
 man:
 	cd $(top_builddir)/docs/man/ && $(MAKE) -f Makefile all
 
+CLEANFILES = *.xml *.html *.pdf *-spellchecked docbook-xsl.css
+
+# Dirs to clean
 clean-local:
-	rm -f *.pdf *.html *-spellchecked docbook-xsl.css
 	rm -rf *.chunked *.bak tmp
 
 ### TODO: automatic dependency generation
@@ -368,7 +370,7 @@ $(abs_builddir)/$(NUT_SPELL_DICT).sorted: $(abs_srcdir)/$(NUT_SPELL_DICT)
 	    cp -f "$(abs_builddir)/$(NUT_SPELL_DICT).bak-pre-sorting" "$(abs_srcdir)/" || true ; \
 	 fi
 
-DISTCLEANFILES += $(NUT_SPELL_DICT).bak-pre-sorting .$(NUT_SPELL_DICT).sorted $(NUT_SPELL_DICT).sorted
+DISTCLEANFILES = $(NUT_SPELL_DICT).bak-pre-sorting .$(NUT_SPELL_DICT).sorted $(NUT_SPELL_DICT).sorted
 
 spellcheck-interactive: 
 	@FAILED="" ; for docsrc in $(SPELLCHECK_SRC); do \

docs/cables/Makefile.am

@@ -1,2 +1,2 @@
-clean-local:
-	rm -f *-spellchecked
+CLEANFILES = *-spellchecked
+MAINTAINERCLEANFILES = Makefile.in

docs/man/Makefile.am

@@ -790,7 +790,7 @@ check-man-txt: $(SRC_ALL_PAGES)
 	    echo "FAILED man-source sanity check for:$$FAILED" >&2 ; file $$FAILED >&2 ; exit 1; \
 	fi; echo "PASSED man-source sanity check (checked $$CHECKED files)"; exit 0
 
-CLEANFILES = *.xml *.html
+CLEANFILES = *-spellchecked
 
 SUFFIXES = .txt .html .1 .3 .5 .8
 
@@ -806,6 +806,8 @@ endif
 
 if HAVE_ASCIIDOC
 
+CLEANFILES += *.1 *.3 *.5 *.8 *.xml *.html *.pdf
+
 # Working around a2x not friendly to parallelized runs.
 # See more details in the main NUT docs/Makefile.am
 DOCBUILD_BEGIN = { \
@@ -931,11 +933,6 @@ else !HAVE_ASCIIDOC
 
 endif !HAVE_ASCIIDOC
 
-clean-local:
-	rm -f *.pdf *.html *-spellchecked
-	rm -f *.1 *.3 *.5 *.8
-	rm -rf tmp
-
 # NOTE: Due to portability, we do not use a GNU percent-wildcard extension:
 #%-spellchecked: % Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT)
 #	$(MAKE) -s -f $(top_builddir)/docs/Makefile SPELLCHECK_SRC_ONE="$<" SPELLCHECK_DIR="$(srcdir)" $@
@@ -948,3 +945,8 @@ clean-local:
 
 spellcheck spellcheck-interactive spellcheck-sortdict:
 	$(MAKE) -f $(top_builddir)/docs/Makefile SPELLCHECK_SRC="$(SRC_ALL_PAGES)" SPELLCHECK_DIR="$(srcdir)" $@
+
+MAINTAINERCLEANFILES = Makefile.in
+
+clean-local:
+	rm -rf tmp

drivers/Makefile.am

@@ -54,7 +54,9 @@ MODBUS_DRIVERLIST = phoenixcontact_modbus generic_modbus
 LINUX_I2C_DRIVERLIST = asem pijuice
 
 # distribute all drivers, even ones that are not built by default
-EXTRA_PROGRAMS = $(SERIAL_DRIVERLIST) $(SNMP_DRIVERLIST) $(USB_DRIVERLIST) $(SERIAL_USB_DRIVERLIST) $(NEONXML_DRIVERLIST) $(MACOSX_DRIVERLIST)
+EXTRA_PROGRAMS  = $(SERIAL_DRIVERLIST) $(USB_DRIVERLIST) $(SERIAL_USB_DRIVERLIST)
+EXTRA_PROGRAMS += $(SNMP_DRIVERLIST) $(NEONXML_DRIVERLIST) $(MACOSX_DRIVERLIST)
+EXTRA_PROGRAMS += $(LINUX_I2C_DRIVERLIST)
 
 # construct the list of drivers to build
 if SOME_DRIVERS
@@ -325,3 +327,11 @@ libdummy_la_SOURCES = main.c dstate.c
 libdummy_la_LDFLAGS = -no-undefined -static
 libdummy_serial_la_SOURCES = serial.c
 libdummy_serial_la_LDFLAGS = -no-undefined -static
+
+CLEANFILES = $(EXTRA_LTLIBRARIES) $(EXTRA_PROGRAMS)
+MAINTAINERCLEANFILES = Makefile.in
+
+# NOTE: Do not clean ".deps" in SUBDIRS of the main project,
+# the root Makefile.am takes care of that!
+#clean-local:
+#	rm -rf $(builddir)/.deps

include/Makefile.am

@@ -4,6 +4,7 @@ dist_noinst_HEADERS = attribute.h common.h extstate.h parseconf.h proto.h	\
 # http://www.gnu.org/software/automake/manual/automake.html#Clean
 BUILT_SOURCES = nut_version.h
 CLEANFILES = nut_version.h
+MAINTAINERCLEANFILES = Makefile.in
 
 # magic to include Git version information in NUT version string
 # (for builds not made from the tagged commit in a Git workspace)
@@ -32,7 +33,7 @@ nut_version.h: FORCE
 FORCE:
 
 # counter part of BUILT_SOURCES: since nut_version is not a direct
-# deps of a local target, we must clean it by ourself before the
+# deps of a local target, we must clean it by ourselves before the
 # distribution
 dist-hook:
 	rm -f $(distdir)/nut_version.h

lib/Makefile.am

@@ -8,5 +8,5 @@ else
 endif
 endif
 
-clean-local:
-	rm -f *-spellchecked
+CLEANFILES = *-spellchecked
+MAINTAINERCLEANFILES = Makefile.in

scripts/Makefile.am

@@ -26,3 +26,5 @@ EXTRA_DIST = README \
     Windows/Makefile
 
 SUBDIRS = augeas devd hotplug python systemd udev ufw Solaris upsdrvsvcctl
+
+MAINTAINERCLEANFILES = Makefile.in

scripts/Solaris/Makefile.am

@@ -84,3 +84,5 @@ check-local-solaris-smf: $(SOLARIS_SMF_MANIFESTS)
 	    echo "  SVCCFG-VALIDATE  $$F"; \
 	    /usr/sbin/svccfg validate "$$F" || RES=$$? ; \
 	 done; exit $$RES
+
+MAINTAINERCLEANFILES = Makefile.in