Fty remerge 20220225

.github/pull_request_template.md

@@ -45,7 +45,7 @@
   (several vendors do use same interface chips for unrelated protocols).
 
 - [ ] For new USB devices, built and committed the changes for the
-  `scripts/upower/95-upower-hid.rules` file
+  `scripts/upower/95-upower-hid.hwdb` file
 
 - [ ] Proposed NUT data mapping is aligned with existing `docs/nut-names.txt`
   file. If the device exposes useful data points not listed in the file, the

.gitignore

@@ -10,6 +10,7 @@
 .libs/
 .inst/
 /tmp/
+/obj/
 /_install_pkgprotodir/
 Makefile
 Makefile.in
@@ -63,3 +64,5 @@ __pycache__/
 # Debuggers and IDEs
 .gdb_history
 /nbproject
+/.idea
+/*.iml

.lgtm.yml

@@ -2,7 +2,7 @@
 path_classifiers:
   template:
     - exclude: "**/*.py.in"
-    - exclude: "**/NUT-Monitor.in"
+    - exclude: "**/NUT-Monitor*.in"
 
 queries:
 - exclude: cpp/fixme-comment
@@ -17,4 +17,4 @@ extraction:
     index:
       filters:
         - include: "**/*.py.in"
-        - include: "**/NUT-Monitor.in"
+        - include: "**/NUT-Monitor*.in"

INSTALL.nut

@@ -1,11 +1,13 @@
 Installation instructions
 =========================
 
-This chapter describe the various methods for installing Network UPS Tools.
+This chapter describes the various methods for installing Network UPS Tools.
 
 Whenever it is possible, prefer <<Installing_packages, installing from packages>>.
 Packagers have done an excellent and hard work at improving NUT integration into
-their system.
+their system.  On the other hand, distributions and appliances tend to package
+"official releases" of projects such as NUT, and so do not deliver latest and
+greatest fixes, new drivers, bugs and other features.
 
 [[Installing_source]]
 Installing from source
@@ -16,6 +18,13 @@ These are the essential steps for compiling and installing this software.
 The NUT linkdoc:packager-guide[Packager Guide], which presents the best
 practices for installing and integrating NUT, is also a good reading.
 
+The link:config-prereqs.txt[Prerequisites for building NUT on different OSes]
+document suggests prerequisite packages with tools and dependencies
+available and needed to build and test as much as possible of NUT on
+numerous platforms, written from perspective of CI testing (if you
+are interested in getting updated drivers for a particular device,
+you might select a sub-set of those suggestions).
+
 [NOTE]
 .Keep in mind that...
 ================================================================================
@@ -52,7 +61,7 @@ long as you are consistent.
 The process for doing this varies from one system to the next, and
 explaining how to add users is beyond the scope of this document.
 
-For the purposes of this document, the user name and group name 
+For the purposes of this document, the user name and group name
 will be 'ups' and 'nut' respectively.
 
 Be sure the new user is a member of the new group!  If you forget to
@@ -87,7 +96,7 @@ docs/configure.txt or './configure --help' for all the available
 options.
 
 If you alter paths with additional switches, be sure to use those
-new paths while reading the rest of the steps.    
+new paths while reading the rest of the steps.
 
 Reference: <<Configure_options,Configure options>> from the
 User Manual.
@@ -100,7 +109,7 @@ Build the programs
 
 This will build the NUT client and server programs and the
 selected drivers. It will also build any other features that were
-selected during <<Configuration,configuration>> step above. 
+selected during <<Configuration,configuration>> step above.
 
 
 Installation
@@ -175,7 +184,7 @@ permissions for the USB device, you may need to set up (operating
 system dependent) hotplugging scripts.  Sample scripts and
 information are provided in the scripts/hotplug and
 scripts/udev directories. For most users, the hotplugging scripts
