Skip to content

Commit

Permalink
docs: Update generated markdown
Browse files Browse the repository at this point in the history
Signed-off-by: Colin Walters <walters@verbum.org>
  • Loading branch information
cgwalters committed Oct 15, 2024
1 parent 9140bf1 commit e92be55
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 21 deletions.
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.16
v1.1.0
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.16
v1.1.0
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.16
v1.1.0
2 changes: 1 addition & 1 deletion docs/src/man/bootc-install-print-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`.

# VERSION

v0.1.16
v1.1.0
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 @@ -149,4 +149,4 @@ firmware will be skipped

# VERSION

v0.1.16
v1.1.0
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 @@ -134,4 +134,4 @@ firmware will be skipped

# VERSION

v0.1.16
v1.1.0
2 changes: 1 addition & 1 deletion docs/src/man/bootc-install-to-filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,4 +161,4 @@ mounting. To override this, use \`\--root-mount-spec\`.

# VERSION

v0.1.16
v1.1.0
4 changes: 2 additions & 2 deletions docs/src/man/bootc-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -61,4 +61,4 @@ bootc-install-help(8)

# VERSION

v0.1.16
v1.1.0
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.16
v1.1.0
6 changes: 3 additions & 3 deletions docs/src/man/bootc-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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\`.
Expand Down Expand Up @@ -59,4 +59,4 @@ not \`null\`.

# VERSION

v0.1.16
v1.1.0
4 changes: 2 additions & 2 deletions docs/src/man/bootc-switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -69,4 +69,4 @@ includes a default policy which requires signatures.

# VERSION

v0.1.16
v1.1.0
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.16
v1.1.0
8 changes: 4 additions & 4 deletions docs/src/man/bootc-usr-overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -39,4 +39,4 @@ unmount\".

# VERSION

v0.1.16
v1.1.0
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.16
v1.1.0

0 comments on commit e92be55

Please sign in to comment.