aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Fort <contact@hardening-consulting.com>2018-02-16 09:16:56 +0100
committerJussi Pakkanen <jpakkane@gmail.com>2019-01-17 20:48:28 +0200
commitceaebf6bac171317fffc2c6bf1bffbc9968a48cc (patch)
treeb60c72b8963f78c3ce998b52f9f6053aa2c1cfa1 /docs
parent267792174c9921e6be296086b0c806a684432a1b (diff)
downloadmeson-ceaebf6bac171317fffc2c6bf1bffbc9968a48cc.zip
meson-ceaebf6bac171317fffc2c6bf1bffbc9968a48cc.tar.gz
meson-ceaebf6bac171317fffc2c6bf1bffbc9968a48cc.tar.bz2
add support for generating cmake files
This new cmake module allows to generate cmake package files. This may ease the porting for cmake projects that are exporting cmake package informations for other depending projects. The module uses as much as possible the templates provided by the cmake installation (and so cmake needs to be installed).
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/CMake-module.md71
-rw-r--r--docs/sitemap.txt1
2 files changed, 72 insertions, 0 deletions
diff --git a/docs/markdown/CMake-module.md b/docs/markdown/CMake-module.md
new file mode 100644
index 0000000..4cc97cf
--- /dev/null
+++ b/docs/markdown/CMake-module.md
@@ -0,0 +1,71 @@
+# CMake module
+
+This module provides helper tools for generating cmake package files.
+
+
+## Usage
+
+To use this module, just do: **`cmake = import('cmake')`**. The
+following functions will then be available as methods on the object
+with the name `cmake`. You can, of course, replace the name `cmake`
+with anything else.
+
+### cmake.write_basic_package_version_file()
+
+This function is the equivalent of the corresponding [CMake function](https://cmake.org/cmake/help/v3.11/module/CMakePackageConfigHelpers.html#generating-a-package-version-file),
+it generates a `name` package version file.
+
+* `name`: the name of the package.
+* `version`: the version of the generated package file.
+* `compatibility`: a string indicating the kind of compatibility, the accepted values are
+`AnyNewerVersion`, `SameMajorVersion`, `SameMinorVersion` or `ExactVersion`.
+It defaults to `AnyNewerVersion`. Depending on your cmake installation some kind of
+compatibility may not be available.
+* `install_dir`: optional installation directory, it defaults to `$(libdir)/cmake/$(name)`
+
+
+Example:
+
+```meson
+cmake = import('cmake')
+
+cmake.write_basic_package_version_file(name: 'myProject', version: '1.0.0')
+```
+
+### cmake.configure_package_config_file()
+
+This function is the equivalent of the corresponding [CMake function](https://cmake.org/cmake/help/v3.11/module/CMakePackageConfigHelpers.html#generating-a-package-configuration-file),
+it generates a `name` package configuration file from the `input` template file. Just like the cmake function
+in this file the `@PACKAGE_INIT@` statement will be replaced by the appropriate piece of cmake code.
+The equivalent `PATH_VARS` argument is given through the `configuration` parameter.
+
+* `name`: the name of the package.
+* `input`: the template file where that will be treated for variable substitutions contained in `configuration`.
+* `install_dir`: optional installation directory, it defaults to `$(libdir)/cmake/$(name)`.
+* `configuration`: a `configuration_data` object that will be used for variable substitution in the template file.
+
+
+Example:
+
+meson.build:
+
+```meson
+cmake = import('cmake')
+
+conf = configuration_data()
+conf.set_quoted('VAR', 'variable value')
+
+cmake.configure_package_config_file(
+ name: 'myProject',
+ input: 'myProject.cmake.in',
+ configuration: conf
+)
+```
+
+myProject.cmake.in:
+
+```text
+@PACKAGE_INIT@
+
+set(MYVAR VAR)
+```
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index b8c41b4..f80c279 100644
--- a/docs/sitemap.txt
+++ b/docs/sitemap.txt
@@ -30,6 +30,7 @@ index.md
Subprojects.md
Disabler.md
Modules.md
+ CMake-module.md
Dlang-module.md
Gnome-module.md
Hotdoc-module.md