-will be installed automatically by "make install". 
+will be installed automatically by "make install".
 
 (If you want to try if a driver works without setting up
 hotplugging, you can add the "-u root" option to upsd, upsmon, and
@@ -299,7 +308,7 @@ To install NUT as a package execute:
 Port
 ^^^^
 
-The port is located under +sysutils/nut+. 
+The port is located under +sysutils/nut+.
 Use +make config+ to select configuration options, e.g. to build the optional CGI scripts.
 To install it, use:
 

Jenkinsfile-dynamatrix

@@ -32,6 +32,9 @@ import org.nut.dynamatrix.*;
     dynacfgPipeline.axisCombos_COMPILER_GCC = [~/COMPILER=GCC/]
     dynacfgPipeline.axisCombos_COMPILER_NOT_GCC = [~/COMPILER=(?!GCC)/]
 
+    // Avoid requiring success on GCC so old we can't manage warnings by CLI or pragmas:
+    dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD = [~/COMPILER=GCC/, ~/GCCVER=([0123]\.|4\.[0123])/]
+
     // Beside the flag here, the pre-defined C89/C90/ANSI scenarios
     // should only get considered in branches named ~/fightwarn.*89.*/
     // or PRs to those (for non-GCC builds):
@@ -58,6 +61,14 @@ import org.nut.dynamatrix.*;
     dynacfgPipeline.failFast = //true //
         false
 
+    // How long can a single "slow-build stage" run before we
+    // consider that the build agent is stuck or network dropped?
+    // The dynamatrix should try to re-schedule this scenario then.
+    dynacfgPipeline.dsbcStageTimeoutSettings = [
+        time: 2,
+        unit: 'HOURS'
+        ]
+
     // Note: this setting causes a lot of noise in build summary page and
     // parent job definition (PR, branch...) overview page on Jenkins,
     // by reporting dozens of lines for each analyzer ID ever published.
@@ -419,7 +430,8 @@ set | sort -n """
                     ],
                 runAllowedFailure: true,
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
-                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C
+                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                 ], body)
             }, // getParStages
         'bodyParStages': dynacfgPipeline.slowBuildDefaultBody_ci_build
@@ -618,7 +630,8 @@ set | sort -n """
                     ],
                 runAllowedFailure: true,
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
-                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C
+                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                 ], body)
             }, // getParStages
         'bodyParStages': dynacfgPipeline.slowBuildDefaultBody_ci_build
@@ -673,13 +686,14 @@ set | sort -n """
                     ],
                 runAllowedFailure: true,
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesLabels': 'replace', 'commonLabelExpr': 'replace', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
-                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C
+                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                 ], body)
             }, // getParStages
         'bodyParStages': dynacfgPipeline.slowBuildDefaultBody_ci_build
         ] // one slowBuild filter configuration
 
-        ,[name: 'A build with all docs types on capable systems, and a distcheck (must pass)',
+        ,[name: 'An out-of-tree build with all docs types on capable systems, and a distcheck (must pass)',
          // TODO: This is a recipe (and target OS) test for ability to build
          // the docs without error; it should not iterate compilers (maybe
          // iterate docs tools though, if we were to support many backends?)
@@ -703,6 +717,9 @@ set | sort -n """
                     ],
                 dynamatrixAxesCommonEnv: [
                     ['LANG=C','LC_ALL=C','TZ=UTC',
+                     // Build in a subdirectory to check that out-of-dir
+                     // builds are healthy too
+                     'CI_BUILDDIR=obj',
                      'BUILD_WARNFATAL=yes','BUILD_WARNOPT=minimal'
                     ]
                     ],
@@ -711,7 +728,8 @@ set | sort -n """
                     ],
                 runAllowedFailure: true,
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesLabels': 'replace', 'commonLabelExpr': 'replace', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
-                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C
+                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                 ], body)
             }, // getParStages
         'bodyParStages': dynacfgPipeline.slowBuildDefaultBody_ci_build
@@ -749,7 +767,8 @@ set | sort -n """
                     ],
                 runAllowedFailure: true,
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesLabels': 'replace', 'commonLabelExpr': 'replace', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
-                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C
+                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                 ], body)
             }, // getParStages
         'bodyParStages': dynacfgPipeline.slowBuildDefaultBody_ci_build
@@ -776,7 +795,7 @@ set | sort -n """
                 dynamatrixAxesCommonEnv: [
                     ['LANG=C','LC_ALL=C','TZ=UTC',
                      'BUILD_TYPE=default-all-errors',
-                     'BUILD_WARNFATAL=yes','BUILD_WARNOPT=auto'
+                     'BUILD_WARNFATAL=no','BUILD_WARNOPT=auto'
                     ]
                     ],
                 allowedFailure: [
@@ -812,7 +831,7 @@ set | sort -n """
                 dynamatrixAxesCommonEnv: [
                     ['LANG=C','LC_ALL=C','TZ=UTC',
                      'BUILD_TYPE=default-all-errors',
-                     'BUILD_WARNFATAL=yes','BUILD_WARNOPT=auto'
+                     'BUILD_WARNFATAL=no','BUILD_WARNOPT=auto'
                     ]
                     ],
                 allowedFailure: [
@@ -931,7 +950,8 @@ set | sort -n """
                     ],
                 runAllowedFailure: true,
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
-                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C
+                excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                     //+ [ [~/COMPILER=GCC/, ~/CSTDVERSION_KEY=(?!89)/] ]
                 ], body)
             }, // getParStages
@@ -972,13 +992,14 @@ set | sort -n """
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
                 excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C + [
                     [~/COMPILER=GCC/, ~/CSTDVERSION_KEY=(?!89)/]
-                    ]
+                    ] +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                 ], body)
             }, // getParStages
         'bodyParStages': dynacfgPipeline.slowBuildDefaultBody_ci_build
         ] // one slowBuild filter configuration
 
