Skip to content

Commit

Permalink
Commit 152
Browse files Browse the repository at this point in the history
- Code readability
- Documentation
- Examples
  • Loading branch information
madmurphy committed Sep 25, 2021
1 parent 1ffaf70 commit 863999c
Show file tree
Hide file tree
Showing 70 changed files with 6,362 additions and 5,379 deletions.
4 changes: 2 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ root = true
indent_style = tab
indent_size = 2

[{src/confini.c,dev/marked-sources/confini-marked.c,**.sh,configure.ac,**/Makefile.am,**.m4}]
[{src/confini.c,dev/marked-sources/confini-marked.c,dev/hackings/baremetal/str2num.c,**.sh,configure.ac,**/Makefile.am,**.m4}]
charset = utf-8
indent_style = tab
indent_size = 4

[{src/confini.h,dev/marked-sources/confini-marked.h}]
[{src/confini.h,dev/marked-sources/confini-marked.h,dev/hackings/baremetal/str2num.h}]
charset = utf-8
indent_style = space
indent_size = 4
Expand Down
2 changes: 1 addition & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
madmurphy333 AT gmail DOT com
madmurphy <madmurphy333 AT gmail DOT com>
14 changes: 12 additions & 2 deletions ChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@ Change Log
==========


## 1.16.2 (2021-09-25)

Changes:

* Issue [#16](https://github.com/madmurphy/libconfini/issues/16) has been fixed
* Code readability
* Documentation
* Examples


## 1.16.1 (2021-06-14)

Changes:
Expand Down Expand Up @@ -151,8 +161,8 @@ Changes:
source-image` and † `make authors-suitcase` targets, renamed † `make
install-manifest` target to `make manifest`, created `make portable-builds`
and `make oblivion-clean` targets, improved `install-data-hook` and all the
helper targets; `src/Makefile.am`: moved the `CFLAGS` automatically guessed by
`AC_PROG_CC_C99` to `AM_CFLAGS`)
helper targets; `src/Makefile.am`: moved the `CFLAGS` automatically guessed
by `AC_PROG_CC_C99` to `AM_CFLAGS`)
* Added call to `strip.exe` to the `mgwmake.bat` script


Expand Down
26 changes: 14 additions & 12 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Microsoft Windows
### MinGW

If you are using Microsoft Windows, a batch script for compiling **libconfini**
under MinGW without GNU Make is available (`mgwmake.bat`). If you want instead
with MinGW without GNU Make is available (`mgwmake.bat`). If you want instead
to compile the library manually, you can run:

cd src
Expand All @@ -79,8 +79,9 @@ If you want to generate also the `.def` file, use:
strip.exe libconfini.dll

If you want to build (and install) **libconfini** via GNU Make under Microsoft
Windows several options are available, such as MinGW + MSYS, MSYS2, GnuWin32
and Cygwin (for which [an unofficial port][1] of **libconfini** exists).
Windows several options are available, such as MinGW + MSYS, MSYS2 (which ships
[an official port][1] of the library, Cygwin (for which [an unofficial port][2]
of **libconfini** exists) and GnuWin32.


### Microsoft Visual Studio
Expand Down Expand Up @@ -131,7 +132,7 @@ standard `extern` keyword is used to access a shared `.data` segment.

### Precompiled DLL

Often a compiled DLL [is available][2] among the assets of each release of this
Often a compiled DLL [is available][3] among the assets of each release of this
package on GitHub.


Expand All @@ -146,9 +147,9 @@ Library is simply too heavy or just not implementable.

In these situations it will be needed to get rid of every tie with the C
Standard Library and compile **libconfini** as "bare metal". The `configure`
script has a `--without-io-api` option that allows to create a special fork of
the original library able to function in any environment. For information about
how to proceed, please see `dev/hackings/baremetal/README.md`.
script has two options for creating special forks of the original library able to
function in any environment, `--without-io-api` and `--without-libc`. For
information about how to proceed, please see `dev/hackings/baremetal/README.md`.


Complex installations
Expand Down Expand Up @@ -178,7 +179,7 @@ package names of all versions that are older than the current version.
If you want to install a modified version of **libconfini** without generating
conflicts with an original version already present in the system, or you simply
want to install **libconfini** under a different name, you can use [Autoconf
transforming rules][3]. In particular, to prepend a prefix to the library name,
transforming rules][4]. In particular, to prepend a prefix to the library name,
use `./configure --program-prefix=[PREFIX]`; to append a suffix, use
`./configure --program-suffix=[SUFFIX]`; to perform a `sed` substitution, use
`./configure --program-transform-name="s/[OLDTEXT]/[NEWTEXT]/[g]"`. Note that
Expand All @@ -199,7 +200,7 @@ For any issue, drop a message at https://github.com/madmurphy/libconfini/issues.
Distributing the source code
----------------------------

If you aim to re-distribute the source code of **libconfini** you should first
If you aim to re-distribute the source code of **libconfini** you must first
make sure that the `configure` script is present, for granting the possibility
to compile the package without having Autotools installed. If the `configure`
script is present and you have already launched it, use `make distclean` to
Expand All @@ -215,7 +216,8 @@ particular platform. If you want to obtain the list of the files that are going
to be installed, use `make manifest`.


[1]: https://github.com/fd00/yacp/tree/master/libconfini
[2]: https://github.com/madmurphy/libconfini/releases
[3]: https://www.gnu.org/software/automake/manual/html_node/Renaming.html
[1]: https://packages.msys2.org/base/mingw-w64-libconfini
[2]: https://github.com/fd00/yacp/tree/master/libconfini
[3]: https://github.com/madmurphy/libconfini/releases
[4]: https://www.gnu.org/software/automake/manual/html_node/Renaming.html

Loading

0 comments on commit 863999c

Please sign in to comment.