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.

Signed-off-by: Michael Vogt <[email protected]>
Signed-off-by: Colin Walters <[email protected]>
  • Loading branch information
mvo5 authored and cgwalters committed Mar 18, 2024
1 parent 3ae0047 commit 8687270
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 4 deletions.
4 changes: 3 additions & 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,9 @@ disabled but where the target does have SELinux enabled.

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

: Add a kernel argument
: Add a kernel argument. This option can be provided multiple times.

Example: \--karg=nosmt \--karg=console=ttyS0,114800n8

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

Expand Down
4 changes: 3 additions & 1 deletion docs/src/man/bootc-install-to-existing-root.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ disabled but where the target does have SELinux enabled.

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

: Add a kernel argument
: Add a kernel argument. This option can be provided multiple times.

Example: \--karg=nosmt \--karg=console=ttyS0,114800n8

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

Expand Down
4 changes: 3 additions & 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,9 @@ disabled but where the target does have SELinux enabled.

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

: Add a kernel argument
: Add a kernel argument. This option can be provided multiple times.

Example: \--karg=nosmt \--karg=console=ttyS0,114800n8

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

Expand Down
4 changes: 3 additions & 1 deletion lib/src/install.rs
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,10 @@ pub(crate) struct InstallConfigOpts {
#[serde(default)]
pub(crate) disable_selinux: bool,

/// Add a kernel argument. This option can be provided multiple times.
///
/// Example: --karg=nosmt --karg=console=ttyS0,114800n8
#[clap(long)]
/// Add a kernel argument
karg: Option<Vec<String>>,

/// The path to an `authorized_keys` that will be injected into the `root` account.
Expand Down

0 comments on commit 8687270

Please sign in to comment.