aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Schwartz <eschwartz@archlinux.org>2022-12-07 22:25:26 -0500
committerEli Schwartz <eschwartz@archlinux.org>2022-12-27 20:29:46 -0500
commit0544ffabf1f252494f6b9699a2b9007682fc322e (patch)
tree23ecaa7ce384cbb4b4f7165117ac7d1b0ab54764 /docs
parent2fa074917597fea0cf3332c6620d3414034825e4 (diff)
downloadmeson-0544ffabf1f252494f6b9699a2b9007682fc322e.zip
meson-0544ffabf1f252494f6b9699a2b9007682fc322e.tar.gz
meson-0544ffabf1f252494f6b9699a2b9007682fc322e.tar.bz2
add builtin option to install licenses
Unless `meson.install_dependency_manifest()` is explicitly used, this will cause a default implied one to be installed.
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Builtin-options.md5
-rw-r--r--docs/markdown/snippets/licensesdir_option.md4
-rw-r--r--docs/yaml/builtins/meson.yaml4
3 files changed, 13 insertions, 0 deletions
diff --git a/docs/markdown/Builtin-options.md b/docs/markdown/Builtin-options.md
index 4c43f09..f8c3d8a 100644
--- a/docs/markdown/Builtin-options.md
+++ b/docs/markdown/Builtin-options.md
@@ -41,6 +41,7 @@ not be relied on, since they can be absolute paths in the following cases:
| includedir | include | Header file directory |
| infodir | share/info | Info page directory |
| libdir | see below | Library directory |
+| licensedir | see below | Licenses directory (since 1.1.0)|
| libexecdir | libexec | Library executable directory |
| localedir | share/locale | Locale data directory |
| localstatedir | var | Localstate data directory |
@@ -61,6 +62,10 @@ different distributions have different defaults. Using a [cross
file](Cross-compilation.md#defining-the-environment), particularly the
paths section may be necessary.
+`licensedir` is empty by default. If set, it defines the default location
+to install a dependency manifest and project licenses. For more details,
+see [[meson.install_dependency_manifest]].
+
### Core options
Options that are labeled "per machine" in the table are set per
diff --git a/docs/markdown/snippets/licensesdir_option.md b/docs/markdown/snippets/licensesdir_option.md
new file mode 100644
index 0000000..77ccd0d
--- /dev/null
+++ b/docs/markdown/snippets/licensesdir_option.md
@@ -0,0 +1,4 @@
+## A new core directory option "licensedir" is available
+
+This will install a dependency manifest to the specified directory, if none
+is is explicitly set.
diff --git a/docs/yaml/builtins/meson.yaml b/docs/yaml/builtins/meson.yaml
index a457dbf..1dd746f 100644
--- a/docs/yaml/builtins/meson.yaml
+++ b/docs/yaml/builtins/meson.yaml
@@ -323,6 +323,10 @@ methods:
If license files are defined as well, they will be copied next to the
manifest and referenced in it.
+ If this function is not used, the builtin option `licensedir` can
+ be used to install the manifest to a given directory with the name
+ `depmf.json`.
+
posargs:
output_name:
type: str