aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2020-05-27 23:42:30 +0300
committerGitHub <noreply@github.com>2020-05-27 23:42:30 +0300
commitc61f75adbfd5b2ce18de329e65217cc911f989d4 (patch)
treef6fda4f428279e9530b89de7eeb09049bc289295 /docs
parente2c475939eca7d49b9039be3c0a565c0e38c32ac (diff)
parent5e5895814fab79c3f60ce406b0c6cf8d89a7970e (diff)
downloadmeson-c61f75adbfd5b2ce18de329e65217cc911f989d4.zip
meson-c61f75adbfd5b2ce18de329e65217cc911f989d4.tar.gz
meson-c61f75adbfd5b2ce18de329e65217cc911f989d4.tar.bz2
Merge pull request #6818 from mensinda/localPatch
Wrap: add local files support via *_filename
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Wrap-dependency-system-manual.md18
-rw-r--r--docs/markdown/snippets/wrap_patch.md6
2 files changed, 18 insertions, 6 deletions
diff --git a/docs/markdown/Wrap-dependency-system-manual.md b/docs/markdown/Wrap-dependency-system-manual.md
index 6e47d58..868263c 100644
--- a/docs/markdown/Wrap-dependency-system-manual.md
+++ b/docs/markdown/Wrap-dependency-system-manual.md
@@ -28,16 +28,16 @@ itself in a way that makes it easy to use (usually this means as a
static library).
To use this kind of a project as a dependency you could just copy and
-extract it inside your project's `subprojects` directory.
+extract it inside your project's `subprojects` directory.
However there is a simpler way. You can specify a Wrap file that tells Meson
-how to download it for you. If you then use this subproject in your build,
+how to download it for you. If you then use this subproject in your build,
Meson will automatically download and extract it during build. This makes
subproject embedding extremely easy.
All wrap files must have a name of `<project_name>.wrap` form and be in `subprojects` dir.
-Currently Meson has four kinds of wraps:
+Currently Meson has four kinds of wraps:
- wrap-file
- wrap-git
- wrap-hg
@@ -83,6 +83,12 @@ revision = head
directory name. Needed when the source file does not have a leading
directory.
+Since *0.55.0* it is possible to use only the `source_filename` and
+`patch_filename` value in a .wrap file (without `source_url` and `patch_url`) to
+specify a local archive in the `subprojects/packagefiles` directory. The `*_hash`
+entries are optional when using this method. This method should be prefered over
+the old `packagecache` approach described below.
+
Since *0.49.0* if `source_filename` or `patch_filename` is found in the
project's `subprojects/packagecache` directory, it will be used instead
of downloading the file, even if `--wrap-mode` option is set to
@@ -129,14 +135,14 @@ wrap-git, the repository must contain all Meson build definitions.
## Using wrapped projects
-Wraps provide a convenient way of obtaining a project into your subproject directory.
+Wraps provide a convenient way of obtaining a project into your subproject directory.
Then you use it as a regular subproject (see [subprojects](Subprojects.md)).
## Getting wraps
-Usually you don't want to write your wraps by hand.
+Usually you don't want to write your wraps by hand.
-There is an online repository called [WrapDB](https://wrapdb.mesonbuild.com) that provides
+There is an online repository called [WrapDB](https://wrapdb.mesonbuild.com) that provides
many dependencies ready to use. You can read more about WrapDB [here](Using-the-WrapDB.md).
There is also a Meson subcommand to get and manage wraps (see [using wraptool](Using-wraptool.md)).
diff --git a/docs/markdown/snippets/wrap_patch.md b/docs/markdown/snippets/wrap_patch.md
new file mode 100644
index 0000000..7d6d9c2
--- /dev/null
+++ b/docs/markdown/snippets/wrap_patch.md
@@ -0,0 +1,6 @@
+## Local wrap source and patch files
+
+It is now possible to use the `patch_filename` and `source_filename` value in a
+`.wrap` file without `*_url` to specify a local source / patch file. All local
+files must be located in the `subprojects/packagefiles` directory. The `*_hash`
+entries are optional with this setup.