Skip to content

Commit c7a9f02

Browse files
mvo5cgwalters
authored andcommitted
docs: clarify that --karg can be passed multiple times
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]>
1 parent bcffa37 commit c7a9f02

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

docs/src/man/bootc-install-to-disk.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ disabled but where the target does have SELinux enabled.
9696

9797
**\--karg**=*KARG*
9898

99-
: Add a kernel argument
99+
: Add a kernel argument. This option can be provided multiple times.
100+
101+
Example: \--karg=nosmt \--karg=console=ttyS0,114800n8
100102

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

docs/src/man/bootc-install-to-existing-root.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,9 @@ disabled but where the target does have SELinux enabled.
8484

8585
**\--karg**=*KARG*
8686

87-
: Add a kernel argument
87+
: Add a kernel argument. This option can be provided multiple times.
88+
89+
Example: \--karg=nosmt \--karg=console=ttyS0,114800n8
8890

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

docs/src/man/bootc-install-to-filesystem.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,9 @@ disabled but where the target does have SELinux enabled.
9898

9999
**\--karg**=*KARG*
100100

101-
: Add a kernel argument
101+
: Add a kernel argument. This option can be provided multiple times.
102+
103+
Example: \--karg=nosmt \--karg=console=ttyS0,114800n8
102104

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

lib/src/install.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,10 @@ pub(crate) struct InstallConfigOpts {
133133
#[serde(default)]
134134
pub(crate) disable_selinux: bool,
135135

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

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

0 commit comments

Comments
 (0)