tboudreaux/libconfig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(version-+-docs): v2.2.5 -> v2.2.2

Browse Source 
This version brings the more robust system to system install scheme, sandboxed vendor libraries at install time, and documentation of these locations in the readme
This commit is contained in:
Emily Boudreaux
2026-06-05 16:02:43 +00:00
parent 2f7d900840
commit fcafa5679b
3 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Doxyfile
View File

@@ -48,7 +48,7 @@ PROJECT_NAME = libconfig
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = v2.2.5 PROJECT_NUMBER = v2.2.6
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewers a # for a project that appears at the top of each page and should give viewers a

2
meson.build
View File

@@ -18,7 +18,7 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
# #
# *********************************************************************** # # *********************************************************************** #
project('libconfig', ['cpp', 'c'], version: 'v2.2.5', default_options: ['cpp_std=c++23'], meson_version: '>=1.5.0') project('libconfig', ['cpp', 'c'], version: 'v2.2.6', default_options: ['cpp_std=c++23'], meson_version: '>=1.5.0')
# Add default visibility for all C++ targets # Add default visibility for all C++ targets
add_project_arguments('-fvisibility=default', language: 'cpp') add_project_arguments('-fvisibility=default', language: 'cpp')

21
readme.md
View File

@@ -140,3 +140,24 @@ time_step = 0.01
max_time = 100.0 max_time = 100.0
``` ```
## Linking Other Code
At compile time libconfig generates a pkg-config file which makes linking other code to libconfig easy. Note that you
will need to have run `meson setup` at least once to generate the pkg-config file before you can link to it.
Headers are installed to the meson install dir (e.g. /usr/local/include) under a `fourdst/config` subdirectory so you
can include the main header with `#include "fourdst/config/config.h"`. Including this header will include all of the
necessary headers for using libconfig.
When linking to libconfig you can use `pkg-config --cflags --libs fourdst-config` to get the necessary compiler and
linker flags. If you are using meson to build your project you can use `dependency('fourdst-config')` in your
meson.build file to link to libconfig.
Libraries are installed to the meson install dir (e.g. /usr/local/lib) with the name `libfourdst-config.so` on linux and
`fourdst-config.a` on macOS. The pkg-config file will take care of the correct library name for your platform.
Finally, vendor headers and libraries are placed in a dedicated vendor directory in the fourdst directory so as to not
interfere with system packages. The pkg-config file will include the necessary include and library paths to use these
vendor dependencies as well. For example, libconfig depends on toml++ for parsing TOML files. The toml++ headers are
included in `fourdst/vendor/tomlplusplus` and the pkg-config file will include the necessary include path to use these
headers when you link to libconfig.