From e92be556100c88a4938f3f08ab846b392188980f Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Tue, 15 Oct 2024 19:25:54 -0400 Subject: [PATCH] docs: Update generated markdown 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 | 2 +- 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 | 2 +- docs/src/man/bootc-install.md | 4 ++-- docs/src/man/bootc-rollback.md | 2 +- docs/src/man/bootc-status.md | 6 +++--- docs/src/man/bootc-switch.md | 4 ++-- docs/src/man/bootc-upgrade.md | 2 +- docs/src/man/bootc-usr-overlay.md | 8 ++++---- docs/src/man/bootc.md | 2 +- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/src/man/bootc-container-lint.md b/docs/src/man/bootc-container-lint.md index 8c57c0c8b..d0d290ed6 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.16 +v1.1.0 diff --git a/docs/src/man/bootc-container.md b/docs/src/man/bootc-container.md index b348b7c2f..b7a3516de 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.16 +v1.1.0 diff --git a/docs/src/man/bootc-edit.md b/docs/src/man/bootc-edit.md index 003735a70..7f3816b4f 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.16 +v1.1.0 diff --git a/docs/src/man/bootc-install-print-configuration.md b/docs/src/man/bootc-install-print-configuration.md index 999b10b57..4387e155d 100644 --- a/docs/src/man/bootc-install-print-configuration.md +++ b/docs/src/man/bootc-install-print-configuration.md @@ -27,4 +27,4 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`. # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-install-to-disk.md b/docs/src/man/bootc-install-to-disk.md index e268668b8..051c3ce78 100644 --- a/docs/src/man/bootc-install-to-disk.md +++ b/docs/src/man/bootc-install-to-disk.md @@ -149,4 +149,4 @@ firmware will be skipped # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-install-to-existing-root.md b/docs/src/man/bootc-install-to-existing-root.md index eefe553eb..b9fe45e1c 100644 --- a/docs/src/man/bootc-install-to-existing-root.md +++ b/docs/src/man/bootc-install-to-existing-root.md @@ -134,4 +134,4 @@ firmware will be skipped # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-install-to-filesystem.md b/docs/src/man/bootc-install-to-filesystem.md index 6f9a181da..04c2eadf9 100644 --- a/docs/src/man/bootc-install-to-filesystem.md +++ b/docs/src/man/bootc-install-to-filesystem.md @@ -161,4 +161,4 @@ mounting. To override this, use \`\--root-mount-spec\`. # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-install.md b/docs/src/man/bootc-install.md index e71405b97..089ae2bab 100644 --- a/docs/src/man/bootc-install.md +++ b/docs/src/man/bootc-install.md @@ -10,7 +10,7 @@ bootc-install - Install the running container to a target Install the running container to a target. -## Understanding installations +\## Understanding installations OCI containers are effectively layers of tarballs with JSON for metadata; they cannot be booted directly. The \`bootc install\` flow is @@ -61,4 +61,4 @@ bootc-install-help(8) # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-rollback.md b/docs/src/man/bootc-rollback.md index 822008e5a..eea1e887b 100644 --- a/docs/src/man/bootc-rollback.md +++ b/docs/src/man/bootc-rollback.md @@ -34,4 +34,4 @@ rollback invocation. # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-status.md b/docs/src/man/bootc-status.md index ca196e836..215f38151 100644 --- a/docs/src/man/bootc-status.md +++ b/docs/src/man/bootc-status.md @@ -16,13 +16,13 @@ bootc system state. If standard output is not a terminal, output a YAML-formatted object using a schema intended to match a Kubernetes resource that describes the state of the booted system. -## Parsing output via programs +\## Parsing output via programs Either the default YAML format or \`\--format=json\` can be used. Do not attempt to explicitly parse the output of \`\--format=humanreadable\` as it will very likely change over time. -## Programmatically detecting whether the system is deployed via bootc +\## Programmatically detecting whether the system is deployed via bootc Invoke e.g. \`bootc status \--json\`, and check if \`status.booted\` is not \`null\`. @@ -59,4 +59,4 @@ not \`null\`. # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-switch.md b/docs/src/man/bootc-switch.md index 6e29107e0..432d902e6 100644 --- a/docs/src/man/bootc-switch.md +++ b/docs/src/man/bootc-switch.md @@ -15,7 +15,7 @@ Target a new container image reference to boot. This is almost exactly the same operation as \`upgrade\`, but additionally changes the container image reference instead. -## Usage +\## Usage A common pattern is to have a management agent control operating system updates via container image tags; for example, @@ -69,4 +69,4 @@ includes a default policy which requires signatures. # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc-upgrade.md b/docs/src/man/bootc-upgrade.md index 0b2fe2a10..c5b5efb17 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.16 +v1.1.0 diff --git a/docs/src/man/bootc-usr-overlay.md b/docs/src/man/bootc-usr-overlay.md index 990a46418..075ba050b 100644 --- a/docs/src/man/bootc-usr-overlay.md +++ b/docs/src/man/bootc-usr-overlay.md @@ -12,20 +12,20 @@ will be discarded on reboot Adds a transient writable overlayfs on \`/usr\` that will be discarded on reboot. -## Use cases +\## Use cases A common pattern is wanting to use tracing/debugging tools, such as \`strace\` that may not be in the base image. A system package manager such as \`apt\` or \`dnf\` can apply changes into this transient overlay that will be discarded on reboot. -## /etc and /var +\## /etc and /var However, this command has no effect on \`/etc\` and \`/var\` - changes written there will persist. It is common for package installations to modify these directories. -## Unmounting +\## Unmounting Almost always, a system process will hold a reference to the open mount point. You can however invoke \`umount -l /usr\` to perform a \"lazy @@ -39,4 +39,4 @@ unmount\". # VERSION -v0.1.16 +v1.1.0 diff --git a/docs/src/man/bootc.md b/docs/src/man/bootc.md index 69f312f9b..07a32e328 100644 --- a/docs/src/man/bootc.md +++ b/docs/src/man/bootc.md @@ -72,4 +72,4 @@ bootc-help(8) # VERSION -v0.1.16 +v1.1.0