aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorJon Turney <jon.turney@dronecode.org.uk>2018-01-31 23:57:52 +0000
committerJussi Pakkanen <jpakkane@gmail.com>2018-03-07 19:57:20 +0200
commitffe6ed2a47c89a0ef84c44edb1d9771444fc2b78 (patch)
treeff211b4fb5c3d38ec115b70d535dcbaf7066abb6 /docs/markdown
parentc03a2fd2831444fe248cf983d89c19aeab1fff40 (diff)
downloadmeson-ffe6ed2a47c89a0ef84c44edb1d9771444fc2b78.zip
meson-ffe6ed2a47c89a0ef84c44edb1d9771444fc2b78.tar.gz
meson-ffe6ed2a47c89a0ef84c44edb1d9771444fc2b78.tar.bz2
doc: Tweak text about get_option('foodir') in reference manual [skip ci]
* The example for executable()'s install_dir: should use join_paths() * Clarify how to use directory options which are potentially not prefix relative This is mentioned in https://github.com/mesonbuild/meson/issues/1637 and see also https://patchwork.freedesktop.org/patch/200373/ for an example of this usage, and the possible confusion that can arise.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 5b22fec..8798a3a 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -435,7 +435,7 @@ be passed to [shared and static libraries](#library).
- `install_dir` override install directory for this file. The value is
relative to the `prefix` specified. F.ex, if you want to install
plugins into a subdir, you'd use something like this: `install_dir :
- get_option('libdir') + '/projectname-1.0'`.
+ join_paths(get_option('libdir'), 'projectname-1.0'`).
- `install_rpath` a string to set the target's rpath to after install
(but *not* before that)
- `objects` list of prebuilt object files (usually for third party
@@ -615,8 +615,13 @@ Obtains the value of the [project build option](Build-options.md) specified in t
Note that the value returned for built-in options that end in `dir` such as
`bindir` and `libdir` is always a path relative to (and inside) the `prefix`.
+
The only exceptions are: `sysconfdir`, `localstatedir`, and `sharedstatedir`
-which will return the value passed during configuration as-is.
+which will return the value passed during configuration as-is, which may be
+absolute, or relative to `prefix`. [`install_dir` arguments](Installing.md)
+handles that as expected, but if you need the absolute path to one of these
+e.g. to use in a define etc., you should use `join_paths(get_option('prefix'),
+get_option('localstatedir')))`
### get_variable()