summaryrefslogtreecommitdiffstats
path: root/docs/CODE_QUALITY.md
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-04-12 12:05:53 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-04-12 12:35:44 +0200
commite8a688178c4875f3b67e5fbc6e56d0487258f535 (patch)
tree5d7959e2578e30ae372db15a883ec1d0c1d9351f /docs/CODE_QUALITY.md
parentman: add page for sd_device_{ref,unref,unrefp} (diff)
downloadsystemd-e8a688178c4875f3b67e5fbc6e56d0487258f535.tar.xz
systemd-e8a688178c4875f3b67e5fbc6e56d0487258f535.zip
docs: stop recommending meson compile
With meson-0.60, meson compile stopped working with some targets: $ meson compile -C build update-man-rules ERROR: Can't invoke target `update-man-rules`: ambiguous name. Add target type and/or path: `PATH/NAME:TYPE` This is obviously a regression in meson, but based on a chat with the maintainers, it seems that there's some disagreement as to whether 'meson compile' is useful and how exactly it should work. Since we're already at meson 0.60.3 and this hasn't been fixed, and people generally don't seem to consider this an issue, let's return to documenting the usual practice of 'ninja -C build' that just works everywhere. (Since nobody has raised any fuss in systemd, it means that people are generally using the shorter form during development too. I only noticed because I pasted a command from the release docs when preparing -rc1.)
Diffstat (limited to 'docs/CODE_QUALITY.md')
-rw-r--r--docs/CODE_QUALITY.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/CODE_QUALITY.md b/docs/CODE_QUALITY.md
index b1f7dd109e..29dfdd8ae0 100644
--- a/docs/CODE_QUALITY.md
+++ b/docs/CODE_QUALITY.md
@@ -38,18 +38,19 @@ available functionality:
`./tools/find-tabs.sh recpatch` to fix them. (Again, grain of salt, foreign
headers should usually be left unmodified.)
-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
+6. Use `ninja -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 `meson compile -C build update-hwdb` to automatically download and import the
- PCI, USB and OUI databases into hwdb.
+7. Use `ninja -C build update-hwdb` and `ninja -C build update-hwdb-autosuspend`
+ to automatically download and import the PCI, USB, and OUI databases and the
+ autosuspend quirks into the hwdb.
-8. Use `meson compile -C build update-man-rules` to update the meson rules for
- building man pages automatically from the docbook XML files included in
- `man/`.
+8. Use `ninja -C build update-man-rules` to update the meson rules for building
+ man pages automatically from the docbook XML files included in `man/`.
-9. There are multiple CI systems in use that run on every github PR submission.
+9. There are multiple CI systems in use that run on every github pull request
+ submission or update.
10. [Coverity](https://scan.coverity.com/) is analyzing systemd `main` branch
in regular intervals. The reports are available