aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2021-03-26 21:23:04 +0200
committerJussi Pakkanen <jpakkane@gmail.com>2021-03-27 15:12:28 +0200
commit268a78f0f473c1b5193e8b44a067030b74a6559d (patch)
treeae72586fc1e129ac46d81b42f42423b0e0cc0bd4 /docs
parent47633330da1011f9c526bab8950c8265ef9ed7d4 (diff)
downloadmeson-268a78f0f473c1b5193e8b44a067030b74a6559d.zip
meson-268a78f0f473c1b5193e8b44a067030b74a6559d.tar.gz
meson-268a78f0f473c1b5193e8b44a067030b74a6559d.tar.bz2
Added some wrap review docs. [skip ci]
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Adding-new-projects-to-wrapdb.md14
-rw-r--r--docs/markdown/Wrap-review-guidelines.md26
2 files changed, 39 insertions, 1 deletions
diff --git a/docs/markdown/Adding-new-projects-to-wrapdb.md b/docs/markdown/Adding-new-projects-to-wrapdb.md
index a1d2486..661ad6c 100644
--- a/docs/markdown/Adding-new-projects-to-wrapdb.md
+++ b/docs/markdown/Adding-new-projects-to-wrapdb.md
@@ -201,6 +201,14 @@ git commit -a --amend
git push --force
```
+### Request a new release version to an existing repository
+
+Adding new releases to an existing repo is straightforward. All you
+need to do is to follow the rules discussed above but when you create
+the merge request, file it against the master branch. The repository
+reviewer will create the necessary branch and retarget your merge
+request accordingly.
+
## What is done by WrapDB maintainers
[mesonwrap tools](Wrap-maintainer-tools.md) must be used for the tasks
@@ -246,4 +254,8 @@ system has native support for Git subprojects.
## Reviewing wraps
-See [Wrap review guidelines](Wrap-review-guidelines.md).
+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.
diff --git a/docs/markdown/Wrap-review-guidelines.md b/docs/markdown/Wrap-review-guidelines.md
index c81a8fa..670baa6 100644
--- a/docs/markdown/Wrap-review-guidelines.md
+++ b/docs/markdown/Wrap-review-guidelines.md
@@ -26,6 +26,32 @@ $ cat ~/.config/mesonwrap.ini
github_token = <github token>
```
+## Setting up the review tooling
+
+The [Mesonwrap](https://github.com/mesonbuild/mesonwrap/) repository
+contains review tooling. It is used to do the actual review, but
+submitters can also use it to check their MRs. All issues reported by
+the tool must be fixed, so using the tool can speed up the review
+process considerably.
+
+The tool has some dependencies that are not available in all Linux
+distributions. Thus using a Python
+[Virtualenv](https://virtualenv.pypa.io/en/stable/). The tool can be
+installed with the following commands.
+
+```
+git clone https://github.com/mesonbuild/mesonwrap.git
+cd mesonwrap
+python3 -m venv venv
+bash
+source venv/bin/activate
+pip install -r requirements.txt
+# You may need to install Meson and Ninja here as well depending on your setup
+python3 setup.py install
+mesonwrap review <see arguments below>
+exit <when you are finished>
+```
+
## Reviewing code
```