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 13:08:56 +0300
commit27293a080d3b702a3edffe863bc9285bd2711705 (patch)
treeb9cdc85073ae565436ee3cd8cccdf665aa8bbf6e
parentb2687e86c87a1dd2e254aeaf3355b3e98b82b730 (diff)
downloadmeson-reviewtool.zip
meson-reviewtool.tar.gz
meson-reviewtool.tar.bz2
Document how to run the wrap valĂ­dator. [skip ci]reviewtool
-rw-r--r--docs/markdown/Adding-new-projects-to-wrapdb.md19
1 files changed, 13 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..1ce9f3e 100644
--- a/docs/markdown/Adding-new-projects-to-wrapdb.md
+++ b/docs/markdown/Adding-new-projects-to-wrapdb.md
@@ -252,10 +252,17 @@ 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).
+proactively makes the review process smoother. 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