-        ,[name: 'GNU C standard builds with fatal warnings with GCC, without distcheck and docs (must pass)',
+        ,[name: 'GNU C standard out-of-tree builds with fatal warnings with GCC, without distcheck and docs (must pass)',
          disabled: dynacfgPipeline.disableSlowBuildCIBuild,
          //branchRegexSource: ~/^(PR-.+|fightwarn.*)$/,
          //branchRegexTarget: dynacfgPipeline.branchStableRegex,
@@ -997,6 +1018,9 @@ set | sort -n """
                     ['LANG=C','LC_ALL=C','TZ=UTC',
                      'BUILD_TYPE=default-all-errors',
                      'BUILD_WARNFATAL=yes',
+                     // Build in a subdirectory to check that out-of-dir
+                     // builds are healthy too
+                     'CI_BUILDDIR=obj',
                      // NOTE: "gcc-hard" warnings are still not as picky
                      // as "clang-hard" and do not differ much from the
                      // "gcc-medium" definition currently:
@@ -1010,7 +1034,8 @@ set | sort -n """
                 mergeMode: [ 'excludeCombos': 'merge', 'dynamatrixAxesCommonEnv': 'replace' ], // NOTE: We might want to replace other fields, but excludeCombos must be merged to filter compiler versions vs language standards as centrally defined!
                 excludeCombos: dynacfgPipeline.excludeCombos_DEFAULT_CPPUNIT_STRICT_C + [
                     [~/COMPILER=(?!GCC)/]
-                    ]
+                    ] +
+                    [dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD]
                 ], body)
             }, // getParStages
         'bodyParStages': dynacfgPipeline.slowBuildDefaultBody_ci_build
@@ -1073,6 +1098,7 @@ set | sort -n """
                     ],
                 allowedFailure: [
                     dynacfgPipeline.axisCombos_STRICT_C,
+                    dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD,
                     [~/BUILD_WARNOPT=hard/]
                     ],
                 runAllowedFailure: true,
@@ -1111,6 +1137,7 @@ set | sort -n """
                     ],
                 allowedFailure: [
                     dynacfgPipeline.axisCombos_STRICT_C,
+                    dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD,
                     [~/BUILD_WARNOPT=hard/]
                     ],
                 runAllowedFailure: true,
@@ -1146,6 +1173,7 @@ set | sort -n """
                     ],
                 allowedFailure: [
                     dynacfgPipeline.axisCombos_STRICT_C,
+                    dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD,
                     [~/BUILD_WARNOPT=hard/]
                     ],
                 runAllowedFailure: true,
@@ -1191,6 +1219,7 @@ set | sort -n """
                 excludeCombos: [
                     dynacfgPipeline.axisCombos_ARCH32x64,
                     dynacfgPipeline.axisCombos_ARCH64x32,
+                    dynacfgPipeline.axisCombos_COMPILER_GCC_TOO_OLD,
                     dynacfgPipeline.axisCombos_NOT_WINDOWS
                     ]
                 ], body)

Makefile.am

@@ -194,8 +194,18 @@ spellcheck spellcheck-interactive:
 	(cd $(builddir)/data && $(MAKE) -s $@) || RES=$$? ; \
 	exit $$RES
 
-doc spellcheck-sortdict:
-	cd $(srcdir)/docs && $(MAKE) $@
+# 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 $(builddir)/docs && $(MAKE) $@
+
+check-NIT check-NIT-devel:
+	cd $(builddir)/tests/NIT && $(MAKE) $@
 
 # This target adds syntax-checking for committed shell script files,
 # to avoid surprises and delays in finding fatal typos after packaging
@@ -296,11 +306,15 @@ tools/gitlog2changelog.py: tools/gitlog2changelog.py.in
 
 # ----------------------------------------------------------------------
 # Maintainers targets: distribution signature and hashes
-dist-sig:
+nut-@PACKAGE_VERSION@.tar.gz: dist
+nut-@PACKAGE_VERSION@.tar.gz.sig: dist-sig
+nut-@PACKAGE_VERSION@.tar.gz.md5 nut-@PACKAGE_VERSION@.tar.gz.sha256: dist-hash
+
+dist-sig: nut-@PACKAGE_VERSION@.tar.gz
 	rm -f nut-@PACKAGE_VERSION@.tar.gz.sig
 	gpg --detach-sign nut-@PACKAGE_VERSION@.tar.gz
 
-dist-hash:
+dist-hash: nut-@PACKAGE_VERSION@.tar.gz
 	md5sum nut-@PACKAGE_VERSION@.tar.gz > nut-@PACKAGE_VERSION@.tar.gz.md5
 	sha256sum nut-@PACKAGE_VERSION@.tar.gz > nut-@PACKAGE_VERSION@.tar.gz.sha256
 
@@ -376,7 +390,7 @@ MAINTAINERCLEANFILES_PACKAGES += *.p5p
 MAINTAINERCLEANFILES += $(MAINTAINERCLEANFILES_DISTBALL)
 MAINTAINERCLEANFILES += $(MAINTAINERCLEANFILES_PACKAGES)
 
-package:
+package: dist
 	DESTDIR="$(abs_builddir)/_install_pkgprotodir" ; export DESTDIR; \
 	rm -rf "$$DESTDIR"; \
 	case "`uname -s`" in \