aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2022-10-10 22:17:00 +0300
committerGitHub <noreply@github.com>2022-10-10 22:17:00 +0300
commit46acd6cd4ac33973daee5436dca8c3035c8f464c (patch)
treec39388c6957f08aca7db20484f905cdf66b35301 /docs
parent58581ae3debcb0d043093cc787b560cfd2a22c75 (diff)
parent8c3a87847e8469c4b49a1ed130247e4ff023072a (diff)
downloadmeson-46acd6cd4ac33973daee5436dca8c3035c8f464c.zip
meson-46acd6cd4ac33973daee5436dca8c3035c8f464c.tar.gz
meson-46acd6cd4ac33973daee5436dca8c3035c8f464c.tar.bz2
Merge pull request #8941 from xclaesse/wrapdb
Automatically use WrapDB fallback
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Using-wraptool.md14
-rw-r--r--docs/markdown/snippets/wrapdb.md6
-rw-r--r--docs/yaml/functions/dependency.yaml5
3 files changed, 25 insertions, 0 deletions
diff --git a/docs/markdown/Using-wraptool.md b/docs/markdown/Using-wraptool.md
index cabdc0e..edbceaa 100644
--- a/docs/markdown/Using-wraptool.md
+++ b/docs/markdown/Using-wraptool.md
@@ -82,3 +82,17 @@ straightforward:
Wraptool can do other things besides these. Documentation for these
can be found in the command line help, which can be accessed by
`meson wrap --help`.
+
+## Automatic dependency fallback
+
+Since *0.64.0* Meson can use WrapDB to automatically find missing dependencies.
+
+The user simply needs to download latest database, the following command stores
+it in `subprojects/wrapdb.json`:
+ $ meson wrap update-db
+
+Once the database is available locally, any dependency not found on the system
+but available in WrapDB will automatically be downloaded.
+
+Automatic fetch of WrapDB subprojects can be disabled by removing the file
+`subprojects/wrapdb.json`, or by using `--wrap-mode=nodownload`.
diff --git a/docs/markdown/snippets/wrapdb.md b/docs/markdown/snippets/wrapdb.md
new file mode 100644
index 0000000..d5caf4f
--- /dev/null
+++ b/docs/markdown/snippets/wrapdb.md
@@ -0,0 +1,6 @@
+## Automatic fallback using WrapDB
+
+A new command has been added: `meson wrap update-db`. It downloads the list of
+wraps available in [WrapDB](wrapdb.mesonbuild.com) and stores it locally in
+`subprojects/wrapdb.json`. When that file exists and a dependency is not found
+on the system but is available in WrapDB, Meson will automatically download it.
diff --git a/docs/yaml/functions/dependency.yaml b/docs/yaml/functions/dependency.yaml
index dcb696d..3a4d2e8 100644
--- a/docs/yaml/functions/dependency.yaml
+++ b/docs/yaml/functions/dependency.yaml
@@ -15,6 +15,11 @@ description: |
of those name will return the same value. This is useful in case a dependency
could have different names, such as `png` and `libpng`.
+ * Since *0.64.0* a dependency fallback can be provided by WrapDB. Simply download
+ the database locally using `meson wrap update-db` command and Meson will
+ automatically fallback to subprojects provided by WrapDB if the dependency is
+ not found on the system and the project does not ship their own `.wrap` file.
+
Dependencies can also be resolved in two other ways:
* if the same name was used in a `meson.override_dependency` prior to