Commit #143

madmurphy · May 11, 2020 · 6f6115d · 6f6115d
1 parent b2b5e30
commit 6f6115d
Show file tree

Hide file tree

Showing 31 changed files with 207 additions and 191 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -2,6 +2,13 @@ Change Log {#changelog}
 =======================
 
 
+## 1.14.1 -- 2020-05-11
+
+Changes:
+
+* Documentation
+
+
 ## 1.14.0 -- 2020-03-01
 
 Changes:

diff --git a/MANUAL.md b/MANUAL.md
@@ -35,12 +35,10 @@ location = Colosseum
 place = Rome
 
 [sender]
-
 name = John Smith
 email = john.smith@example.com
 
 [receiver]
-
 name = Mario Rossi   # He's a big guy
 email = mario.rossi@example.com
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/Makefile.am b/Makefile.am
@@ -56,7 +56,7 @@ endif WANT_DOC
 if WANT_EXAMPLES
 
 examplesdir = $(docdir)/examples
-dist_examples_DATA = \
+dist_examples_SCRIPTS = \
 	examples/run-example.sh
 
 examplesinifilesdir = $(examplesdir)/ini_files
@@ -120,10 +120,6 @@ _examples_insthook_ += \
 endif HAVE_TRANSFORMATIONS
 
 
-# Make examples script executable
-_examples_insthook_ += \
-	chmod +x '$(DESTDIR)$(examplesdir)/run-example.sh';
-
 endif WANT_EXAMPLES
 
 

diff --git a/README b/README
@@ -164,34 +164,43 @@ by running the `bootstrap` script. By default, `bootstrap` will also run the
 `./bootstrap --help`.
 
 If you are using **Microsoft Windows**, a batch script for compiling
-**libconfini** with [MinGW][7] without Bash is available (`mgwmake.bat`). If you
-are interested in using Autotools for compiling **libconfini** under Microsoft
-Windows, you can integrate MinGW with [MSYS][8], or you can directly use
-[MSYS2][9]. Alternatively, [an unofficial port][10] of **libconfini** for
-[Cygwin][11] is available.
+**libconfini** with [MinGW][7] without Bash is available (`mgwmake.bat`). If
+you are interested in using Autotools for compiling **libconfini** under
+Microsoft Windows, you can integrate MinGW with [MSYS][8], or you can directly
+use [MSYS2][9] and [its official port][10] of the library. Alternatively, [an
+unofficial port][11] of **libconfini** for [Cygwin][12] is available.
 
-For further information, see [INSTALL][12].
+For further information, see [INSTALL][13].
+
+
+Bindings
+--------
+
+[Danilo Spinella][14] maintains [a D binding package][15] of **libconfini**.
 
 
 Free software
 -------------
 
 This library is free software. You can redistribute it and/or modify it under
-the terms of the GPL license version 3 or any later version. See [COPYING][13]
+the terms of the GPL license version 3 or any later version. See [COPYING][16]
 for details.
 
 
-[1]: https://madmurphy.github.io/libconfini/html/baremetal.html
-[2]: https://madmurphy.github.io/libconfini/html/libconfini.html
-[3]: https://madmurphy.github.io/libconfini/manual.html
-[4]: https://github.com/
-[5]: https://github.com/madmurphy/libconfini
-[6]: https://repology.org/project/libconfini/versions
-[7]: http://www.mingw.org/
-[8]: http://www.mingw.org/wiki/MSYS
-[9]: https://www.msys2.org/
-[10]: https://github.com/fd00/yacp/tree/master/libconfini
-[11]: https://www.cygwin.com/
-[12]: https://github.com/madmurphy/libconfini/blob/master/INSTALL
-[13]: https://github.com/madmurphy/libconfini/blob/master/COPYING
+  [1]: https://madmurphy.github.io/libconfini/html/baremetal.html
+  [2]: https://madmurphy.github.io/libconfini/html/libconfini.html
+  [3]: https://madmurphy.github.io/libconfini/manual.html
+  [4]: https://github.com/
+  [5]: https://github.com/madmurphy/libconfini
+  [6]: https://repology.org/project/libconfini/versions
+  [7]: http://www.mingw.org/
+  [8]: http://www.mingw.org/wiki/MSYS
+  [9]: https://www.msys2.org/
+  [10]: https://packages.msys2.org/base/mingw-w64-libconfini
+  [11]: https://github.com/fd00/yacp/tree/master/libconfini
+  [12]: https://www.cygwin.com/
+  [13]: https://github.com/madmurphy/libconfini/blob/master/INSTALL
+  [14]: https://danyspin97.org/
+  [15]: https://github.com/DanySpin97/libconfini-d
+  [16]: https://github.com/madmurphy/libconfini/blob/master/COPYING
 
diff --git a/autostuff/chunks/revision-warning.c b/autostuff/chunks/revision-warning.c
@@ -5,10 +5,9 @@
     ever revised this content, although someone should have. If you are instead
     that human appointed to review this code before it is pasted to the public
     header, please remove this text.
-
     If a "standard" header providing these objects is available for your
-    platform, please replace the entire section below with the following single
-    line:
+    platform, please replace the entire section below with the following
+    content:
 
         #include <some_header.h>
 

diff --git a/autostuff/m4/not-autotools.m4 b/autostuff/m4/not-autotools.m4
@@ -17,8 +17,8 @@ dnl  **************************************************************************
 
 
 dnl  **************************************************************************
-dnl  NOTE:  This is only a selection of macros from the Not Autotools project
-dnl         without documentation. For the entire collection and the
+dnl  NOTE:  This is only a selection of macros from the **Not Autotools**
+dnl         project without documentation. For the entire collection and the
 dnl         documentation please refer to the project's website.
 dnl  **************************************************************************
 

diff --git a/autostuff/shadows/package.json.in b/autostuff/shadows/package.json.in
@@ -4,7 +4,7 @@
 	"description": "@PROJECT_DESCRIPTION@",
 	"homepage": "@PACKAGE_URL@",
 	"author": "@PACKAGE_BUGREPORT@",
-	"license": "@LICENSE_ID@",
+	"license": "@LICENSE_SPDX@",
 	"main": "@PACKAGE_CONFNAME@",
 	"repo": "@PUBLISHER_ID@/@PACKAGE_TARNAME@",
 	"repository": {

diff --git a/configure.ac b/configure.ac
@@ -26,7 +26,7 @@ AC_INIT([lib]n4_mem([GL_PROJECT_NAME], [confini]),
 	m4_joinall([.],
 		n4_mem([GL_PROJECT_MAJVER], [1]),
 		n4_mem([GL_PROJECT_MINVER], [14]),
-		n4_mem([GL_PROJECT_REVVER], [0])),
+		n4_mem([GL_PROJECT_REVVER], [1])),
 	[madmurphy333@gmail.com],
 	[lib]GL_PROJECT_NAME,
 	[https://madmurphy.github.io/libconfini])
@@ -38,7 +38,7 @@ NC_GLOBAL_LITERALS(
 	[PROJECT_DESCRIPTION],		[Yet another INI parser],
 	[LICENSE_STRING],			[GNU General Public License, version 3 or any
 								later version],
-	[LICENSE_ID],				[GPL-3.0-or-later],
+	[LICENSE_SPDX],				[GPL-3.0-or-later],
 	[PUBLISHER_NAME],			[Stefano Gioffré],
 	[PUBLISHER_ID],				[madmurphy],
 	[GIT_HTTP_SERVER],			[https://github.com]
@@ -141,7 +141,7 @@ AC_CONFIG_AUX_DIR([build-aux])
 ###  Add `--enable-extended-config[=MODE]` option
 NC_CONFIG_SHADOW_DIR([autostuff/shadows])
 
-AM_INIT_AUTOMAKE
+AM_INIT_AUTOMAKE([gnu])
 
 ###  Add `--enable-author-mode` option
 AC_ARG_ENABLE([author-mode],
@@ -225,7 +225,7 @@ AC_ARG_WITH([io_api],
 AS_VAR_SET([AC_CPPENV], ['$(OFFICIAL_CPPENV)'])
 
 AS_CASE(["${na_tmp_ioflavor}"],
-	[standard], [],
+	[standard], [:],
 	[posix], [
 		AS_IF([test "x${ac_cv_have_posix_c}" = xno], [
 			NC_MSG_WARNBOX([The POSIX I/O API is not supported on this platform
@@ -869,7 +869,7 @@ AS_MKDIR_P(['help'])
 
 ###  Create a `help/make-targets.txt` file to be printed by `make help`
 { cat << 'END_HEREDOC'
-GNU make utility to maintain AC_PACKAGE_NAME
+GNU make utility to maintain AC_PACKAGE_NAME AC_PACKAGE_VERSION
 
 Commonly used targets:
 
@@ -888,19 +888,19 @@ NA_HELP_STRINGS(
 		`make check` tests the compiled objects directly from the source
 		directory, `make installcheck` tests the compiled objects from the
 		installation paths (you can pass a `DESTDIR` variable in case of staged
-		installations), `make finishcheck` tests the compiled objects from
+		installations), and `make finishcheck` tests the compiled objects from
 		the installation paths without passing any information to the compiler
 		about the latter, in order to check that <includedir> and <libdir> are
 		automatically reachable (therefore no `DESTDIR` variable is supported
 		here); note that `make installcheck` and `make finishcheck` can be
-		launched only after `make install(*)` has been launched],
+		launched only after having launched `make install(*)`],
 	[[make mostlyclean], [make clean], [make distclean]],
 		[clean the source directory according to different degrees of fury],
 	[[make clobber]],
 		[launch `make uninstall` followed by `make clean`],
 	[[make alldone]],
 		[launch `make install-strip` followed by `make installcheck` - in case
-		of staged installations it is possible to pass a `DEST` variable (see
+		of staged installations it is possible to pass a `DESTDIR` variable (see
 		below)],
 	[[make binary-release], [make manifest]],
 		[create respectively a package and a manifest in the current location
@@ -956,7 +956,7 @@ NA_HELP_STRINGS(
 		script],
 	[[make approve-revision], [make reject-revision]],
 		[Approve/reject the current customization for a non-standard
-		environment (available only in specific cases))],
+		environment (available only in specific cases)],
 	[[make expired]],
 		[(Re)build all the targets listed in the `EXPIRE` user variable, as in
 		`make EXPIRE=']AC_PACKAGE_TARNAME[-git.tar.gz
@@ -977,9 +977,10 @@ NA_HELP_STRINGS(
 		the `DESTDIR` variable allows to change the final installation path,
 		independently of how the package has been configured; this variable can
 		contain absolute paths only and defaults to an empty string when
-		omitted; the `DESTDIR` variable is meant only for staged installations
-		and must never contain a real installation path - if you need to
-		customize the target directories, launch `./configure --help`],
+		omitted; the `DESTDIR` variable is meant to be used only in case of
+		staged installations and should never contain a real installation path
+		- if you need to customize the target directories, launch `./configure
+		--help`],
 	[[ZIPTYPE]],
 		[Supported by `make authors-copy`, `make binary-release`, `make
 		git-clone`, `make portable-builds` and `make source-release`, this

diff --git a/dev/hackings/all/confini-metadata.c b/dev/hackings/all/confini-metadata.c
@@ -4,7 +4,7 @@
 	@brief		libconfini functions
 	@author		Stefano Gioffr&eacute;
 	@copyright	GNU General Public License, version 3 or any later version
-	@version	1.14.0
+	@version	1.14.1
 	@date		2016-2020
 	@see		https://madmurphy.github.io/libconfini
 

diff --git a/dev/hackings/all/confini-metadata.h b/dev/hackings/all/confini-metadata.h
@@ -4,7 +4,7 @@
     @brief      libconfini header
     @author     Stefano Gioffr&eacute;
     @copyright  GNU General Public License, version 3 or any later version
-    @version    1.14.0
+    @version    1.14.1
     @date       2016-2020
     @see        https://madmurphy.github.io/libconfini
 

diff --git a/dev/hackings/baremetal/README.md b/dev/hackings/baremetal/README.md
@@ -18,15 +18,15 @@ and possibly even without any header at all.
 
 Starting from version 1.13.0 a “bare metal” version of **libconfini** has been
 made available by simply passing a `--without-io-api` option to the `configure`
-script. This modified version has the following characteristics:
+script. This modified version comes with the following characteristics:
 
 * No heap usage (no memory is every allocated or freed)
 * No I/O functions (it is possible to parse only disposable `char` buffers via
   `strip_ini_cache()`)
 * Everything else is inherited verbatim from the official version
 
 
-## The `--without-io-api` option
+## The `dev/hackings/baremetal/` subdirectory
 
 When the `configure` script is launched with the `--without-io-api` option (or,
 equivalently, with `--with-io-api=baremetal`), it assumes that no standard

diff --git a/dev/marked-sources/confini-marked.c b/dev/marked-sources/confini-marked.c
@@ -3,14 +3,14 @@
 
 /*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ !START_OMISSION! @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@-
 
-This is a marked **exact copy** of `src/confini.c`, where replaceable sections have
-been enclosed within special tags that can be parsed and amended by GNU Make to
-create custom forks of the library.
+This is a marked **exact copy** of `src/confini.c`, in which replaceable sections
+have been wrapped within special tags that can be parsed and amended by GNU Make
+during the build process in order to create custom forks of the library.
 
 If you want to contribute to the development of this project, please **use this
 file**, as `src/confini.c` is automatically generated from here.
 
-For more information about the tags used here, see the `NA_AMEND()` macro from
+For more information about the tags used here, please see the `NA_AMEND()` macro in
 `m4/not-autotools.m4` at https://github.com/madmurphy/not-autotools
 
 The code below is distributed under the terms of the GPL license version 3 or any
@@ -460,8 +460,9 @@ later version.
 
 /*
 
-	Maybe in the future there will be support for UTF-8 casefold (although probably
-	not -- see "Code considerations" in the Manual), but for now only ASCII...
+	Maybe in the future there will be support for UTF-8 case folding (although
+	probably not -- see "Code considerations" in the Manual), but for now only
+	ASCII...
 
 */
 #define _LIBCONFINI_CHR_CASEFOLD_(CHR) (CHR > 0x40 && CHR < 0x5b ? CHR | 0x60 : CHR)
@@ -4846,9 +4847,11 @@ void ini_global_set_lowercase_mode (const bool lowercase) {
 
 	@brief			Sets the value to be to be assigned to implicit keys
 	@param			implicit_value		The string to be used as implicit value
-										(usually `"YES"`, or `"TRUE"`)
-	@param			implicit_v_len		The length of @p implicit_value (usually
-										`0`, independently of its real length)
+										(usually `"YES"`, `"TRUE"`, or `"ON"`, or
+										any other string; it can be `NULL`)
+	@param			implicit_v_len		The length of @p implicit_value (without
+										counting the NUL terminator; use `0` for
+										both an empty string and `NULL`)
 	@return			Nothing
 
 	@warning	This function changes the value of one or more global variables. In

diff --git a/dev/marked-sources/confini-marked.h b/dev/marked-sources/confini-marked.h
@@ -2,15 +2,16 @@
 
 /*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ !START_OMISSION! @@@@@@@@@@@@@@@@@@@@@@@@@@@@@-
 
-This is a marked **exact copy** of `src/confini.h`, where replaceable sections
-have been enclosed within special tags that can be parsed and amended by GNU
-Make to create custom forks of the library.
+This is a marked **exact copy** of `src/confini.h`, in which replaceable
+sections have been wrapped within special tags that can be parsed and amended
+by GNU Make during the build process in order to create custom forks of the
+library.
 
 If you want to contribute to the development of this project, please **use this
 file**, as `src/confini.h` is automatically generated from here.
 
-For more information about the tags used here, see the `NA_AMEND()` macro from
-`m4/not-autotools.m4` at https://github.com/madmurphy/not-autotools
+For more information about the tags used here, please see the `NA_AMEND()`
+macro in `m4/not-autotools.m4` at https://github.com/madmurphy/not-autotools
 
 The code below is distributed under the terms of the GPL license version 3 or
 any later version.