diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CODE_QUALITY.md | 17 | ||||
| -rw-r--r-- | docs/HACKING.md | 20 | ||||
| -rw-r--r-- | docs/RELEASE.md | 10 | ||||
| -rw-r--r-- | docs/TRANSLATORS.md | 6 |
4 files changed, 27 insertions, 26 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 diff --git a/docs/HACKING.md b/docs/HACKING.md index 4b334715c7..f6b42297e0 100644 --- a/docs/HACKING.md +++ b/docs/HACKING.md @@ -95,16 +95,16 @@ for systemd: # available there or from the github repository otherwise) $ git clone https://github.com/systemd/systemd.git $ cd systemd -$ git checkout -b <BRANCH> # where BRANCH is the name of the branch -$ vim src/core/main.c # or wherever you'd like to make your changes -$ meson build # configure the build -$ meson compile -C build # build it locally, see if everything compiles fine -$ meson test -C build # run some simple regression tests -$ sudo mkosi # build a test image -$ sudo mkosi boot # boot up the test image -$ git add -p # interactively put together your patch -$ git commit # commit it -$ git push -u <REMOTE> # where REMOTE is your "fork" on GitHub +$ git checkout -b <BRANCH> # where BRANCH is the name of the branch +$ vim src/core/main.c # or wherever you'd like to make your changes +$ meson build # configure the build +$ ninja -C build # build it locally, see if everything compiles fine +$ meson test -C build # run some simple regression tests +$ sudo mkosi # build a test image +$ sudo mkosi boot # boot up the test image +$ git add -p # interactively put together your patch +$ git commit # commit it +$ git push -u <REMOTE> # where REMOTE is your "fork" on GitHub ``` And after that, head over to your repo on GitHub and click "Compare & pull request" diff --git a/docs/RELEASE.md b/docs/RELEASE.md index c5da09b62c..a5ab146f28 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -8,15 +8,15 @@ SPDX-License-Identifier: LGPL-2.1-or-later # Steps to a Successful Release 1. Add all items to NEWS -2. Update the contributors list in NEWS (`meson compile -C build git-contrib`) +2. Update the contributors list in NEWS (`ninja -C build git-contrib`) 3. Update the time and place in NEWS -4. Update hwdb (`meson compile -C build update-hwdb update-hwdb-autosuspend`) +4. Update hwdb (`ninja -C build update-hwdb update-hwdb-autosuspend`) 5. [RC1] Update version and library numbers in `meson.build` -6. Check dbus docs with `meson compile -C build update-dbus-docs` +6. Check dbus docs with `ninja -C build update-dbus-docs` 7. Tag the release: `version=vXXX-rcY && git tag -s "${version}" -m "systemd ${version}"` -8. Do `meson compile -C build` +8. Do `ninja -C build` 9. Make sure that the version string and package string match: `build/systemctl --version` -10. Upload the documentation: `meson compile -C build doc-sync` +10. Upload the documentation: `ninja -C build doc-sync` 11. [FINAL] Close the github milestone and open a new one (https://github.com/systemd/systemd/milestones) 12. "Draft" a new release on github (https://github.com/systemd/systemd/releases/new), mark "This is a pre-release" if appropriate. 13. Check that announcement to systemd-devel, with a copy&paste from NEWS, was sent. This should happen automatically. diff --git a/docs/TRANSLATORS.md b/docs/TRANSLATORS.md index 135f35793b..58708bcd58 100644 --- a/docs/TRANSLATORS.md +++ b/docs/TRANSLATORS.md @@ -27,7 +27,7 @@ To create a translation to a language not yet available, start by creating the initial template: ``` -$ meson compile -C build/ systemd-pot +$ ninja -C build/ systemd-pot ``` This will generate file `po/systemd.pot` in the source tree. @@ -51,7 +51,7 @@ using the `poedit` GUI editor.) Start by updating the `*.po` files from the latest template: ``` -$ meson compile -C build/ systemd-update-po +$ ninja -C build/ systemd-update-po ``` This will touch all the `*.po` files, so you'll want to pay attention when @@ -75,7 +75,7 @@ using `git checkout -- po/` after you commit the changes you do want to keep.) You can recompile the `*.po` files using the following command: ``` -$ meson compile -C build/ systemd-gmo +$ ninja -C build/ systemd-gmo ``` The resulting files will be saved in the `build/po/` directory. |