aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Subprojects.md
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek@centricular.com>2018-05-09 14:54:26 +0530
committerGitHub <noreply@github.com>2018-05-09 14:54:26 +0530
commit0eb4423b8522e7ddd9beb3de1aa6a5feff9141d6 (patch)
tree159010be13c00e853d59723976cfbe7aa8798106 /docs/markdown/Subprojects.md
parent43f9318afa172beec94829d6ba8721e653f4eefb (diff)
downloadmeson-0eb4423b8522e7ddd9beb3de1aa6a5feff9141d6.zip
meson-0eb4423b8522e7ddd9beb3de1aa6a5feff9141d6.tar.gz
meson-0eb4423b8522e7ddd9beb3de1aa6a5feff9141d6.tar.bz2
subprojects.md: document --wrap-mode
Closes https://github.com/mesonbuild/meson/issues/3534
Diffstat (limited to 'docs/markdown/Subprojects.md')
-rw-r--r--docs/markdown/Subprojects.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/markdown/Subprojects.md b/docs/markdown/Subprojects.md
index ad2aae2..80ed3e7 100644
--- a/docs/markdown/Subprojects.md
+++ b/docs/markdown/Subprojects.md
@@ -72,6 +72,35 @@ in the top level `subprojects` directory. Recursive use of subprojects
is not allowed, though, so you can't have subproject `a` that uses
subproject `b` and have `b` also use `a`.
+# Command-line options
+
+The usage of subprojects can be controlled by users and distros with
+the following command-line options:
+
+* **--wrap-mode=nodownload**
+
+ Meson will not use the network to download any subprojects or
+ fetch any wrap information. Only pre-existing sources will be used.
+ This is useful (mostly for distros) when you want to only use the
+ sources provided by a software release, and want to manually handle
+ or provide missing dependencies.
+
+* **--wrap-mode=nofallback**
+
+ Meson will not use subproject fallbacks for any dependency
+ declarations in the build files, and will only look for them in the
+ system. Note that this does not apply to unconditional subproject()
+ calls, and those are meant to be used for sources that cannot be
+ provided by the system, such as copylibs.
+
+* **--wrap-mode=forcefallback**
+
+ Meson will not look at the system for any dependencies which have
+ subproject fallbacks available, and will *only* use subprojects for
+ them. This is useful when you want to test your fallback setup, or
+ want to specifically build against the library sources provided by
+ your subprojects.
+
# Obtaining subprojects
Meson ships with a dependency system to automatically obtain