Merge pull request #87 from westermo/prepare-release

Prepare v3.1 release

ChangeLog.md

@@ -4,18 +4,38 @@ Change Log
 All notable changes in libConfuse are documented in this file.
 
 
-[v3.1][UNRELEASED] - 2016-12-XX
--------------------------------
+[v3.1][] - 2017-05-24
+---------------------
 
 ### Changes
-* New API for creating titled sections at runtime, by Jonas Johansson
+* Refactored `CFGF_IGNORE_UNKNOWN` support, libConfuse now properly
+  ignores any type and sub-section without the need for declaring an
+  `__unknown` option.  When the flag is set all unknown options,
+  including unknown sub-sections with, in turn, unknown options, are
+  now fully ignored
+* Issue #69: New API for creating titled sections at runtime,
+  by Jonas Johansson @jonasj76
+* Issue #92: Support for option annotation/comments.  Every option can
+  now have a comment, which is both read and written from/to file.
+  Disabled by default, enable with `CFGF_COMMENTS` flag in `cfg_init()`
+* ABI bump: 1.0.0 --> 1.1.0, due to new functionality
 
 ### Fixes
-* Fix typos in documentation, by Luca Ceresoli
-* Fix gettext version requirement, CentOS/RHEL7 only has v0.18.12
-* Fix syntax in rpm spec file, for CentOS/RHEL7
-* SIGSEGV when parsed default values are used with include, by Dmitri Zhabinski
-* Fixed MSVC build errors, by George Koskeridis @Gikoskos
+* Build unit tests statically for easier debugging
+* Issue #21: Major refactor of lexer to fix memory leaks, `cfg_free()`
+  now properly releases all memory.  By Joachim Nilsson @troglobit
+* Issue #64: Fixed MSVC build errors, by George Koskeridis @Gikoskos
+* Issue #65: SIGSEGV when parsed default values are used with include,
+  by Dmitri Zhabinski
+* Issue #71: Fix syntax in rpm spec file, for CentOS/RHEL7
+* Issue #73: Adjust gettext version requirement to build on CentOS/RHEL7.
+  GNU gettext v0.18.2.1 update `AM_GNU_GETTEXT()` to use AC_PROG_MKDIR_P
+  instead of `AM_PROG_MKDIR_P`, but v0.18.1.1 is included in Ubuntu 12.04
+  LTS.  Fortunately Ubuntu 14.04 LTS ships v0.18.3.1 and Debian Jessie
+  ships v0.19.3.  Unfortunately, CentOS7 and RHEL7 ships v0.18.2.1, so
+  for best compat. level at this point in time we require v0.18.2.
+* Issue #74: Fix typos in documentation, by Luca Ceresoli
+* Issue #79: Add `fmemopen()` compat for *BSD, including macOS
 
 
 [v3.0][] - 2016-03-03
@@ -313,7 +333,7 @@ v1.2.2 - 2002-11-27
 * updated the manual
 
 
-[UNRELEASED]: https://github.com/martinh/libconfuse/compare/v3.0...HEAD
+[UNRELEASED]: https://github.com/martinh/libconfuse/compare/v3.1...HEAD
 [v3.1]: https://github.com/martinh/libconfuse/compare/v3.0...v3.1
 [v3.0]: https://github.com/martinh/libconfuse/compare/v2.8...v3.0
 [v2.8]: https://github.com/martinh/libconfuse/compare/v2.7...v2.8

HACKING.md

@@ -66,6 +66,23 @@ It must be updated according to the [GNU Libtool recommendations][1]:
 6. If any *interfaces have been removed or changed* since the last
    public release, then set age to 0.
 
+The libtool ABI versioning logic is very confusing but works if you just
+disable your brain and follow the rules, one by one.
+
+**Example #1:** a new function has been added, none of the existing ones
+have changed.  The initial version is 1:0:0, we follow the rules above to
+the letter: increase revision, increase current and set revision to zero,
+and finally increase age.  This, rather confusingly, gives us 2:0:1 which
+libtool then translates to `libconfuse.so.1.1.0`.
+
+**Example #2:** some existing functions are changed, they now return an
+`int` instead of `void`.  The initial version is 0:0:0, and we follow the
+rules again: increment revision, increment current and set revision to
+zero, set age to zero.  This gives us 1:0:0, which is then translated to
+ `libconfuse.so.1.0.0`.
+
+### Note
+
 Usually, non-developers have no interest in running development versions
 (releases are frequent enough), and developers are expected to know how
 to juggle versions.  In such an ideal world, it is good enough to bump

README.md

