aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorandy5995 <andy400-dev@yahoo.com>2022-01-17 23:37:36 -0600
committerEli Schwartz <eschwartz93@gmail.com>2022-02-10 21:23:20 -0500
commitb1e6cc5553f340e4e4c76f4dd355444d13d6a614 (patch)
tree4479227c8ec4823eafbed293174f6f498e0dab72 /docs
parent3596b6b19a0e5bf6ce65a640448d459c85180184 (diff)
downloadmeson-b1e6cc5553f340e4e4c76f4dd355444d13d6a614.zip
meson-b1e6cc5553f340e4e4c76f4dd355444d13d6a614.tar.gz
meson-b1e6cc5553f340e4e4c76f4dd355444d13d6a614.tar.bz2
implement 'dist --allow-dirty' flag
closes #9824
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Creating-releases.md8
-rw-r--r--docs/markdown/snippets/dist-allow-dirty-flag.md7
2 files changed, 15 insertions, 0 deletions
diff --git a/docs/markdown/Creating-releases.md b/docs/markdown/Creating-releases.md
index b824459..dfdc579 100644
--- a/docs/markdown/Creating-releases.md
+++ b/docs/markdown/Creating-releases.md
@@ -60,6 +60,14 @@ 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.".
+## Use `--allow-dirty` to override error when git repository contains uncommitted changes
+
+*Since 0.62.0* Instead of emitting a warning when a repository contains
+uncommitted changes, Meson will produce an error message notifying the
+user and immediately exit. If `--allow-dirty` is given as an option to
+`meson dist`, a warning will be emitted instead and Meson will proceed
+as usual.
+
## Release a subproject separately
*Since 0.57.0* the `meson dist` command can now create a distribution tarball
diff --git a/docs/markdown/snippets/dist-allow-dirty-flag.md b/docs/markdown/snippets/dist-allow-dirty-flag.md
new file mode 100644
index 0000000..63ca3a0
--- /dev/null
+++ b/docs/markdown/snippets/dist-allow-dirty-flag.md
@@ -0,0 +1,7 @@
+## Added optional '--allow-dirty' flag for the 'dist' command
+
+An optional `--allow-dirty` flag has been added to the `dist` command.
+
+Previously, if uncommitted changes were present, Meson would warn about
+this but continue with the dist process. It now errors out instead. The
+error can be suppressed by using the `--allow-dirty` option.