Skip to content

Commit

Permalink
docs: clarify that --karg can be passed multiple times
Browse files Browse the repository at this point in the history
It is not clear from the current man-page that `--karg` can be
passed multiple times. From reading the code it seems to be the
case but because it's not obvious (to me) I also added a small
testcase to the CI to ensure that I'm not misreading things.

I added a small comment to the docs that it can be given
multiple times.
  • Loading branch information
mvo5 committed Mar 14, 2024
1 parent b809bcf commit 750c745
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,10 @@ jobs:
echo 'ssh-ed25519 ABC0123 [email protected]' > test_authorized_keys
sudo podman run --rm -ti --privileged -v ./test_authorized_keys:/test_authorized_keys --env RUST_LOG=debug -v /:/target -v /var/lib/containers:/var/lib/containers -v ./usr/bin/bootc:/usr/bin/bootc --pid=host --security-opt label=disable \
quay.io/centos-bootc/centos-bootc-dev:stream9 bootc install to-filesystem \
--karg=foo=bar --disable-selinux --replace=alongside --root-ssh-authorized-keys=/test_authorized_keys /target
--karg=foo=bar --karg=baz=foobar --disable-selinux --replace=alongside --root-ssh-authorized-keys=/test_authorized_keys /target
ls -al /boot/loader/
sudo grep foo=bar /boot/loader/entries/*.conf
sudo grep baz=foobar /boot/loader/entries/*.conf
grep authorized_keys /ostree/deploy/default/deploy/*/etc/tmpfiles.d/bootc-root-ssh.conf
# TODO fix https://github.com/containers/bootc/pull/137
sudo chattr -i /ostree/deploy/default/deploy/*
Expand Down
2 changes: 1 addition & 1 deletion docs/src/man/bootc-install-to-disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ disabled but where the target does have SELinux enabled.

**\--karg**=*KARG*

: Add a kernel argument
: Add a kernel argument (can be given multiple times)

**\--root-ssh-authorized-keys**=*ROOT_SSH_AUTHORIZED_KEYS*

Expand Down
2 changes: 1 addition & 1 deletion docs/src/man/bootc-install-to-filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ disabled but where the target does have SELinux enabled.

**\--karg**=*KARG*

: Add a kernel argument
: Add a kernel argument (can be given multiple times)

**\--root-ssh-authorized-keys**=*ROOT_SSH_AUTHORIZED_KEYS*

Expand Down

0 comments on commit 750c745

Please sign in to comment.