@@ -56,9 +56,9 @@ The source code is distributed in three files: Two tarballs in .tar.gz
 and .tar.xz formats with source code and Makefiles for UNIX systems, and
 a .zip file with Windows build files.
 
-* confuse-3.0:
-  [UNIX tar.gz](https://github.com/martinh/libconfuse/releases/download/v3.0/confuse-3.0.tar.gz),
-  [Windows ZIP](https://github.com/martinh/libconfuse/releases/download/v3.0/confuse-3.0.zip)
+* confuse-3.1:
+  [UNIX tar.gz](https://github.com/martinh/libconfuse/releases/download/v3.1/confuse-3.1.tar.gz),
+  [Windows ZIP](https://github.com/martinh/libconfuse/releases/download/v3.1/confuse-3.1.zip)
 * [New releases](https://github.com/martinh/libconfuse/releases)
 * [Old releases](http://savannah.nongnu.org/download/confuse/)
 
@@ -89,6 +89,7 @@ with the source:
 News
 ----
 
+* 2017-05-24: libConfuse version 3.1 released
 * 2016-03-03: libConfuse version 3.0 released
 * 2015-10-14: libConfuse version 2.8 released
 * 2015-10-12: New patch monkey at the helm of GitHub.

configure.ac

@@ -2,7 +2,7 @@ dnl Process this file with -*- autoconf -*- to produce a configure script.
 
 AC_PREREQ(2.50)
 
-AC_INIT(libConfuse, 3.1-beta1, https://github.com/martinh/libconfuse/issues, confuse)
+AC_INIT(libConfuse, 3.1, https://github.com/martinh/libconfuse/issues, confuse)
 AC_CONFIG_AUX_DIR(support)
 AM_MAINTAINER_MODE
 AM_INIT_AUTOMAKE([foreign dist-xz])

m4/Makefile.am

@@ -1,8 +1,6 @@
-EXTRA_DIST = intdiv0.m4 inttypes_h.m4 inttypes-pri.m4 nls.m4 \
-             po.m4 stdint_h.m4 uintmax_t.m4 intmax.m4 ulonglong.m4 codeset.m4 \
-             gettext.m4 glibc21.m4 iconv.m4 lcmessage.m4 \
-             lib-ld.m4 lib-link.m4 lib-prefix.m4 progtest.m4 \
-             longdouble.m4 longlong.m4 \
-             printf-posix.m4 size_max.m4 wchar_t.m4 wint_t.m4 \
-             xsize.m4
+EXTRA_DIST = intdiv0.m4 inttypes_h.m4 inttypes-pri.m4 nls.m4 po.m4	\
+             stdint_h.m4 uintmax_t.m4 intmax.m4 codeset.m4 gettext.m4	\
+             glibc21.m4 iconv.m4 lcmessage.m4 lib-ld.m4 lib-link.m4	\
+             lib-prefix.m4 progtest.m4 longlong.m4 printf-posix.m4	\
+             size_max.m4 wchar_t.m4 wint_t.m4 xsize.m4
 

po/de.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: confuse 2.6-2\n"
 "Report-Msgid-Bugs-To: https://github.com/martinh/libconfuse/issues\n"
-"POT-Creation-Date: 2016-03-03 01:12+0100\n"
+"POT-Creation-Date: 2017-05-24 13:55+0200\n"
 "PO-Revision-Date: 2010-02-22 02:06-0500\n"
 "Last-Translator: Chris Leick <c.leick@vollbio.de>\n"
 "Language-Team: German <debian-l10n-german@lists.debian.org>\n"
@@ -17,123 +17,134 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-#: src/confuse.c:197 src/confuse.c:218
+#: src/confuse.c:194 src/confuse.c:215 src/confuse.c:2049
 #, c-format
 msgid "no such option '%s'"
 msgstr "keine solche Option »%s«"
 
-#: src/confuse.c:552
+#: src/confuse.c:555
 #, c-format
 msgid "duplicate option '%s' not allowed"
 msgstr ""
 
-#: src/confuse.c:703
+#: src/confuse.c:722
 #, c-format
 msgid "found duplicate title '%s'"
 msgstr "doppelter Titel »%s« gefunden"
 
-#: src/confuse.c:729
+#: src/confuse.c:749
 #, c-format
 msgid "invalid integer value for option '%s'"
 msgstr "ungültiger Ganzzahlwert für Option »%s«"
 
-#: src/confuse.c:733
+#: src/confuse.c:753
 #, c-format
 msgid "integer value for option '%s' is out of range"
 msgstr "Ganzzahlwert für Option »%s« ist außerhalb des Abschnitts"
 
-#: src/confuse.c:751
+#: src/confuse.c:771
 #, c-format
 msgid "invalid floating point value for option '%s'"
 msgstr "ungültiger Fließkommawert für Option »%s«"
 
-#: src/confuse.c:755
+#: src/confuse.c:775
 #, c-format
 msgid "floating point value for option '%s' is out of range"
 msgstr "Fließkommawert für Option »%s« ist außerhalb des Abschnitts"
 
-#: src/confuse.c:837
+#: src/confuse.c:858
 #, c-format
 msgid "invalid boolean value for option '%s'"
 msgstr "ungültiger Boolean-Wert für Option »%s«"
 
-#: src/confuse.c:1015
+#: src/confuse.c:1035
 #, c-format
 msgid "dropping deprecated configuration option '%s'"
 msgstr ""
 
-#: src/confuse.c:1018
+#: src/confuse.c:1038
 #, c-format
 msgid "found deprecated option '%s', please update configuration file."
 msgstr ""
 
-#: src/confuse.c:1047
+#: src/confuse.c:1069
 msgid "premature end of file"
 msgstr "vorzeitiges Ende der Datei"
 
 # http://www.dict.cc/deutsch-englisch/Klammer.html
-#: src/confuse.c:1064
+#: src/confuse.c:1090
 msgid "unexpected closing brace"
 msgstr "unerwartete schließende eckige Klammer"
 
-#: src/confuse.c:1070 src/confuse.c:1130 src/confuse.c:1148 src/confuse.c:1170
+#: src/confuse.c:1111 src/confuse.c:1179 src/confuse.c:1204 src/confuse.c:1227
+#: src/confuse.c:1342 src/confuse.c:1386
 #, c-format
 msgid "unexpected token '%s'"
 msgstr "unerwartetes Element »%s«"
 
-#: src/confuse.c:1096
+#: src/confuse.c:1143
 #, c-format
 msgid "attempt to append to non-list option '%s'"
 msgstr "Versuch, an die Nicht-Listen-Option »%s« anzuhängen"
 
-#: src/confuse.c:1109
+#: src/confuse.c:1156
 #, c-format
 msgid "missing equal sign after option '%s'"
 msgstr "fehlendes Gleichheitszeichen nach Option »%s«"
 
-#: src/confuse.c:1177
+#: src/confuse.c:1234
 #, c-format
 msgid "missing opening brace for section '%s'"
 msgstr "öffnende geschweifte Klammer für Abschnitt »%s« fehlt"
 
-#: src/confuse.c:1202
+#: src/confuse.c:1261
 #, c-format
 msgid "missing title for section '%s'"
 msgstr "fehlender Titel für Abschnitt »%s«"
 
-#: src/confuse.c:1214
+#: src/confuse.c:1273
 #, c-format
 msgid "missing parenthesis for function '%s'"
 msgstr "runde Klammer für Funktion »%s« fehlt"
 
-#: src/confuse.c:1238 src/confuse.c:1253
+#: src/confuse.c:1295 src/confuse.c:1308
 #, c-format
 msgid "syntax error in call of function '%s'"
 msgstr "Syntaxfehler im Aufruf der Funktion »%s«"
 
-#: src/confuse.c:1259
+#: src/confuse.c:1402
 #, c-format
 msgid "Internal error in cfg_parse_internal(), unknown state %d"
 msgstr ""
 
-#: src/confuse.c:1596
+#: src/confuse.c:1766
 msgid "wrong number of arguments to cfg_include()"
 msgstr "falsche Anzahl von Argumenten für cfg_include()"
 
-#: src/lexer.l:151
+#: src/lexer.l:166
 #, c-format
 msgid "invalid octal number '%s'"
 msgstr "ungültige Oktalzahl »%s«"
 
-#: src/lexer.l:157
+#: src/lexer.l:172
 #, c-format
 msgid "bad escape sequence '%s'"
 msgstr "falsche Escape-Sequenz »%s«"
 
-#: src/lexer.l:229
+#: src/lexer.l:244
 msgid "unterminated string constant"
 msgstr "nicht beendete Zeichenkettenkonstante"
 
-#: src/lexer.l:297
+#: src/lexer.l:315
 msgid "includes nested too deeply"
 msgstr "Zu tiefe Verschachtelung von includes"
+
+#: src/lexer.l:327
+#, c-format
+msgid "%s: Not found in search path"
+msgstr ""
+
+#: src/lexer.l:336
+#, c-format
+msgid "%s: Failed tilde expand"
+msgstr ""