Merge ebb5898 into 0e051f9

Author: jimklimov

NEWS.adoc

@@ -18,6 +18,31 @@ ChangeLog file (generated for release archives), or to the Git version
 control history for "live" codebase.
 
 
+PLANNED: Release notes for NUT 2.8.6 - what's new since 2.8.5
+-------------------------------------------------------------
+
+https://github.com/networkupstools/nut/milestone/13
+
+ - (expected) Dynamic Mapping Files (DMF) feature supported, to allow
+   the driver binaries to be built once and data mappings to be loaded
+   and modernized on the fly (porting from 42ITy project)
+
+ - (expected) Porting of patches suggested by different distribution packages
+
+ - (expected) C code clean-up/consistency (string format security, work with
+   Boolean values, string to number conversions, etc. in the same manner)
+
+ - (expected) clean-up of libusb API variants support [#300 and follow-ups]
+
+ - (expected) CI automation for coding style
+
+ - (expected) CI automation for driver flags and variables to be certainly
+   documented, handled in augeas lenses, nutconf classes, etc.
+
+ - (expected) CI automation for use of data points in drivers that conform
+   to patterns defined in link:docs/nut-names.txt[]
+
+
 Release notes for NUT 2.8.5 - what's new since 2.8.4
 ----------------------------------------------------
 

UPGRADING.adoc

@@ -28,6 +28,11 @@ be beneficial to add `--enable-option-checking=fatal` to the `./configure`
 command line, in order to quickly pick up any other removed option flags.
 ======
 
+Changes from 2.8.5 to 2.8.6
+---------------------------
+
+- PLANNED: Keep track of any further API clean-up?
+
 Changes from 2.8.4 to 2.8.5
 ---------------------------
 

docs/docinfo.xml.in

@@ -4,7 +4,6 @@
     -->
 
   <!-- Current release of NUT (to be left on top) -->
-<!--
   <revision>
     <revnumber>@PACKAGE_VERSION@ @NUT_SOURCE_GITREV@</revnumber>
     <date>@now@</date>
@@ -13,37 +12,36 @@
       Current release snapshot of Network UPS Tools (NUT).
     </revremark>
   </revision>
--->
 
   <!-- 'Real' revision history (news on top). The revremarks are based
        on 'git diff ${RELTAG}..${RELTAG_NEXT} NEWS UPGRADING "*.txt"'
        with a focus on those changes which impacted documentation.
     -->
   <!-- AUTOINSERT LOCATION -->
   <revision>
-    <revnumber>2.8.4</revnumber>
-    <date>2025-08-07</date>
+    <revnumber>2.8.5</revnumber>
+    <date>2026-04-07</date>
     <authorinitials>JK</authorinitials>
     <revremark>
-        Fixed a few regressions introduced by release v2.8.3.
-        Some changes to docs and recipes, especially for parallel builds.
-        Updated NUT SEMVER definition some more.
+        Some changes to docs and recipes, especially for parallel builds;
+        introduced a way to build with private shared libraries to save space.
+        Updated NUT SEMVER definition some more, added a normalization and
+        comparison script.
         Some rounds of code-hardening project.
+        Added reference RPM/DEB recipes to test NUT iterations on OBS.
         Numerous driver updates, some new ones introduced.
     </revremark>
   </revision>
 
   <revision>
-    <revnumber>2.8.5</revnumber>
-    <date>2026-01-29</date>
+    <revnumber>2.8.4</revnumber>
+    <date>2025-08-07</date>
     <authorinitials>JK</authorinitials>
     <revremark>
-        Some changes to docs and recipes, especially for parallel builds;
-        introduced a way to build with private shared libraries to save space.
-        Updated NUT SEMVER definition some more, added a normalization and
-        comparison script.
+        Fixed a few regressions introduced by release v2.8.3.
+        Some changes to docs and recipes, especially for parallel builds.
+        Updated NUT SEMVER definition some more.
         Some rounds of code-hardening project.
-        Added reference RPM/DEB recipes to test NUT iterations on OBS.
         Numerous driver updates, some new ones introduced.
     </revremark>
   </revision>

docs/download.txt

@@ -61,6 +61,11 @@ Stable tree: {tree_version}
 - link:https://www.networkupstools.org/source/{tree_version}/new-{revision}.txt[Release notes]
 - link:https://www.networkupstools.org/source/{tree_version}/ChangeLog[ChangeLog]
 
+For a set of pre-rendered documentation files (man pages for Linux/BSD
+common section layout, HTML and PDF) please see:
+
+- link:https://www.networkupstools.org/source/{tree_version}/nut-{revision}-docs.tar.gz[nut-{revision}-docs.tar.gz]
+
 You can also browse the link:https://www.networkupstools.org/source/{tree_version}/[stable source directory].
 
 Development tree:

docs/maintainer-guide.txt

@@ -290,9 +290,10 @@ VERSION_FORCED_SEMVER:NUT_VERSION_FORCED_SEMVER='2.8.3'
    documentation types)
 
 * post-release update of the "in-development" codebase:
