mirror of
https://github.com/systemd/systemd
synced 2025-09-28 16:24:45 +02:00
Compare commits
5 Commits
664e54b1bb
...
4a5fc0e61f
Author | SHA1 | Date | |
---|---|---|---|
![]() |
4a5fc0e61f | ||
![]() |
c38667f70d | ||
![]() |
4cc06b8073 | ||
![]() |
e607710e5d | ||
![]() |
3b5606d95d |
116
docs/HACKING.md
116
docs/HACKING.md
@ -44,28 +44,37 @@ generate a disk image `image.raw` you can boot either in `systemd-nspawn` or in
|
||||
an UEFI-capable VM:
|
||||
|
||||
```
|
||||
# systemd-nspawn -bi image.raw
|
||||
# mkosi boot
|
||||
```
|
||||
|
||||
or:
|
||||
|
||||
```
|
||||
# qemu-system-x86_64 -enable-kvm -m 512 -smp 2 -bios /usr/share/edk2/ovmf/OVMF_CODE.fd -hda image.raw
|
||||
# mkosi qemu
|
||||
```
|
||||
|
||||
Every time you rerun the `mkosi` command a fresh image is built, incorporating
|
||||
all current changes you made to the project tree.
|
||||
all current changes you made to the project tree. To save time when rebuilding,
|
||||
you can use mkosi's incremental mode (`-i`). This instructs mkosi to build a set
|
||||
of cache images that make future builds a lot faster. Note that the `-i` flag
|
||||
both instructs mkosi to build cached images if they don't exist yet and to use
|
||||
cached images if they already exist so make sure to always specify `-i` if you
|
||||
want mkosi to use the cached images.
|
||||
|
||||
Alternatively, you may install the systemd version from your git check-out
|
||||
directly on top of your host system's directory tree. This mostly works fine,
|
||||
but of course you should know what you are doing as you might make your system
|
||||
unbootable in case of a bug in your changes. Also, you might step into your
|
||||
package manager's territory with this. Be careful!
|
||||
If you're going to build mkosi images that use the same distribution and release
|
||||
that you're currently using, you can speed up the initial mkosi run by having it
|
||||
reuse the host's package cache. To do this, create a mkosi override file in
|
||||
mkosi.default.d/ (e.g 20-local.conf) and add the following contents:
|
||||
|
||||
And never forget: most distributions provide very simple and convenient ways to
|
||||
install all development packages necessary to build systemd. For example, on
|
||||
Fedora the following command line should be sufficient to install all of
|
||||
systemd's build dependencies:
|
||||
```
|
||||
[Packages]
|
||||
Cache=<full-path-to-package-manager-cache> # (e.g. /var/cache/dnf)
|
||||
```
|
||||
|
||||
If you want to do a local build without mkosi, most distributions also provide
|
||||
very simple and convenient ways to install all development packages necessary
|
||||
to build systemd. For example, on Fedora the following command line should be
|
||||
sufficient to install all of systemd's build dependencies:
|
||||
|
||||
```
|
||||
# dnf builddep systemd
|
||||
@ -84,9 +93,8 @@ $ 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
|
||||
$ ln -s .mkosi/mkosi.fedora mkosi.default # Configure mkosi to build a fedora image
|
||||
$ (umask 077; echo 123 > mkosi.rootpw) # set root password used by mkosi
|
||||
$ sudo mkosi # build a test image
|
||||
$ sudo systemd-nspawn -bi image.raw # boot up the test image
|
||||
$ sudo mkosi boot # boot up the test image
|
||||
$ git add -p # interactively put together your patch
|
||||
$ git commit # commit it
|
||||
$ git push REMOTE HEAD:refs/heads/BRANCH
|
||||
@ -136,3 +144,83 @@ For more details on building fuzzers and integrating with OSS-Fuzz, visit:
|
||||
|
||||
- [Setting up a new project - OSS-Fuzz](https://google.github.io/oss-fuzz/getting-started/new-project-guide/)
|
||||
- [Tutorials - OSS-Fuzz](https://google.github.io/oss-fuzz/reference/useful-links/#tutorials)
|
||||
|
||||
## mkosi + clangd
|
||||
|
||||
[clangd](https://clangd.llvm.org/) is a language server that provides code completion, diagnostics and more
|
||||
right in your editor of choice (with the right plugin installed). When using mkosi, we can run clangd in the
|
||||
mkosi build container to avoid needing to build systemd on the host machine just to make clangd work. To
|
||||
achieve this, create a script with the following contents in systemd's project directory on the host:
|
||||
|
||||
```sh
|
||||
#!/usr/bin/env sh
|
||||
tee mkosi-clangd.build > /dev/null << EOF
|
||||
#!/usr/bin/env sh
|
||||
exec clangd \\
|
||||
--compile-commands-dir=/root/build \\
|
||||
--path-mappings=\\
|
||||
"\\
|
||||
$(pwd)=/root/src,\\
|
||||
$(pwd)/mkosi.builddir=/root/build,\\
|
||||
$(pwd)/mkosi.includedir=/usr/include,\\
|
||||
$(pwd)/mkosi.installdir=/root/dest\\
|
||||
" \\
|
||||
--header-insertion=never
|
||||
EOF
|
||||
chmod +x mkosi-clangd.build
|
||||
exec sudo mkosi --source-file-transfer=mount --incremental --skip-final-phase --build-script mkosi-clangd.build build
|
||||
```
|
||||
|
||||
Next, mark the script as executable and point your editor plugin to use this script to start clangd. For
|
||||
vscode's clangd extension, this is done via setting the `clangd.path` option to the path of the
|
||||
mkosi-clangd.sh script.
|
||||
|
||||
To be able to navigate to include files of systemd's dependencies, we need to make the /usr/include folder of
|
||||
the build image available on the host. mkosi supports this by setting the `IncludeDirectory` option in
|
||||
mkosi's config. The easiest way to set the option is to create a file 20-local.conf in mkosi.default.d/ and
|
||||
add the following contents:
|
||||
|
||||
```
|
||||
[Packages]
|
||||
IncludeDirectory=mkosi.includedir
|
||||
```
|
||||
|
||||
This will make the contents of /usr/include available in mkosi.includedir in the systemd project directory.
|
||||
We already configured clangd to map any paths in /usr/include in the build image to mkosi.includedir/ on the
|
||||
host in the mkosi-clangd.sh script.
|
||||
|
||||
We also need to make sure clangd is installed in the build image. To have mkosi install clangd in the build
|
||||
image, edit the 20-local.conf file we created earlier and add the following contents under the `[Packages]`
|
||||
section:
|
||||
|
||||
```
|
||||
BuildPackages=<clangd-package>
|
||||
```
|
||||
|
||||
Note that the exact package containing clangd will differ depending on the distribution used. Some
|
||||
distributions have a separate clangd package, others put the clangd binary in a clang-tools-extra package and
|
||||
some bundle clangd in the clang package.
|
||||
|
||||
Because mkosi needs to run as root, we also need to make sure we can enter the root password when the editor
|
||||
plugin tries to run the mkosi-clangd.sh script. To be able to enter the root password in non-interactive
|
||||
scripts, we use an askpass provider. This is a program that sudo will launch if it detects it's being
|
||||
executed from a non-interactive shell so that the root password can still be entered. There are multiple
|
||||
implementations such as gnome askpass and KDE askpass. Install one of the askpass packages your distro
|
||||
provides and set the `SUDO_ASKPASS` environment variable to the path of the askpass binary you want to use.
|
||||
If configured correctly, a window will appear when your editor plugin tries to run the mkosi-clangd.sh script
|
||||
allowing you to enter the root password.
|
||||
|
||||
Due to a bug in btrfs, it's currently impossible to mount two mkosi btrfs images at the same time. Because of
|
||||
this, trying to do a regular build while the clangd image is running will fail. To circumvent this, use ext4
|
||||
instead of btrfs for the images by adding the following contents to 20-local.conf:
|
||||
|
||||
```
|
||||
[Output]
|
||||
Format=gpt_ext4
|
||||
```
|
||||
|
||||
Finally, to ensure clangd starts up quickly in the editor, run an incremental build with mkosi to make sure
|
||||
the cached images are initialized (`mkosi -i`).
|
||||
|
||||
Now, your editor will start clangd in the mkosi build image and all of clangd's features will work as
|
||||
expected.
|
||||
|
@ -324,6 +324,12 @@ sensor:modalias:acpi:BOSC0200*:dmi:*:svnDigma:pnCITIE203ES2010EW:*
|
||||
sensor:modalias:acpi:ACCE0001*:dmi:*svnEndless*:*pnELT-NL3:*
|
||||
ACCEL_MOUNT_MATRIX=0, 1, 0; 0, 0, -1; -1, 0, 0
|
||||
|
||||
#########################################
|
||||
# Estar
|
||||
#########################################
|
||||
sensor:modalias:acpi:SMO8500*:dmi:*:svnEstar:pneSTARBEAUTYHDIntelQuadcore:*
|
||||
ACCEL_MOUNT_MATRIX=1, 0, 0; 0, -1, 0; 0, 0, 1
|
||||
|
||||
#########################################
|
||||
# Eve Technology
|
||||
#########################################
|
||||
@ -448,6 +454,10 @@ sensor:modalias:acpi:BOSC0200*:dmi:bvnINSYDECorp.:bvrjumperx.T87.KFBNEE:*
|
||||
sensor:modalias:acpi:BOSC0200*:dmi:*:svnJumper:pnEZpad:*:rvr.A006:*
|
||||
ACCEL_MOUNT_MATRIX=-1, 0, 0; 0, -1, 0; 0, 0, 1
|
||||
|
||||
# EZpad 7
|
||||
sensor:modalias:acpi:KIOX0009*:dmi:*:bvrJumper12x.WJ2012.bsBKRCP*:svnJumper:pnEZpad:*
|
||||
ACCEL_MOUNT_MATRIX=-1, 0, 0; 0, 1, 0; 0, 0, 1
|
||||
|
||||
# EZpad Go
|
||||
sensor:modalias:acpi:KIOX000A*:dmi:bvnAmericanMegatrendsInc.:*:svnjumper:pnEZpad:*:ct31:*
|
||||
ACCEL_MOUNT_MATRIX=1, 0, 0; 0, -1, 0; 0, 0, 1
|
||||
|
Loading…
x
Reference in New Issue
Block a user