Merge pull request #2973 from jimklimov/ci-build-quicker-matrix

Propose a `ci_build.sh` quicker matrix for `BUILD_TYPE=default-all-errors` scenarios

Author: jimklimov

Makefile.am

@@ -1426,7 +1426,11 @@ git-realclean-check:
 # quickly handled by external tools, to group (in life and log) various checks
 # separately from the probably slower/louder stages for test programs like
 # check-NIT:
-check-files-quick: spellcheck-quick check-man
+CHECK_FILES_QUICK_TARGETS = check-man
+if WITH_SPELLCHECK
+CHECK_FILES_QUICK_TARGETS += spellcheck-quick
+endif WITH_SPELLCHECK
+check-files-quick: $(CHECK_FILES_QUICK_TARGETS)
 
 # Autotools hook: run the quick checks before recursing for defaults:
 check-recursive: check-files-quick

NEWS.adoc

@@ -55,6 +55,12 @@ https://github.com/networkupstools/nut/milestone/9
      v2.8.2), where `configure --with-docs=all` no longer failed a run
      of the `configure` script when some of the required rendering tools
      were not in fact available. [#2842, fixed by #2921]
+   * Some recipe improvements in earlier releases led to `make check` always
+     running a spelling check (if tools are available), even if the explicit
+     `configure --disable-spellcheck` option was used. Now it would not run
+     if disabled (e.g. to speed up CI builds in scenarios that focus on other
+     aspects of the code base), although developers can still use the explicit
+     `make spellcheck*` goals, when tools are in fact available. [#2973]
    * A change in `Makefile.am` recipes to evaluate some driver names in the
      `DRIVERLIST` variables inspected by `configure` script, rather than
      having all their names hard-coded like before, led to inability to
@@ -107,7 +113,7 @@ https://github.com/networkupstools/nut/milestone/9
 
  - common driver code:
    * Update reports of failed socket file creation, to help troubleshooting
-     some error cases in the field.
+     some error cases in the field. [#2959]
    * Removed workarounds trying to migrate legacy driver raised `ALARM`
      status tokens into modern `alarm_*` function logic. Rather, we keep
      supporting them as separate from the modern logic, seeing as `upsmon`
@@ -120,6 +126,9 @@ https://github.com/networkupstools/nut/milestone/9
      change, operations that intend to turn off or restart the load, or can
      do that by side effect (e.g. calibration if batteries are old or dead),
      would explicitly `upslogx(LOG_CRIT,...)` by default before commencing.
+     [#2957]
+   * Fixed a couple of ancient memory leaks: one "shared" during driver
+     program initialization, and one specific to `dummy-ups` wind-down. [#2972]
 
  - `dummy-ups` driver updates:
    * A new instruction `ALARM` was added for the `Dummy Mode` operation
@@ -175,6 +184,14 @@ https://github.com/networkupstools/nut/milestone/9
    name (`man1m`), as different OS distributions have different preferences
    in this regard. [#2950]
 
+ - The `BUILD_TYPE=default-all-errors ci_build.sh` script handling was
+   revised to simplify code, and to default in CI builds to a quicker
+   mode which randomly mixes the selected SSL, USB and UNMAPPED variants
+   (and relies on the dozens of NUT CI farm runs per iteration to likely
+   cover all possible combinations), which should roughly halve the CI
+   build times. Default activity for developer builds should remain as
+   it was -- to try each such "axis" sequentially. [#2973]
+
 
 Release notes for NUT 2.8.3 - what's new since 2.8.2
 ----------------------------------------------------

ci_build.sh

@@ -232,6 +232,10 @@ SHUTDOWNCMD "/sbin/shutdown -h +0"
 #
 # Adjust this to keep upsmon from flooding your network, but don't make
 # it too high or it may miss certain short-lived power events.
+#
+# NOTE: This setting is different from a `pollfreq` supported by some of
+# the NUT driver programs, such as usbhid-ups (about how often the driver
+# polls a particular device).
 
 POLLFREQ 5
 

conf/upsmon.conf.sample.in

@@ -3581,6 +3581,8 @@ AM_CONDITIONAL(WITH_CHECK_NIT, test "${nut_enable_check_NIT}" = "yes")
 
 dnl ----------------------------------------------------------------------
 dnl checks related to --enable-spellcheck
+dnl NOTE: If the tools are present, you can "make spellcheck" explicitly;
+dnl  this setting is about trying or not to run it as part of "make check".
 
 NUT_CHECK_ASPELL
 NUT_ARG_ENABLE([spellcheck], [Run spellcheck among default checks], [auto])
@@ -3602,7 +3604,8 @@ case "${nut_enable_spellcheck}" in
 esac
 AC_MSG_RESULT([${WITH_SPELLCHECK}])
 
-AM_CONDITIONAL(WITH_SPELLCHECK, test "${WITH_SPELLCHECK}" = "yes")
+NUT_REPORT_FEATURE([requested to spell-check the documentation], [${WITH_SPELLCHECK}], [],
+					[WITH_SPELLCHECK], [Define to enable documentation spell checking as part of default checks], [-])
 
 dnl ----------------------------------------------------------------------
 dnl checks related to --with-doc

configure.ac

@@ -7,10 +7,12 @@ endif::website[]
 User manual pages
 -----------------
 
+ifndef::in-nut-manpage[]
 NUT overview
 ~~~~~~~~~~~~
 
 - linkman:nut[7]
+endif::in-nut-manpage[]
 
 Configuration files
 ~~~~~~~~~~~~~~~~~~~

docs/man/index.txt

@@ -147,6 +147,7 @@ The "primary" system is usually also responsible for commanding the managed
   systems would otherwise remain shut down indefinitely (until someone comes
   and reboots them) just because external power returned when the shut down
   spree had already started.
+
 * linkman:upsc[1] is a command-line client for anonymous read-only access,
   used to list devices served by a NUT data server, or to query data points
   reported by a particular device.
@@ -250,15 +251,16 @@ NUT Drivers as Service instances
 
 Starting with NUT v2.8.0, on systems with service management frameworks
 (like Linux systemd or Solaris/illumos SMF) you may be even inadvertently
-using the linkman:nut-driver-enumerator[8].  This is a script, which may
-also called automatically (via packaging on impacted platforms) at start-up
-or as a service, to process the linkman:ups.conf[5] file and maintain the
-service units (with their dependencies) for each driver section separately.
+using the linkman:nut-driver-enumerator[8] (also known as "NDE") facility.
+This is a script, which may be also called automatically (via packaging on
+supported platforms) at start-up or may be running continuously as a service,
+to process the linkman:ups.conf[5] file and maintain the service units
+(with their dependencies) for each driver section separately.
 
 This sometimes raises eyebrows when end-users try to manually start a NUT
 driver program (either directly or using linkman:upsdrvctl[8] tool), and
 this either fails (because the device is already busy) or gets to conflict
-with the copy of the driver running as a service instance and they begin
+with the copy of the driver running as a service instance, and they begin
 to terminate each other.
 
 Configuring NUT Drivers
@@ -321,6 +323,7 @@ to secure access to those files and their copies as well.
 :leveloffset: 1
 ///////////////
 
+:in-nut-manpage: true
 include::index.txt[]
 
 ///////////////

docs/man/nut.txt

@@ -361,6 +361,10 @@ Second, there is a point of diminishing returns if you set it too low.
 While upsd normally has all of the data available to it instantly, most
 drivers only refresh the UPS status once every 2 seconds.  Polling any
 more than that usually doesn't get you the information any faster.
++
+NOTE: This setting is different from a `pollfreq` supported by some of
+the NUT driver programs, such as linkman:usbhid-ups[8] (about how often
+the driver polls a particular device).
 
 *POLLFREQALERT* 'seconds'::
 

docs/man/upsmon.conf.txt

@@ -120,6 +120,9 @@ Set polling frequency for full updates, in seconds. Compared to the quick
 updates performed every "pollinterval" (the latter option is described in
 linkman:ups.conf[5]), the "pollfreq" interval is for polling the less-critical
 variables.  The default value is 30 (in seconds), or 12 sec for CPS devices.
++
+NOTE: This setting is different from a `POLLFREQ` supported by linkman:upsmon[8]
+(for details see its linkman:upsmon.conf[5]).
 
 *pollonly*::
 If this flag is set, the driver will not use Interrupt In transfers during the