diff options
author | Lennart Poettering <lennart@poettering.net> | 2020-12-11 11:33:39 +0100 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2020-12-17 16:51:48 +0100 |
commit | 8b08be4052fa51a9ad0de8a6f9213efe4dac213d (patch) | |
tree | 710fb0a1db155393094eccd9fda1eca13eea9b0f /docs/CODE_QUALITY.md | |
parent | 68f18549c551d677d97ebd18d27827e1613a06a7 (diff) | |
download | systemd-8b08be4052fa51a9ad0de8a6f9213efe4dac213d.tar.gz |
tree-wide: suggest meson command lines instead of ninja ones
This only changes documentation. In various places we call "ninja"
directly. I figured it would be safer to leave those in place for now,
given the meson replacement commands lines appears to be supported in
newer meson versions only.
Diffstat (limited to 'docs/CODE_QUALITY.md')
-rw-r--r-- | docs/CODE_QUALITY.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/docs/CODE_QUALITY.md b/docs/CODE_QUALITY.md index a724d663f6..a59912a676 100644 --- a/docs/CODE_QUALITY.md +++ b/docs/CODE_QUALITY.md @@ -10,13 +10,15 @@ The systemd project has a number of code quality tools set up in the source tree and on the github infrastructure. Here's an incomprehensive list of the available functionality: -1. Use `ninja -C build test` to run the unit tests. Some tests are skipped if +1. Use `meson test -C build` to run the unit tests. Some tests are skipped if no privileges are available, hence consider also running them with `sudo - ninja -C build test`. A couple of unit tests are considered "unsafe" (as - they change system state); to run those too, build with `meson + meson test -C build`. A couple of unit tests are considered "unsafe" (as + they change system state); to run those too, build with `meson setup -Dtests=unsafe`. Finally, some unit tests are considered to be very slow, - build them too with `meson -Dslow-tests=true`. (Note that there are a couple - of manual tests in addition to these unit tests.) + build them too with `meson setup -Dslow-tests=true`. (Note that there are a + couple of manual tests in addition to these unit tests.) (Also note: you can + change these flags for an already set up build tree, too, with "meson + configure -C build -D…".) 2. Use `./test/run-integration-tests.sh` to run the full integration test suite. This will build OS images with a number of integration tests and run @@ -35,14 +37,14 @@ available functionality: `./tools/find-tabs.sh recpatch` to fix them. (Again, grain of salt, foreign headers should usually be left unmodified.) -6. Use `ninja -C build check-api-docs` to compare the list of exported +6. Use `meson compile -C build check-api-docs` to compare the list of exported symbols of `libsystemd.so` and `libudev.so` with the list of man pages. Symbols lacking documentation are highlighted. -7. Use `ninja -C build hwdb-update` to automatically download and import the +7. Use `meson compile -C build hwdb-update` to automatically download and import the PCI, USB and OUI databases into hwdb. -8. Use `ninja -C build man/update-man-rules` to update the meson rules for +8. Use `meson compile -C build man/update-man-rules` to update the meson rules for building man pages automatically from the docbook XML files included in `man/`. |