aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2021-05-02 13:08:56 +0300
committerJussi Pakkanen <jpakkane@gmail.com>2021-05-02 14:22:27 +0300
commit1ca8fa31ea22df14bf78c90af5ca0b881165ac41 (patch)
tree9911ee9e52512a2d1f2bdd04a0011843a1bd075e
parent88105838645236e12f4100bc2c7bb359fb4e2ccb (diff)
downloadmeson-1ca8fa31ea22df14bf78c90af5ca0b881165ac41.zip
meson-1ca8fa31ea22df14bf78c90af5ca0b881165ac41.tar.gz
meson-1ca8fa31ea22df14bf78c90af5ca0b881165ac41.tar.bz2
Document how to run the wrap valĂ­dator. [skip ci]
-rw-r--r--docs/markdown/Adding-new-projects-to-wrapdb.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/docs/markdown/Adding-new-projects-to-wrapdb.md b/docs/markdown/Adding-new-projects-to-wrapdb.md
index 661ad6c..51a0d71 100644
--- a/docs/markdown/Adding-new-projects-to-wrapdb.md
+++ b/docs/markdown/Adding-new-projects-to-wrapdb.md
@@ -252,10 +252,16 @@ to functionality. All such changes must be submitted to upstream. You
may also host your own Git repo with the changes if you wish. The Wrap
system has native support for Git subprojects.
-## Reviewing wraps
+## Passing automatic validation
-See [Wrap review guidelines](Wrap-review-guidelines.md), especially
-the part about tooling that you can use to check for the most common
-problems yourself. Fixing all issues reported by the tool is a
-mandatory requirement for getting your MR accepted, so doing this
-proactively makes the review process smoother.
+Every submitted wrap goes through an automated correctness review and
+passing it is a requirement for merging. Therefore it is highly
+recommended that you run the validation checks yourself so you can fix
+any issues faster.
+
+Instructions on how to install and run the review tool can be found on
+the [Wrap review guidelines page](Wrap-review-guidelines.md). If your
+submission is merge request number 5 for a repository called `mylib`,
+then you'd run the following command:
+
+ mesonwrap review --pull-request 5 mylib