From 1eae9d802cc06ed815d21f76232c5f02babbead2 Mon Sep 17 00:00:00 2001
From: Patrick McDermott <patrick.mcdermott@libiquity.com>
Date: Sat, 16 Mar 2019 23:20:58 -0400
Subject: NEWS: Massively update and reorganize

---
(limited to 'NEWS')

diff --git a/NEWS b/NEWS
index 36ca39f..29257bb 100644
--- a/NEWS
+++ b/NEWS
@@ -3,17 +3,55 @@ opkbuild version 4.0.0-dev
 
 Released: ????-??-??
 
-Changes in this release:
+Build system:
 
   * The build system is now generated by GNU Autoconf and Automake.
   * libopkbuild is now distributed as a sort of shared library object,
     "linked" by the shld linker tool.  By default, it is installed into
     "/usr/local/share/sh/".
-  * ob_use() has been removed from the libopkbuild API.
-  * libopkbuild's "shared object version" has been bumped to 2 to
-    reflect the new incompatible API.
   * The test suite now uses the Test Anything Protocol and Automake's
     TAP driver.
+  * The mksysconf tool (used to generate "proteanos_arch" and
+    "proteanos_plat" system configuration files for testing opkbuild)
+    has been removed.
+
+Utilities:
+
+  * ob-unpacksource now supports decompression of xz-compressed upstream
+    archives.
+  * Manual pages for all utilities have been updated/written and are now
+    built and installed for the first time since opkhelper 1.0.0.
+  * Utilities can now be run in-place without installation by setting
+    libopkbuild's OB_LIB_BUILDDIR and OB_EXE_BUILDDIR environment
+    variables to the "locale" directory in the build directory.
+
+libopkbuild:
+
+  * libopkbuild's "shared object version" has been bumped to 2 to
+    reflect a new incompatible API.
+  * libopkbuild now aborts the program, instead of just returning 125
+    if any function is called with missing arguments.
+  * The following functions have been removed from the libopkbuild API:
+    - ob_match_arch() -- use ob_arch_is_concerned() instead
+    - ob_match_plat() -- use ob_plat_is_concerned() instead
+    - ob_parse_package_metadata() -- merged into ob_init_package()
+    - ob_set_locale_path() -- set OB_LIB_BUILDDIR and/or OB_EXE_BUILDDIR
+      environment variables to load localized messages from a build
+      directory
+    - ob_summarize_package_arch() -- was an unimplemented stub
+    - ob_summarize_package_plat() -- was an unimplemented stub
+    - ob_use() -- libopkbuild modules are now "linked" together into one
+      library file, so this function is no longer needed
+  * ob_parse_changelog() and ob_parse_control() now pass arguments to
+    user callbacks instead of setting global variables.
+  * Option letters have changed for ob_parse_dep(), ob_reduce_deps(),
+    and ob_get_binary_packages().
+  * All libopkbuild functions are now documented in manual pages
+    generated from inline comments.
+  * Test suite coverage has improved slightly.
+
+Bug fixes and minor changes:
+
   * A bug in the option parsing of ob_parse_dep(), ob_reduce_deps(),
     ob_parse_version(), ob_parse_package_metadata(), and
     ob_get_binary_packages() that affects GNU Bash and possibly other
@@ -22,6 +60,21 @@ Changes in this release:
     makefile's "build" target has been fixed.
   * ob_set_substvar()'s return value on success has been fixed.
   * ob-gencontrol now drops trailing commas and spaces in dependencies.
+  * ob-installdocs now correctly handles "docs" file lines with
+    destinations omitted.
+  * Underscores are no longer allowed in substitution variable names, in
+    stricter compliance with SPF 2.0.
+  * Code quality has been improved: eval commands are now safer against
+    mistakes in input validation/escaping, echo commands have been
+    replaced with printf and here-documents, errors are handled (making
+    the shell "-e" option safe), no undefined variables are expanded
+    (making the shell "-u" option safe), obselescent [ (test) command
+    options have been replaced, commands are protected from variable
+    arguments beginning with "-", and printf commands are protected
+    against variable format strings that might contain "%".
+
+Legal:
+
   * The minimum version of the GNU General Public License has been
     bumped to version 3.
 
--
cgit v0.9.1