Debian Codegraph @

CHANGES

raw
1 <!--
2 SPDX-FileCopyrightText: Peter Pentchev <[email protected]>
3 SPDX-License-Identifier: BSD-2-Clause
4 -->
5
6 # Change log for confget, the configuration file variable extractor
7
8 ## [Unreleased]
9
10 ## [5.1.2] - 2023-08-26
11
12 ### Fixes
13
14 - Python implementation:
15 - various minor fixes suggested by Ruff
16 - minor fixes related to the wider use of `pathlib.Path` now
17 - Test suite:
18 - do not even try to run the character-encoding-related tests in
19 15-bespoke-encoding with no locale specified in the `LC_ALL`
20 environmentt variable; it is possible that the default locale
21 (e.g. the "POSIX"/"C" one) does not contain any mapping for
22 the byte codes used to represent the "enye" UTF-8 character
23
24 ### Additions
25
26 - Python implementation:
27 - test-docker: add a framework for running the Python test suite
28 within a Docker container so that it can be tested with
29 old Python versions, e.g. Python 3.6 on CentOS 7
30
31 ### Other changes
32
33 - Reformat the copyright notices and license grants:
34 - replace the copyright notices and license grants with SPDX tags
35 - drop the copyright years in the copyright tags
36 - add my e-mail address to the copyright tags
37 - relicense the public-domain files under the CC0 license
38 - Python implementation:
39 - switch from `setuptools` to `hatchling` for the PEP 517 build
40 - let the Black formatter know which versions of Python we target
41 - add a `reuse` test environment to validate the SPDX tags and
42 list some build and test artifacts in the `.gitignore` file
43 - switch from `ddt` to `pytest.mark.parametrize` for the unit tests
44 - use the `tox-stages` tool in the `tox-devel.sh` helper
45 - use Ruff's `isort` implementation and rename the `black` and
46 `black-reformat` test environments to `format` and `reformat`
47 - use Ruff instead of Flake8 and Pylint
48 - test with MyPy 1.x with no changes
49 - drop an outdated piece of diagnostic code and two empty comment lines
50 - convert the `tox.ini` file to the Tox 4.x format
51 - Rust implementation:
52 - bump the versions of some crates we depend on; no functional changes
53 - let clippy know that it is okay to use the `ref` keyword,
54 the question mark operator, and a semicolon outside of a block
55 - add a note to the `run-clippy.sh` tool that the enabled/disabled
56 checks are synced with the clippy version in Rust 1.71
57
58 ## [5.1.1] - 2023-04-18
59
60 ### Fixes
61
62 - Changelog:
63 - fix the indentation
64 - Python implementation:
65 - add a dependency on the `dataclasses` library for Python 3.6
66 - Nix tests:
67 - add a dependency on the Python `pyparsing` library
68
69 ### Other changes
70
71 - Changelog:
72 - add repository links to the version entry headings
73 - change the date format in the entry headings from YYYY/MM/DD to
74 YYYY-MM-DD
75 - Rust implementation:
76 - update the versions of some dependencies with no changes
77
78 ## [5.1.0] - 2023-02-14
79
80 - add some tests with mostly empty INI-style files
81 - Python implementation:
82 - fix parsing an INI-style file containing variables but no section
83 headers using the default pyparsing-based implemenation
84 - add the `confget.defs.BackendType` enum listing the supported backends
85 (including the `INI` one that is internally handled as the default
86 INI-style backend, currently the pyparsing-based one)
87 - use black 23.x, flake8 6.x, pylint 2.16.x
88 - drop the mention of the long-gone pylintrc file from the manifest
89 - add Tox environment tags for use by the `tox-stages` tool
90 - activate most of the plugins that come with pylint 2.16.x, fix some
91 minor issues reported by them
92 - Rust implementation:
93 - use named arguments to `format!(..)`, `println!(...)`, etc.
94 - bump the required versions of `regex` and `tempfile` for some bugfixes
95 - minor clean-up changes, mostly following clippy's suggestions
96 - catch up with the clap crate's error message for options used more than
97 once that changed yet again
98
99 ## [5.0.1] - 2022-11-28
100
101 - Python implementation:
102 - do not build a universal wheel, we do not support Python 2.x any more
103
104 ## [5.0.0] - 2022-11-28
105
106 - INCOMPATIBLE CHANGES:
107 - C implementation
108 - fix variable name and value matching in UTF-8 locales
109 - Python implementation:
110 - drop Python 2.x support
111 - change the way line continuations are handled in INI files:
112 preserve trailing whitespace on all but the last line,
113 preserve leading whitespace on all lines
114 - do not assume INI-style input files are always encoded in UTF-8;
115 use the character encoding of the current locale's
116 `LC_CTYPE` setting
117 - Rust implementation:
118 - all the functions now return a `ConfgetError` enum instead of
119 `Box<dyn Error>`; that enum is implemented using the thiserror
120 and anyhow libraries
121 - make sure that a filename to read from is specified in
122 the configuration at backend construction time, not when
123 the file is read
124 - change the way line continuations are handled in INI files:
125 preserve trailing whitespace on all but the last line,
126 preserve leading whitespace on all lines
127 - make the list of features (in the feature-check sense, not in
128 the crate features sense) available using a new `features()`
129 function instead of jumping through hoops to dynamically build
130 a static array
131 - drop the deprecated `Config::get_default()` function
132 - do not assume INI-style input files are always encoded in UTF-8;
133 use the character encoding of the current locale's
134 `LC_CTYPE` setting
135 - Python implementation:
136 - add the ini-pyp backend that uses the pyparsing library and
137 use it by default; rename the one used until now to ini-regex
138 - drop the six dependency now that we no longer support Python 2.x
139 - make use of Python 3.x features:
140 - no need to inherit from the object class
141 - use `super()` without arguments
142 - use f-strings and type annotations
143 - use dataclasses instead of reimplementing them
144 - use `shlex.quote()` instead of reimplementing it
145 - use dict comprehensions
146 - use `@property @abstractmethod` instead of `@abstractproperty`
147 - drop the `print_function` future import
148 - use the class syntax for typed named tuples
149 - use `open()` instead of `io.open()`
150 - switch to a declarative setuptools config and a PEP517 build
151 - test suite: bump the minimal mypy version to 0.981 for the abstract
152 dataclasses bugfix
153 - Rust implementation:
154 - add the ini-nom backend and use it by default; rename the one used
155 until now to ini-regex and add crate features for both
156 - use anyhow instead of expect-exit in the command-line tool, too
157 - define the SectionData and FileData types for more readable
158 function signatures
159 - validate the command-line argument combinations in
160 an easier-to-read manner
161 - explicitly override clippy's std-instead-of-alloc and
162 std-instead-of-core lints, there is very little chance that
163 confget will ever be built in a no-std configuration
164 - minor changes suggested by clippy
165 - drop the unused percent-encoding dependency, it has not been
166 necessary since the `http_get` backend was dropped in version 3.0.0
167 - use the shell-words library instead of reimplementing it
168 - add a trivial test suite using copies of the `t*.ini` files
169 - use clap 4.x instead of 3.x
170 - Test suite:
171 - be more permissive in the shell quoting tests, since the Python and
172 Rust implementations now use different libraries that produce
173 different strings, but still as safe as before
174 - fix the TAP output for failing tests in the 10-bespoke-qsections set
175 - refactor the 10-bespoke-qsections set for better maintainability
176 - add the 15-bespoke-encoding test to make sure that the command-line
177 `confget` tool parses INI-style files using the character encoding
178 specified by the current locale's `LC_CTYPE` setting
179 - add Nix expressions for testing the Python and C implementations
180
181 ## [4.1.1] - 2022-09-11
182
183 - add an EditorConfig definitions file
184 - Python implementation:
185 - add lower and upper version constraints to the dependencies
186 specified in the tox.ini test environment definitions
187 - use black 22 for source code formatting
188 - reformat the source code with 100 characters per line
189 - specify a pylint minimum version 2.14 and stop overriding
190 two diagnostic messages that were declared obsolete or
191 made optional
192 - drop the flake8 + hacking test environment altogether
193 - move the pylint configuration to the pyproject.toml file
194 - include the `tox-devel.sh` file in the sdist tarball
195 - declare Python 3.8 through 3.11 as supported
196 - Rust implementation:
197 - heavily refactor following Rust idiomatic style and
198 the clippy tool's suggestions
199 - use the `Termination` trait that requires Rust 1.61
200 - fix the formatting of the copyright/license notice
201 - add the `run-clippy.sh` tool for elaborate diagnostics
202 - obtain the crate's version from the Cargo environment
203 - use expect-exit 0.5.x and its `bool.or_exit()` functions
204 - use expect-exit instead of `ConfgetError` in most places
205 - keep the `Cargo.lock` file under version control
206
207 ## [4.1.0] - 2021-11-28
208
209 - declare the `REGEX` and the `REGEX_IMPL_<language>_<library>`
210 features and check for `REGEX` in the TAP test
211 - C implementation:
212 - add support for the pcre2 library and make it the default
213 - Python implementation:
214 - tests: add a version to the dependency on the "hacking" library
215 to help out recent versions of pip with the combinatorial
216 explosion
217 - Rust implementation:
218 - declare compatibility with the 2021 edition with no changes
219
220 ## [4.0.1] - 2021-10-01
221
222 - Python implementation:
223 - fix the unit tests on Python 3.5: open the test files in
224 text mode, not in binary mode
225 - add `MANIFEST.in` to include more files in the sdist archive
226
227 ## [4.0.0] - 2021-09-29
228
229 - INCOMPATIBLE CHANGE:
230 - C implementation: when showing more than one variable, order them
231 by variable name instead of whatever order they appeared in
232 the input file. This brings the C implementation in line with
233 the Python and Rust ones.
234 - Python implementation:
235 - do not use `open()` without an encoding specified: either open
236 the files in binary mode or use `io.open()` and specify it
237 - cap the version of the Python 2.x configparser dependency
238 - fix a test class constructor name
239 - silence a pylint diagnostic message about f-strings; we still
240 have to support Python 2.x for a while longer
241 - silence a pylint diagnostic message about `abstractproperty`
242 being deprecated for the same reason
243 - Rust implementation:
244 - turn `html_root_url` into a crate-level attribute
245 - drop some unneeded borrows
246
247 ## [3.0.2] - 2021-06-23
248
249 - Python implementation
250 - tox tests: catch up with the mypy dependency changes
251 - Rust implementation:
252 - implement the `Default` trait for the `Config` object;
253 the `get_default()` method is now deprecated
254 - use version 0.4 of the expect-exit crate
255 - fix the code examples in the documentation
256 - add the `html_root_url` documentation attribute
257 - add a link to the change log on GitLab
258
259 ## [3.0.1] - 2021-05-12
260
261 - Rust implementation:
262 - implement some suggestions from the clippy tool
263 - add some Cargo.toml/crates.io metadata
264
265 ## [3.0.0] - 2021-05-11
266
267 - INCOMPATIBLE CHANGES:
268 - the `http_get` backend has been dropped, `ini` is currently
269 the only confget backend
270 - add a test querying a single variable in list-all mode
271 - Python implementation:
272 - the INI file is opened when `read_file()` is invoked, not
273 when the backend object is constructed
274 - rename the "black\_reformat" tox environment to "black-reformat"
275 - explicitly specify black version 21
276 - disable some more pylint diagnostics, since we still need to
277 preserve Python 2.x compatibility
278 - improve the `tox-devel.sh` experience a bit
279 - add "six" as a dependency to the "pylint" tox environment,
280 since pylint itself no longer depends on it
281 - add the `read_ini_file()` convenience function
282 - use the `read_ini_file()` function in the command-line tool,
283 since right now there are no other backends
284 - add a Rust implementation
285
286
287 ## [2.3.4] - 2020-05-02
288
289 - add a test for values containing a "=" character
290 - add a test for the "-P suffix" command-line option
291 - Python implementation:
292 - fix a bug parsing values containing a "=" character
293 - implement the "-P suffix" command-line option
294 - setup.py: use `tests_require` instead of `test_requires`
295 - push the source down into a `src/` subdirectory
296
297 ## [2.3.3] - 2020-04-07
298
299 - Python implementation: allow the tests to be run from
300 another directory, e.g. the confget top-level source one
301 - Makefile: if `NO_DOC_BUILD` is set, do not build the manual
302 page and do not install it and the examples
303
304 ## [2.3.2] - 2020-04-06
305
306 - Python implementation improvements and bugfixes:
307 - reformat the function and module docstrings
308 - make some imports conditional on the Python version
309 - separate the tests into developer-only (to be run within
310 the full confget source tree) and sdist-ready
311 - make it possible to run some tests from the sdist
312 - fix some test infrastructure nits
313
314 ## [2.3.1] - 2020-04-01
315
316 - fix the Python's top-level module typed exports
317 - fix two pylint false positives in the Python module
318
319 ## [2.3.0] - 2019-09-09
320
321 - fix a typographical error in the previous changelog entry
322 - also exclude the PyPy implementation from the check for
323 too many long options in the `14-bespoke-too-many` test
324 - Python implementation:
325 - reformat the source code using the black tool
326 - handle input encodings correctly for the standard input
327 - add the `get_parser()` method to return a `ConfigParser` object
328 - make the unit tests less verbose
329 - move the configuration for the black, flake8, and pylint
330 tools out of tox.ini into other configuration files
331 - C implementation:
332 - show the correct version number in the "-q features" output
333
334 ## [2.2.0] - 2019-01-13
335
336 - add a Python implementation: a confget library that may
337 also be invoked from the command line with the same
338 interface as the C confget tool
339 - generate the TAP tests automatically from JSON definitions
340
341 ## [2.1.1] - 2018-11-27
342
343 - fix the check for more than one requested query type
344
345 ## [2.1.0] - 2017-11-11
346
347 - allow the installation commands to be overridden, e.g. for
348 package builds which do not require root privileges
349 - add "-q features" and "-q feature NAME" with only the "BASE"
350 feature defined so far
351 - support "--help" and "--version"
352
353 ## [2.0.0] - 2016-04-03
354
355 - INCOMPATIBLE CHANGES:
356 - if a variable is specified more than once in the config file,
357 only the *last* value will be displayed regardless of the presence or
358 the order of the confget command-line options; previously,
359 confget without "-l" would only display the first value
360 - the configuration file is always parsed completely and any syntax
361 errors will cause confget to fail even if they occur after
362 the specification of the requested variables
363 - confget now requires a C99 compiler to build. This is activated
364 by the "-std=c99" option passed to the compiler; to override this,
365 Set the `STD_CFLAGS` environment variable
366 - Other changes:
367 - replace `_BSD_SOURCE` and `_GNU_SOURCE` with `_POSIX_C_SOURCE` and
368 `_XOPEN_SOURCE`
369 - install the test scripts themselves in addition to the test
370 config files as examples
371 - teach the manual page test about compressed manpage files
372 - use linker flags for Large File Support, too, if provided
373 - treat an empty section name (`-s ''`) as requesting only variables
374 declared before any section has been defined
375 - remove an outdated -f option specification in the HTTP GET
376 example in the manual page
377 - clean up some of the use of the `strcmp(3)` function
378 - clean up some internal error handling
379 - remove the obsolete `$Ringlet` VCS tags from the source files
380 - minimize the scope of some variables by using C99 declarations
381 - add the -O (override) command-line option allowing variables in
382 a certain section to override those in the unnamed section at
383 the start of the config file
384
385 ## [1.05] - 2013-11-03
386
387 - display the version string before the help if both requested
388 - support building without a `.depend` file
389 - use the C99 `%z` `printf(3)` format specifier and remove
390 the less portable `long long` casts
391 - add `const` qualifiers to lots of pointers
392 - make `makedep.sh` honor `CC` and quote some expansions there
393 - build with large file support under Linux by defining
394 `_FILE_OFFSET_BITS` to be 64
395
396 ## [1.04] - 2012-10-11
397
398 - detect automatically the "read-a-line" C library function
399 (`getline(3)` or `fgetln(3)`) by trying to compile and link simple
400 programs using either one
401 - separate the C preprocessor flags from the C compiler flags:
402 - honor `CPPFLAGS` if passed by a build system
403 - rename the `PCRE_CFLAGS` variable to `PCRE_CPPFLAGS`, since that
404 is what it actually is
405 - pass `CPPFLAGS` instead of `CFLAGS` to `makedep.sh` and use them
406 - stop misusing `LFLAGS`, use just `LDFLAGS` as we should
407 - add the "-q sections" command-line option to list the names of
408 the sections in an INI file
409 - add the `10-qsections` test for the above
410
411 ## [1.03] - 2011-07-06
412
413 - support spaces in INI file section names, as suggested by
414 [green](mailto:[email protected]) in
415 [Debian bug #632400](https://bugs.debian.org/632400)
416 - do not make the compiler warnings fatal by default
417
418 ## [1.02] - 2009-03-20
419
420 - do not fail the regexp tests if confget was compiled without
421 regular expression support
422 - explain the `Config::IniFiles` cross-reference in the manual
423 page, as discussed with George Danchev on the debian-mentors
424 mailing list
425 - split the install target into separate targets for the various
426 components of the program
427 - add some comments to the `t/t1.ini` and `t/t2.ini` files, describing
428 the structure of the INI files parsed by confget
429 - install the `t1.ini` and `t2.ini` files as examples, as discussed
430 with George Danchev on the debian-mentors mailing list
431
432 ## [1.01] - 2008-11-06
433
434 - if '-' is specified for the configuration file name, read from
435 the standard input stream
436 - improve the general description of confget in the manual page
437 - add an `http_get` backend for decoding HTTP GET request variables
438 - make the filename argument non-mandatory, since there are
439 configuration types (e.g. `http_get`) that do not read their data
440 from a file
441 - completely drop the non-functional stub for a Java properties
442 backend type
443
444 ## [1.00] - 2008-10-16
445
446 - add the '-p prefix' and '-P postfix' command-line options
447 - add the '-S' command-line flag so shell scripts may safely
448 read individual variables or slurp the contents of whole sections
449 - add regular expression support through the PCRE library and
450 the '-x' command-line flag
451
452 ## [0.03] - 2008-10-14
453
454 - avoid overlong strings in confget.c's `usage()` function
455 - add sample high-warning-level compiler flags to the Makefile
456 - protect argument names in the function declarations
457 - do not use a generic name such as "fp" for a global variable
458 - clear out the config file variable after closing the file
459 - pull in the correct definition for `strdup()`
460
461 ## [0.02] - 2008-10-14
462
463 - by default, use the binary files' group for the manpages, too
464 - add support for different configuration file types
465 - ini - the already-supported INI file backend
466 - add the '-t type' and '-T' command-line options
467 - add a trivial `README` file
468 - add a simple `TODO` list
469 - automatically track source dependencies
470 - use `fgetln(3)` or `getline(3)` to read lines from a file
471 - move more variable matching logic into `foundvar()`
472 - fix a bug when parsing key/value lines without whitespace
473 - add the -L command-line option to display all variables with
474 names matching the specified pattern
475 - mark some `Makefile` targets as phony
476 - allow more than one variable or pattern to be specified on
477 the command line
478 - note that either `-DHAVE_GETLINE` or `-DHAVE_FGETLN` must be defined
479 in the C compiler's flags at build time
480 - make the section argument optional and let the first section in
481 the INI file be used instead
482 - add the -m command-line option to match the values against a pattern
483
484 ## [0.01] - 2008-09-25
485
486 - Initial public release.
487
488 Comments: Peter Pentchev <[email protected]>
489
490 [Unreleased]: https://gitlab.com/confget/confget/-/compare/release%2F5.1.2...master
491 [5.1.2]: https://gitlab.com/confget/confget/-/compare/release%2F5.1.1...release%2F5.1.2
492 [5.1.1]: https://gitlab.com/confget/confget/-/compare/release%2F5.1.0...release%2F5.1.1
493 [5.1.0]: https://gitlab.com/confget/confget/-/compare/release%2F5.0.1...release%2F5.1.0
494 [5.0.1]: https://gitlab.com/confget/confget/-/compare/release%2F5.0.0...release%2F5.0.1
495 [5.0.0]: https://gitlab.com/confget/confget/-/compare/release%2F4.1.1...release%2F5.0.0
496 [4.1.1]: https://gitlab.com/confget/confget/-/compare/release%2F4.1.0...release%2F4.1.1
497 [4.1.0]: https://gitlab.com/confget/confget/-/compare/release%2F4.0.1...release%2F4.1.0
498 [4.0.1]: https://gitlab.com/confget/confget/-/compare/release%2F4.0.0...release%2F4.0.1
499 [4.0.0]: https://gitlab.com/confget/confget/-/compare/release%2F3.0.2...release%2F4.0.0
500 [3.0.2]: https://gitlab.com/confget/confget/-/compare/release%2F3.0.1...release%2F3.0.2
501 [3.0.1]: https://gitlab.com/confget/confget/-/compare/release%2F3.0.0...release%2F3.0.1
502 [3.0.0]: https://gitlab.com/confget/confget/-/compare/release%2F2.3.4...release%2F3.0.0
503 [2.3.4]: https://gitlab.com/confget/confget/-/compare/release%2F2.3.3...release%2F2.3.4
504 [2.3.3]: https://gitlab.com/confget/confget/-/compare/release%2F2.3.2...release%2F2.3.3
505 [2.3.2]: https://gitlab.com/confget/confget/-/compare/release%2F2.3.1...release%2F2.3.2
506 [2.3.1]: https://gitlab.com/confget/confget/-/compare/release%2F2.3.0...release%2F2.3.1
507 [2.3.0]: https://gitlab.com/confget/confget/-/compare/release%2F2.2.0...release%2F2.3.0
508 [2.2.0]: https://gitlab.com/confget/confget/-/compare/release%2F2.1.1...release%2F2.2.0
509 [2.1.1]: https://gitlab.com/confget/confget/-/compare/release%2F2.1.0...release%2F2.1.1
510 [2.1.0]: https://gitlab.com/confget/confget/-/compare/release%2F2.0.0...release%2F2.1.0
511 [2.0.0]: https://gitlab.com/confget/confget/-/compare/release%2F1.05...release%2F2.0.0
512 [1.05]: https://gitlab.com/confget/confget/-/compare/release%2F1.04...release%2F1.05
513 [1.04]: https://gitlab.com/confget/confget/-/compare/release%2F1.03...release%2F1.04
514 [1.03]: https://gitlab.com/confget/confget/-/compare/release%2F1.02...release%2F1.03
515 [1.02]: https://gitlab.com/confget/confget/-/compare/release%2F1.01...release%2F1.02
516 [1.01]: https://gitlab.com/confget/confget/-/compare/release%2F1.00...release%2F1.01
517 [1.00]: https://gitlab.com/confget/confget/-/compare/release%2F0.03...release%2F1.00
518 [0.03]: https://gitlab.com/confget/confget/-/compare/release%2F0.02...release%2F0.03
519 [0.02]: https://gitlab.com/confget/confget/-/compare/release%2F0.01...release%2F0.02
520 [0.01]: https://gitlab.com/confget/confget/-/tags/release%2F0.01