From 1ca8fa31ea22df14bf78c90af5ca0b881165ac41 Mon Sep 17 00:00:00 2001 From: Jussi Pakkanen Date: Sun, 2 May 2021 13:08:56 +0300 Subject: =?UTF-8?q?Document=20how=20to=20run=20the=20wrap=20val=C3=ADdator?= =?UTF-8?q?.=20[skip=20ci]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/markdown/Adding-new-projects-to-wrapdb.md | 18 ++++++++++++------ 1 file 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 -- cgit v1.1