aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Reference-manual.md
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2020-09-29 19:24:25 +0300
committerGitHub <noreply@github.com>2020-09-29 19:24:25 +0300
commit5f70984403e48e72e22991882ac6ffa03d6ce18e (patch)
treef6a290c0afb15e572193b1e05a1268c20a1c89fb /docs/markdown/Reference-manual.md
parentff186b05261210602490ea4764e5ccfa2ec494fc (diff)
parent7176b74fd60fb4726826c46c545c2ed25c26cd20 (diff)
downloadmeson-5f70984403e48e72e22991882ac6ffa03d6ce18e.zip
meson-5f70984403e48e72e22991882ac6ffa03d6ce18e.tar.gz
meson-5f70984403e48e72e22991882ac6ffa03d6ce18e.tar.bz2
Merge pull request #7772 from xclaesse/deprecate-source-root
Deprecate meson.build_root() and meson.source_root()
Diffstat (limited to 'docs/markdown/Reference-manual.md')
-rw-r--r--docs/markdown/Reference-manual.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 1d0bb92..d315b53 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1808,17 +1808,23 @@ the following methods.
or `xcode`.
- `build_root()`: returns a string with the absolute path to the build
- root directory. Note: this function will return the build root of
- the parent project if called from a subproject, which is usually
- not what you want. Try using `current_build_dir()`.
+ root directory. *(deprecated since 0.56.0)*: this function will return the
+ build root of the parent project if called from a subproject, which is usually
+ not what you want. Try using `current_build_dir()` or `project_build_root()`.
- `source_root()`: returns a string with the absolute path to the
source root directory. Note: you should use the `files()` function
to refer to files in the root source directory instead of
- constructing paths manually with `meson.source_root()`. This
- function will return the source root of the parent project if called
- from a subproject, which is usually not what you want. Try using
- `current_source_dir()`.
+ constructing paths manually with `meson.source_root()`.
+ *(deprecated since 0.56.0)*: This function will return the source root of the
+ parent project if called from a subproject, which is usually not what you want.
+ Try using `current_source_dir()` or `project_source_root()`.
+
+- `project_build_root()` *(since 0.56.0)*: returns a string with the absolute path
+ to the build root directory of the current (sub)project.
+
+- `project_source_root()` *(since 0.56.0)*: returns a string with the absolute path
+ to the source root directory of the current (sub)project.
- `current_build_dir()`: returns a string with the absolute path to the
current build directory.