summaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorPaweł Marczewski <pawel@invisiblethingslab.com>2021-12-10 14:26:37 +0100
committerXavier Claessens <xclaesse@gmail.com>2022-06-07 06:43:39 -0400
commit9061c3a52d355e478cbf83a6110b4cc3d2330ba6 (patch)
tree4ac2a2466c3a8d6a5f66d629cc57021ae11a5329 /docs/markdown
parent29c26d5b26397eaa3606d22d71309ecd1eb6b223 (diff)
downloadmeson-9061c3a52d355e478cbf83a6110b4cc3d2330ba6.tar.gz
wrap: Add support for applying a list of patch files
Co-authored-by: Xavier Claessens <xavier.claessens@collabora.com>
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Wrap-dependency-system-manual.md33
-rw-r--r--docs/markdown/snippets/diff_files.md6
2 files changed, 39 insertions, 0 deletions
diff --git a/docs/markdown/Wrap-dependency-system-manual.md b/docs/markdown/Wrap-dependency-system-manual.md
index eb5de1b13..314cd1f10 100644
--- a/docs/markdown/Wrap-dependency-system-manual.md
+++ b/docs/markdown/Wrap-dependency-system-manual.md
@@ -84,6 +84,8 @@ previously reserved to `wrap-file`:
- `patch_directory` - *Since 0.55.0* Overlay directory, alternative to `patch_filename` in the case
files are local instead of a downloaded archive. The directory must be placed in
`subprojects/packagefiles`.
+- `diff_files` - *Since 0.63.0* Comma-separated list of local diff files (see
+ [Diff files](#diff-files) below).
### Specific to wrap-file
- `source_url` - download url to retrieve the wrap-file source archive
@@ -147,6 +149,37 @@ wrap-file mode. When using wrap-git, the repository must contain all
Meson build definitions. Since *0.55.0* Meson build patches are
supported for any wrap modes, including wrap-git.
+## Diff files
+
+*Since: 0.63.0*
+
+You can also provide local patch files in `diff` format. For historic reasons,
+they are referred to as "diff files", since the "patch" name is already used for
+overlay archives.
+
+The diff files are described by the `diff_files` property (a comma-separated
+list), and must be available locally in the `subprojects/packagefiles`
+directory.
+
+Meson will apply the diff files after extracting or cloning the project, and
+after applying the overlay archive (`patch_*`). For this feature, the `patch` or
+`git` command-line tool must be available.
+
+The diff files will be applied with `-p1`, i.e. treating the first path
+component as a prefix to be stripped. This is the default for diffs produced by
+Git.
+
+```ini
+[wrap-file]
+directory = libfoobar-1.0
+
+source_url = https://example.com/foobar-1.0.tar.gz
+source_filename = foobar-1.0.tar.gz
+source_hash = 5ebeea0dfb75d090ea0e7ff84799b2a7a1550db3fe61eb5f6f61c2e971e57663
+
+diff_files = libfoobar-1.0/0001.patch, libfoobar-1.0/0002.patch
+```
+
## `provide` section
*Since *0.55.0*
diff --git a/docs/markdown/snippets/diff_files.md b/docs/markdown/snippets/diff_files.md
new file mode 100644
index 000000000..3f425a2d6
--- /dev/null
+++ b/docs/markdown/snippets/diff_files.md
@@ -0,0 +1,6 @@
+## Diff files for wraps
+
+Wrap files can now define `diff_files`, a list of local patch files in `diff`
+format. Meson will apply the diff files after extracting or cloning the project,
+and after applying the overlay archive (`patch_*`). For this feature, the
+`patch` or `git` command-line tool must be available.