Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

install: Clarify /boot (optional) and root mount spec #635

Merged
merged 2 commits into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/man/bootc-container-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ part of a build process; it will error if any problems are detected.

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ bootc-container-help(8)

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Only changes to the \`spec\` section are honored.

# VERSION

v0.1.11
v0.1.12
9 changes: 5 additions & 4 deletions docs/src/man/bootc-install-print-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

bootc-install-print-configuration - Output JSON to stdout that contains
the merged installation configuration as it may be relevant to calling
processes using \`install to-filesystem\` that want to honor e.g.
\`root-fs-type\`
processes using \`install to-filesystem\` that in particular want to
discover the desired root filesystem type from the container image

# SYNOPSIS

Expand All @@ -13,7 +13,8 @@ processes using \`install to-filesystem\` that want to honor e.g.

Output JSON to stdout that contains the merged installation
configuration as it may be relevant to calling processes using \`install
to-filesystem\` that want to honor e.g. \`root-fs-type\`.
to-filesystem\` that in particular want to discover the desired root
filesystem type from the container image.

At the current time, the only output key is \`root-fs-type\` which is a
string-valued filesystem name suitable for passing to \`mkfs.\$type\`.
Expand All @@ -26,4 +27,4 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`.

# VERSION

v0.1.11
v0.1.12
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 @@ -144,4 +144,4 @@ firmware will be skipped

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-install-to-existing-root.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,4 @@ firmware will be skipped

# VERSION

v0.1.11
v0.1.12
9 changes: 5 additions & 4 deletions docs/src/man/bootc-install-to-filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,14 @@ is currently expected to be empty by default.
: Source device specification for the root filesystem. For example,
UUID=2e9f4241-229b-4202-8429-62d2302382e1

If not provided, the UUID of the target filesystem will be used.

**\--boot-mount-spec**=*BOOT_MOUNT_SPEC*

: Mount specification for the /boot filesystem.

At the current time, a separate /boot is required. This restriction will
be lifted in future versions. If not specified, the filesystem UUID will
be used.
This is optional. If \`/boot\` is detected as a mounted partition, then
its UUID will be used.

**\--replace**=*REPLACE*

Expand Down Expand Up @@ -156,4 +157,4 @@ mounting. To override this, use \`\--root-mount-spec\`.

# VERSION

v0.1.11
v0.1.12
5 changes: 3 additions & 2 deletions docs/src/man/bootc-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,13 @@ bootc-install-print-configuration(8)

: Output JSON to stdout that contains the merged installation
configuration as it may be relevant to calling processes using
\`install to-filesystem\` that want to honor e.g. \`root-fs-type\`
\`install to-filesystem\` that in particular want to discover the
desired root filesystem type from the container image

bootc-install-help(8)

: Print this message or the help of the given subcommand(s)

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-rollback.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ rollback invocation.

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ The exact API format is not currently declared stable.

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ includes a default policy which requires signatures.

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ userspace-only restart.

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc-usr-overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ unmount\".

# VERSION

v0.1.11
v0.1.12
2 changes: 1 addition & 1 deletion docs/src/man/bootc.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ bootc-help(8)

# VERSION

v0.1.11
v0.1.12
6 changes: 4 additions & 2 deletions lib/src/install.rs
Original file line number Diff line number Diff line change
Expand Up @@ -217,13 +217,15 @@ pub(crate) struct InstallTargetFilesystemOpts {
pub(crate) root_path: Utf8PathBuf,

/// Source device specification for the root filesystem. For example, UUID=2e9f4241-229b-4202-8429-62d2302382e1
///
/// If not provided, the UUID of the target filesystem will be used.
#[clap(long)]
pub(crate) root_mount_spec: Option<String>,

/// Mount specification for the /boot filesystem.
///
/// At the current time, a separate /boot is required. This restriction will be lifted in
/// future versions. If not specified, the filesystem UUID will be used.
/// This is optional. If `/boot` is detected as a mounted partition, then
/// its UUID will be used.
#[clap(long)]
pub(crate) boot_mount_spec: Option<String>,

Expand Down
Loading