From ff4078474511c56ae0942eb184135368cdd9b975 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Sun, 23 Jun 2024 16:21:53 -0400 Subject: [PATCH 1/2] install: Clarify /boot (optional) and root mount spec - /boot has been optional for a while - Clarify the root uuid Signed-off-by: Colin Walters --- lib/src/install.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/src/install.rs b/lib/src/install.rs index bae4664f1..f0b1751ee 100644 --- a/lib/src/install.rs +++ b/lib/src/install.rs @@ -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, /// 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, From 21d57eb2e2c086abe7f2624e6430e305e59238d6 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Mon, 24 Jun 2024 16:55:10 -0400 Subject: [PATCH 2/2] docs: Regenerate markdown Pick up change in the previous commit, plus a few others. Signed-off-by: Colin Walters --- docs/src/man/bootc-container-lint.md | 2 +- docs/src/man/bootc-container.md | 2 +- docs/src/man/bootc-edit.md | 2 +- docs/src/man/bootc-install-print-configuration.md | 9 +++++---- docs/src/man/bootc-install-to-disk.md | 2 +- docs/src/man/bootc-install-to-existing-root.md | 2 +- docs/src/man/bootc-install-to-filesystem.md | 9 +++++---- docs/src/man/bootc-install.md | 5 +++-- docs/src/man/bootc-rollback.md | 2 +- docs/src/man/bootc-status.md | 2 +- docs/src/man/bootc-switch.md | 2 +- docs/src/man/bootc-upgrade.md | 2 +- docs/src/man/bootc-usr-overlay.md | 2 +- docs/src/man/bootc.md | 2 +- 14 files changed, 24 insertions(+), 21 deletions(-) diff --git a/docs/src/man/bootc-container-lint.md b/docs/src/man/bootc-container-lint.md index b9b798054..ec08a6b2a 100644 --- a/docs/src/man/bootc-container-lint.md +++ b/docs/src/man/bootc-container-lint.md @@ -23,4 +23,4 @@ part of a build process; it will error if any problems are detected. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-container.md b/docs/src/man/bootc-container.md index 5fdde1803..afab846ed 100644 --- a/docs/src/man/bootc-container.md +++ b/docs/src/man/bootc-container.md @@ -30,4 +30,4 @@ bootc-container-help(8) # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-edit.md b/docs/src/man/bootc-edit.md index 2d2bb4867..5f791e86d 100644 --- a/docs/src/man/bootc-edit.md +++ b/docs/src/man/bootc-edit.md @@ -36,4 +36,4 @@ Only changes to the \`spec\` section are honored. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-install-print-configuration.md b/docs/src/man/bootc-install-print-configuration.md index db6da67df..092cf041e 100644 --- a/docs/src/man/bootc-install-print-configuration.md +++ b/docs/src/man/bootc-install-print-configuration.md @@ -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 @@ -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\`. @@ -26,4 +27,4 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-install-to-disk.md b/docs/src/man/bootc-install-to-disk.md index 389577ffe..20e872632 100644 --- a/docs/src/man/bootc-install-to-disk.md +++ b/docs/src/man/bootc-install-to-disk.md @@ -144,4 +144,4 @@ firmware will be skipped # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-install-to-existing-root.md b/docs/src/man/bootc-install-to-existing-root.md index 17c6745ef..46e8375f1 100644 --- a/docs/src/man/bootc-install-to-existing-root.md +++ b/docs/src/man/bootc-install-to-existing-root.md @@ -130,4 +130,4 @@ firmware will be skipped # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-install-to-filesystem.md b/docs/src/man/bootc-install-to-filesystem.md index ad58f2d5c..764194164 100644 --- a/docs/src/man/bootc-install-to-filesystem.md +++ b/docs/src/man/bootc-install-to-filesystem.md @@ -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* @@ -156,4 +157,4 @@ mounting. To override this, use \`\--root-mount-spec\`. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-install.md b/docs/src/man/bootc-install.md index 9912134ad..ac2c7cef2 100644 --- a/docs/src/man/bootc-install.md +++ b/docs/src/man/bootc-install.md @@ -52,7 +52,8 @@ 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) @@ -60,4 +61,4 @@ bootc-install-help(8) # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-rollback.md b/docs/src/man/bootc-rollback.md index 42bb53631..5d95b1c08 100644 --- a/docs/src/man/bootc-rollback.md +++ b/docs/src/man/bootc-rollback.md @@ -34,4 +34,4 @@ rollback invocation. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-status.md b/docs/src/man/bootc-status.md index 3cc88e496..f6807ca09 100644 --- a/docs/src/man/bootc-status.md +++ b/docs/src/man/bootc-status.md @@ -33,4 +33,4 @@ The exact API format is not currently declared stable. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-switch.md b/docs/src/man/bootc-switch.md index ebd319e8f..a007c69c0 100644 --- a/docs/src/man/bootc-switch.md +++ b/docs/src/man/bootc-switch.md @@ -61,4 +61,4 @@ includes a default policy which requires signatures. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-upgrade.md b/docs/src/man/bootc-upgrade.md index 908d05f7f..be3cf86a2 100644 --- a/docs/src/man/bootc-upgrade.md +++ b/docs/src/man/bootc-upgrade.md @@ -52,4 +52,4 @@ userspace-only restart. # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc-usr-overlay.md b/docs/src/man/bootc-usr-overlay.md index 07ac8cd24..b50b206bf 100644 --- a/docs/src/man/bootc-usr-overlay.md +++ b/docs/src/man/bootc-usr-overlay.md @@ -39,4 +39,4 @@ unmount\". # VERSION -v0.1.11 +v0.1.12 diff --git a/docs/src/man/bootc.md b/docs/src/man/bootc.md index 22ba55348..618836ccc 100644 --- a/docs/src/man/bootc.md +++ b/docs/src/man/bootc.md @@ -72,4 +72,4 @@ bootc-help(8) # VERSION -v0.1.11 +v0.1.12