tree-wide: Use "mkosi box" instead of "mkosi sandbox"

The box verb was added as a synonym for sandbox. sandbox still works,
but let's switch to box as it's shorter.
This commit is contained in:
DaanDeMeyer
2025-07-10 16:23:26 +02:00
parent a4488ae6ae
commit 7f76ff2821
7 changed files with 45 additions and 45 deletions

View File

@@ -40,16 +40,16 @@ Then, you can build, run and test systemd executables as follows:
```sh
$ mkosi -f genkey # Generate signing keys once.
$ mkosi -f sandbox -- meson setup -Dbpf-framework=disabled build # bpftool detection inside mkosi sandbox is broken on Ubuntu Noble and older
$ mkosi -f sandbox -- meson compile -C build
$ mkosi -f sandbox -- build/systemctl --version
$ mkosi -f sandbox -- meson test -C build # Run the unit tests
$ mkosi -f box -- meson setup -Dbpf-framework=disabled build # bpftool detection inside mkosi box is broken on Ubuntu Noble and older
$ mkosi -f box -- meson compile -C build
$ mkosi -f box -- build/systemctl --version
$ mkosi -f box -- meson test -C build # Run the unit tests
```
To build and boot an OS image with the latest systemd installed:
```sh
$ mkosi -f sandbox -- meson compile -C build mkosi # (re-)build the OS image
$ mkosi -f box -- meson compile -C build mkosi # (re-)build the OS image
$ mkosi boot # Boot the image with systemd-nspawn.
$ mkosi vm # Boot the image with qemu.
```
@@ -65,8 +65,8 @@ $ cd systemd
$ git checkout -b <BRANCH> # where BRANCH is the name of the branch
$ $EDITOR src/core/main.c # or wherever you'd like to make your changes
$ mkosi -f genkey # Generate signing keys once.
$ mkosi -f sandbox -- meson setup build # Set up meson
$ mkosi -f sandbox -- meson compile -C build mkosi # (re-)build the test image
$ mkosi -f box -- meson setup build # Set up meson
$ mkosi -f box -- meson compile -C build mkosi # (re-)build the test image
$ mkosi vm # Boot the image in qemu
$ git add -p # interactively put together your patch
$ git commit # commit it
@@ -85,7 +85,7 @@ not required to write basic patches.
## Building the OS image without a tools tree
By default, `mkosi` will first build a tools tree and use it build the image and
provide the environment for `mkosi sandbox`. To disable the tools tree and use
provide the environment for `mkosi box`. To disable the tools tree and use
binaries from your host instead, write the following to `mkosi/mkosi.local.conf`:
```conf
@@ -311,7 +311,7 @@ To debug systemd-boot in an IDE such as VSCode we can use a launch configuration
right in your editor of choice (with the right plugin installed). When using mkosi, we can run clangd in the
mkosi tools tree to avoid needing to install clangd on the host machine.
All that is required is to run `mkosi -f sandbox true` once to make sure the tools tree is available and to modify
All that is required is to run `mkosi -f box true` once to make sure the tools tree is available and to modify
the path of the clangd binary used by your editor to the `mkosi.clangd` script included in the systemd repository.
For example, for VScode, you'd have to add the following to the VSCode workspace settings of the systemd repository:
@@ -329,7 +329,7 @@ When using clangd, it's recommended to setup the build directory containing the
compilation database used by clangd to use clang as the compiler as well:
```sh
$ mkosi sandbox -- env CC=clang CXX=clang++ meson setup build
$ mkosi box -- env CC=clang CXX=clang++ meson setup build
```
Additionally, the `gensources` target can be used to make sure all generated
@@ -337,5 +337,5 @@ sources are generated to avoid clangd complaining that these source files don't
exist.
```sh
$ mkosi sandbox -- ninja -C build gensources
$ mkosi box -- ninja -C build gensources
```