-** start a feature branch to return the master branch into development state
+** start a feature branch to return the master branch into development state,
+   e.g. `git checkout master && git checkout -b post-release-2.8.0`
 ** update the fallback `NUT_DEFAULT_VERSION` in `tools/gitlog2version.sh` to
-   <incremented version>.1 (ex: `2.8.0.1`) and commit this, e.g.:
+   `<incremented version>.1` (ex: `2.8.0.1`) and commit this, e.g.:
 +
 ----
 :; git commit -sm 'tools/gitlog2version.sh: for development, set fallback NUT_VERSION_DEFAULT=2.8.0.1'
@@ -311,6 +312,8 @@ VERSION_FORCED_SEMVER:NUT_VERSION_FORCED_SEMVER='2.8.3'
 ** Ensure that `UPDATING.adoc` has a `Changes from ... to ...` section for
    the new couple of release numbers
 ** `git commit` if there were any changes after that `git revert`
+** Initiate a PR to `Post-release 2.8.0 rituals: begin next cycle` with this
+   branch, but do not merge it yet
 
 * Update `nut-website`:
 ** rendering should auto-update by NUT CI farm based on source changes,
@@ -324,9 +327,36 @@ VERSION_FORCED_SEMVER:NUT_VERSION_FORCED_SEMVER='2.8.3'
 ** in `source` submodule add a copy of tarball, checksum and hash files for
    download: `make dist{,-hash,-sig}` (or since NUT v2.8.3, `make dist-files`)
 *** for a `new-X.Y.Z.txt` file use the `NEWS.adoc` with a stripped title
-    and prominent `link:` asciidoc markup (see existing files)
+    and prominent `link:` asciidoc markup (see existing files), e.g. strip
+    `link:UPGRADING.adoc[]` markup => `UPGRADING.adoc`, or generally speaking:
++
+----
+:; sed -e 's,link:\([^ ]*\)\[\],`\1`,g' -i new-2.8.0.txt
+----
+*** Check that the `new-X.Y.Z.txt` file DOES NOT include the `PLANNED:...`
+    title and TODO list for the future release, if restored in the steps above
+*** Copy over the `ChangeLog` file (original variant, not `.adoc`) and fix the
+    commit range in title to end with the new release tag name (not `HEAD`)
 ** update `historic/index.txt` with an entry for the new release tag and date
-** `git tag` the website release
+** commit content changes in the `source`, `package` and `nut-website` repos:
++
+----
+:; git commit -sm 'NUT v2.8.0 released'
+----
+** add and commit sub-module references (pointing to their `master` branches
+   checked out and prepared for the release):
++
+----
+:; git add -p nut ddl source package \
+   && git commit -sm 'NUT v2.8.0 released - update submodule references'
+----
+** tag the website release (including repos above and `ddl`), e.g.:
++
+----
+:; git tag -asm 'NUT v2.8.0 released' v2.8.0 && git push origin v2.8.0
+
+# NOTE: Maybe `git push upstream v2.8.0` for nut-website directory itself
+----
 ** generate and publish a "historic" sub-site snapshot (currently manually,
    check comments in nut-website's `ci_build.sh` script and/or its README file)
 ** update `nut` submodule to current commit ("in-development" codebase), and
@@ -335,12 +365,14 @@ VERSION_FORCED_SEMVER:NUT_VERSION_FORCED_SEMVER='2.8.3'
 ** generate and publish the usual website revision (by CI or manually)
 ** Note that it may be needed to manually copy the new tarball-related files,
    `new-X.Y.Z.txt`, change log, and maintainer keys (if updated), into the
-   rendered website repository, even if using the CI scripted publication.
+   rendered website repository, even if using the CI scripted publication,
+   then `git commit` and `git push` these changes.
 
 * check that the website renders properly (a few minutes after publication)
 ** re-check the tarball signature according to current `security.txt` document
    on an empty VM/container/chroot/user-home setup, to make sure that the GPG
    instructions fit the reality (needed maintainer keys are published, etc.)
+** `git tag` the published website release
 
 * draft and publish a GitHub release based on the signed tag
 ** attach *the same copy of* the tarball, checksum and hash files as published
@@ -387,4 +419,7 @@ impacts-release-2.8.0
 Issues reported against NUT release 2.8.0 (maybe vanilla or with minor packaging tweaks)
 ----
 
+* Merge the PR to initiate the new release cycle (done last, as we probably
+  would update this document along the way a few times)
+
 //////////////////////////////////////////////////////////////////////////////

tools/gitlog2version.sh

@@ -157,7 +157,7 @@ if [ -z "${NUT_VERSION_DEFAULT-}" -a -s "${abs_top_srcdir}/VERSION_DEFAULT" ] ;
 fi
 
 # Fallback default, to be updated only during release cycle
-[ -n "${NUT_VERSION_DEFAULT-}" ] || NUT_VERSION_DEFAULT='2.8.5'
+[ -n "${NUT_VERSION_DEFAULT-}" ] || NUT_VERSION_DEFAULT='2.8.5.1'
 
 # Default website paths, extended for historic sub-sites for a release
 [ -n "${NUT_WEBSITE-}" ] || NUT_WEBSITE="https://www.networkupstools.org/"