aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorXavier Claessens <xavier.claessens@collabora.com>2020-10-27 23:03:53 -0400
committerXavier Claessens <xclaesse@gmail.com>2021-01-26 21:32:03 -0500
commitbaa9eeebe4915ac192cdb31dbcbf11383e380572 (patch)
tree3ca6397d20e3075e40ee0f1a2a2267c0d78c4868 /docs/markdown
parent9d602e65314b1d57de115d49b8f4a447c597404f (diff)
downloadmeson-baa9eeebe4915ac192cdb31dbcbf11383e380572.zip
meson-baa9eeebe4915ac192cdb31dbcbf11383e380572.tar.gz
meson-baa9eeebe4915ac192cdb31dbcbf11383e380572.tar.bz2
dist: Allow packaging subproject in same git repo as main project
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Creating-releases.md18
-rw-r--r--docs/markdown/snippets/dist_subproject.md16
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/markdown/Creating-releases.md b/docs/markdown/Creating-releases.md
index 040fb53..55242a6 100644
--- a/docs/markdown/Creating-releases.md
+++ b/docs/markdown/Creating-releases.md
@@ -58,3 +58,21 @@ for example when done in CI that already does its own testing.
So with `--no-tests` you can tell Meson "Do not build and test generated
packages.".
+## Release a subproject separately
+
+*Since 0.57.0* the `meson dist` command can now create a distribution tarball
+for a subproject in the same git repository as the main project. This can be
+useful if parts of the project (e.g. libraries) can be built and distributed
+separately. In that case they can be moved into `subprojects/mysub` and running
+`meson dist` in that directory will now create a tarball containing only the
+source code from that subdir and not the rest of the main project or other
+subprojects.
+
+For example:
+```sh
+git clone https://github.com/myproject
+cd myproject/subprojects/mysubproject
+meson builddir
+meson dist -C builddir
+```
+This produces `builddir/meson-dist/mysubproject-1.0.tar.xz` tarball.
diff --git a/docs/markdown/snippets/dist_subproject.md b/docs/markdown/snippets/dist_subproject.md
new file mode 100644
index 0000000..2520ccd
--- /dev/null
+++ b/docs/markdown/snippets/dist_subproject.md
@@ -0,0 +1,16 @@
+## Package a subproject
+
+The `meson dist` command can now create a distribution tarball for a subproject
+in the same git repository as the main project. This can be useful if parts of
+the project (e.g. libraries) can be built and distributed separately. In that
+case they can be moved into `subprojects/mysub` and running `meson dist` in that
+directory will now create a tarball containing only the source code from that
+subdir and not the rest of the main project or other subprojects.
+
+For example:
+```sh
+git clone https://github.com/myproject
+cd myproject/subprojects/mysubproject
+meson builddir
+meson dist -C builddir
+```