containers/bootc
1
0
Fork 0
mirror of https://github.com/containers/bootc.git synced 2026-02-05 06:45:13 +01:00
Code Issues Activity

build-sys: A lot more manpage followups

Browse Source 
- Remove duplicated logic between xtask and makefile
  for converting markdown; it needs to be in xtask
  as we handle the version substitution there and
  some other tweaks
- Really just make the developer entrypoint `just update-generated`
  in general
- Fix the rendering of booleans
- Remove unnecessary emoji from prints

Signed-off-by: Colin Walters <walters@verbum.org>
This commit is contained in:
Colin Walters
2025-09-17 16:17:12 -04:00
parent 2ca2886cee
commit 856a7fba7c
20 changed files with 165 additions and 270 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/src/man/bootc-container-lint.8.md
View File

@@ -5,7 +5,7 @@ checks as part of a container build
# SYNOPSIS
**bootc container lint** [*OPTIONS...*]
**bootc container lint** \[*OPTIONS...*\]
# DESCRIPTION
@@ -24,34 +24,22 @@ part of a build process; it will error if any problems are detected.
Default: /
**--fatal-warnings**=*FATAL_WARNINGS*
**--fatal-warnings**
Make warnings fatal
Possible values:
- true
- false
**--list**=*LIST*
**--list**
Instead of executing the lints, just print all available lints. At the current time, this will output in YAML format because it's reasonably human friendly. However, there is no commitment to maintaining this exact format; do not parse it via code or scripts
Possible values:
- true
- false
**--skip**=*SKIP*
Skip checking the targeted lints, by name. Use `--list` to discover the set of available lints
**--no-truncate**=*NO_TRUNCATE*
**--no-truncate**
Don't truncate the output. By default, only a limited number of entries are shown for each lint, followed by a count of remaining entries
Possible values:
- true
- false
<!-- END GENERATED OPTIONS -->
# VERSION

2
docs/src/man/bootc-container.8.md
View File

@@ -5,7 +5,7 @@ container build
# SYNOPSIS
**bootc container** [*OPTIONS...*] <*SUBCOMMAND*>
**bootc container** \[*OPTIONS...*\] <*SUBCOMMAND*>
# DESCRIPTION

8
docs/src/man/bootc-edit.8.md
View File

@@ -4,7 +4,7 @@ bootc-edit - Apply full changes to the host specification
# SYNOPSIS
**bootc edit** [*OPTIONS...*]
**bootc edit** \[*OPTIONS...*\]
# DESCRIPTION
@@ -26,14 +26,10 @@ Only changes to the `spec` section are honored.
Use filename to edit system specification
**--quiet**=*QUIET*
**--quiet**
Don't display progress
Possible values:
- true
- false
<!-- END GENERATED OPTIONS -->
# VERSION

2
docs/src/man/bootc-install-ensure-completion.8.md
View File

@@ -5,7 +5,7 @@ are performing an ostree-based installation, not bootc
# SYNOPSIS
**bootc install ensure-completion** [*OPTIONS...*]
**bootc install ensure-completion** \[*OPTIONS...*\]
# DESCRIPTION

2
docs/src/man/bootc-install-finalize.8.md
View File

@@ -5,7 +5,7 @@ installation using `install to-filesystem`
# SYNOPSIS
**bootc install finalize** [*OPTIONS...*] <*ROOT_PATH*>
**bootc install finalize** \[*OPTIONS...*\] <*ROOT_PATH*>
# DESCRIPTION

2
docs/src/man/bootc-install-print-configuration.8.md
View File

@@ -7,7 +7,7 @@ discover the desired root filesystem type from the container image
# SYNOPSIS
**bootc install print-configuration** [*OPTIONS...*]
**bootc install print-configuration** \[*OPTIONS...*\]
# DESCRIPTION

44
docs/src/man/bootc-install-to-disk.8.md
View File

@@ -4,7 +4,7 @@ bootc-install-to-disk - Install to the target block device
# SYNOPSIS
**bootc install to-disk** [*OPTIONS...*] <*DEVICE*>
**bootc install to-disk** \[*OPTIONS...*\] <*DEVICE*>
# DESCRIPTION
@@ -28,14 +28,10 @@ more complex such as RAID, LVM, LUKS etc.
This argument is required.
**--wipe**=*WIPE*
**--wipe**
Automatically wipe all existing data on device
Possible values:
- true
- false
**--block-setup**=*BLOCK_SETUP*
Target root block device setup
@@ -71,38 +67,22 @@ more complex such as RAID, LVM, LUKS etc.
Specify the image to fetch for subsequent updates
**--enforce-container-sigpolicy**=*ENFORCE_CONTAINER_SIGPOLICY*
**--enforce-container-sigpolicy**
This is the inverse of the previous `--target-no-signature-verification` (which is now a no-op). Enabling this option enforces that `/etc/containers/policy.json` includes a default policy which requires signatures
Possible values:
- true
- false
**--run-fetch-check**=*RUN_FETCH_CHECK*
**--run-fetch-check**
Verify the image can be fetched from the bootc image. Updates may fail when the installation host is authenticated with the registry but the pull secret is not in the bootc image
Possible values:
- true
- false
**--skip-fetch-check**=*SKIP_FETCH_CHECK*
**--skip-fetch-check**
Verify the image can be fetched from the bootc image. Updates may fail when the installation host is authenticated with the registry but the pull secret is not in the bootc image
Possible values:
- true
- false
**--disable-selinux**=*DISABLE_SELINUX*
**--disable-selinux**
Disable SELinux in the target (installed) system
Possible values:
- true
- false
**--karg**=*KARG*
Add a kernel argument. This option can be provided multiple times
@@ -111,14 +91,10 @@ more complex such as RAID, LVM, LUKS etc.
The path to an `authorized_keys` that will be injected into the `root` account
**--generic-image**=*GENERIC_IMAGE*
**--generic-image**
Perform configuration changes suitable for a "generic" disk image. At the moment:
Possible values:
- true
- false
**--bound-images**=*BOUND_IMAGES*
How should logically bound images be retrieved
@@ -134,14 +110,10 @@ more complex such as RAID, LVM, LUKS etc.
The stateroot name to use. Defaults to `default`
**--via-loopback**=*VIA_LOOPBACK*
**--via-loopback**
Instead of targeting a block device, write to a file via loopback
Possible values:
- true
- false
<!-- END GENERATED OPTIONS -->
# EXAMPLES

44
docs/src/man/bootc-install-to-existing-root.8.md
View File

@@ -4,7 +4,7 @@ bootc-install-to-existing-root - Install to the host root filesystem
# SYNOPSIS
**bootc install to-existing-root** [*OPTIONS...*] [*ROOT_PATH*]
**bootc install to-existing-root** \[*OPTIONS...*\] \[*ROOT_PATH*\]
# DESCRIPTION
@@ -47,38 +47,22 @@ to be cleaned up if desired when rebooted into the new root.
Specify the image to fetch for subsequent updates
**--enforce-container-sigpolicy**=*ENFORCE_CONTAINER_SIGPOLICY*
**--enforce-container-sigpolicy**
This is the inverse of the previous `--target-no-signature-verification` (which is now a no-op). Enabling this option enforces that `/etc/containers/policy.json` includes a default policy which requires signatures
Possible values:
- true
- false
**--run-fetch-check**=*RUN_FETCH_CHECK*
**--run-fetch-check**
Verify the image can be fetched from the bootc image. Updates may fail when the installation host is authenticated with the registry but the pull secret is not in the bootc image
Possible values:
- true
- false
**--skip-fetch-check**=*SKIP_FETCH_CHECK*
**--skip-fetch-check**
Verify the image can be fetched from the bootc image. Updates may fail when the installation host is authenticated with the registry but the pull secret is not in the bootc image
Possible values:
- true
- false
**--disable-selinux**=*DISABLE_SELINUX*
**--disable-selinux**
Disable SELinux in the target (installed) system
Possible values:
- true
- false
**--karg**=*KARG*
Add a kernel argument. This option can be provided multiple times
@@ -87,14 +71,10 @@ to be cleaned up if desired when rebooted into the new root.
The path to an `authorized_keys` that will be injected into the `root` account
**--generic-image**=*GENERIC_IMAGE*
**--generic-image**
Perform configuration changes suitable for a "generic" disk image. At the moment:
Possible values:
- true
- false
**--bound-images**=*BOUND_IMAGES*
How should logically bound images be retrieved
@@ -110,22 +90,14 @@ to be cleaned up if desired when rebooted into the new root.
The stateroot name to use. Defaults to `default`
**--acknowledge-destructive**=*ACKNOWLEDGE_DESTRUCTIVE*
**--acknowledge-destructive**
Accept that this is a destructive action and skip a warning timer
Possible values:
- true
- false
**--cleanup**=*CLEANUP*
**--cleanup**
Add the bootc-destructive-cleanup systemd service to delete files from the previous install on first boot
Possible values:
- true
- false
<!-- END GENERATED OPTIONS -->
# VERSION

44
docs/src/man/bootc-install-to-filesystem.8.md
View File

@@ -5,7 +5,7 @@ filesystem structure
# SYNOPSIS
**bootc install to-filesystem** [*OPTIONS...*] <*ROOT_PATH*>
**bootc install to-filesystem** \[*OPTIONS...*\] <*ROOT_PATH*>
# DESCRIPTION
@@ -41,22 +41,14 @@ is currently expected to be empty by default.
- wipe
- alongside
**--acknowledge-destructive**=*ACKNOWLEDGE_DESTRUCTIVE*
**--acknowledge-destructive**
If the target is the running system's root filesystem, this will skip any warnings
Possible values:
- true
- false
**--skip-finalize**=*SKIP_FINALIZE*
**--skip-finalize**
The default mode is to "finalize" the target filesystem by invoking `fstrim` and similar operations, and finally mounting it readonly. This option skips those operations. It is then the responsibility of the invoking code to perform those operations
Possible values:
- true
- false
**--source-imgref**=*SOURCE_IMGREF*
Install the system from an explicitly given source
@@ -71,38 +63,22 @@ is currently expected to be empty by default.
Specify the image to fetch for subsequent updates
**--enforce-container-sigpolicy**=*ENFORCE_CONTAINER_SIGPOLICY*
**--enforce-container-sigpolicy**
This is the inverse of the previous `--target-no-signature-verification` (which is now a no-op). Enabling this option enforces that `/etc/containers/policy.json` includes a default policy which requires signatures
Possible values:
- true
- false
**--run-fetch-check**=*RUN_FETCH_CHECK*
**--run-fetch-check**
Verify the image can be fetched from the bootc image. Updates may fail when the installation host is authenticated with the registry but the pull secret is not in the bootc image
Possible values:
- true
- false
**--skip-fetch-check**=*SKIP_FETCH_CHECK*
**--skip-fetch-check**
Verify the image can be fetched from the bootc image. Updates may fail when the installation host is authenticated with the registry but the pull secret is not in the bootc image
Possible values:
- true
- false
**--disable-selinux**=*DISABLE_SELINUX*
**--disable-selinux**
Disable SELinux in the target (installed) system
Possible values:
- true
- false
**--karg**=*KARG*
Add a kernel argument. This option can be provided multiple times
@@ -111,14 +87,10 @@ is currently expected to be empty by default.
The path to an `authorized_keys` that will be injected into the `root` account
**--generic-image**=*GENERIC_IMAGE*
**--generic-image**
Perform configuration changes suitable for a "generic" disk image. At the moment:
Possible values:
- true
- false
**--bound-images**=*BOUND_IMAGES*
How should logically bound images be retrieved

2
docs/src/man/bootc-install.8.md
View File

@@ -4,7 +4,7 @@ bootc-install - Install the running container to a target
# SYNOPSIS
**bootc install** [*OPTIONS...*] <*SUBCOMMAND*>
**bootc install** \[*OPTIONS...*\] <*SUBCOMMAND*>
# DESCRIPTION

8
docs/src/man/bootc-rollback.8.md
View File

@@ -4,7 +4,7 @@ bootc-rollback - Change the bootloader entry ordering
# SYNOPSIS
**bootc rollback** [*OPTIONS...*]
**bootc rollback** \[*OPTIONS...*\]
# DESCRIPTION
@@ -34,14 +34,10 @@ merges happen when new deployments are created.
# OPTIONS
<!-- BEGIN GENERATED OPTIONS -->
**--apply**=*APPLY*
**--apply**
Restart or reboot into the rollback image
Possible values:
- true
- false
**--soft-reboot**=*SOFT_REBOOT*
Configure soft reboot behavior

14
docs/src/man/bootc-status.8.md
View File

@@ -4,7 +4,7 @@ bootc-status - Display status
# SYNOPSIS
**bootc status** [*OPTIONS...*]
**bootc status** \[*OPTIONS...*\]
# DESCRIPTION
@@ -40,22 +40,14 @@ Invoke e.g. `bootc status --json`, and check if `status.booted` is not `null`.
The desired format version. There is currently one supported version, which is exposed as both `0` and `1`. Pass this option to explicitly request it; it is possible that another future version 2 or newer will be supported in the future
**--booted**=*BOOTED*
**--booted**
Only display status for the booted deployment
Possible values:
- true
- false
**-v**, **--verbose**=*VERBOSE*
**-v**, **--verbose**
Include additional fields in human readable format
Possible values:
- true
- false
<!-- END GENERATED OPTIONS -->
# EXAMPLES

26
docs/src/man/bootc-switch.8.md
View File

@@ -4,7 +4,7 @@ bootc-switch - Target a new container image reference to boot
# SYNOPSIS
**bootc switch** [*OPTIONS...*] <*TARGET*>
**bootc switch** \[*OPTIONS...*\] <*TARGET*>
# DESCRIPTION
@@ -41,22 +41,14 @@ Soft reboot allows faster system restart by avoiding full hardware reboot when p
This argument is required.
**--quiet**=*QUIET*
**--quiet**
Don't display progress
Possible values:
- true
- false
**--apply**=*APPLY*
**--apply**
Restart or reboot into the new target image
Possible values:
- true
- false
**--soft-reboot**=*SOFT_REBOOT*
Configure soft reboot behavior
@@ -71,22 +63,14 @@ Soft reboot allows faster system restart by avoiding full hardware reboot when p
Default: registry
**--enforce-container-sigpolicy**=*ENFORCE_CONTAINER_SIGPOLICY*
**--enforce-container-sigpolicy**
This is the inverse of the previous `--target-no-signature-verification` (which is now a no-op)
Possible values:
- true
- false
**--retain**=*RETAIN*
**--retain**
Retain reference to currently booted image
Possible values:
- true
- false
<!-- END GENERATED OPTIONS -->
# EXAMPLES

20
docs/src/man/bootc-upgrade.8.md
View File

@@ -4,7 +4,7 @@ bootc-upgrade - Download and queue an updated container image to apply
# SYNOPSIS
**bootc upgrade** [*OPTIONS...*]
**bootc upgrade** \[*OPTIONS...*\]
# DESCRIPTION
@@ -41,30 +41,18 @@ Soft reboot allows faster system restart by avoiding full hardware reboot when p
# OPTIONS
<!-- BEGIN GENERATED OPTIONS -->
**--quiet**=*QUIET*
**--quiet**
Don't display progress
Possible values:
- true
- false
**--check**=*CHECK*
**--check**
Check if an update is available without applying it
Possible values:
- true
- false
**--apply**=*APPLY*
**--apply**
Restart or reboot into the new target image
Possible values:
- true
- false
**--soft-reboot**=*SOFT_REBOOT*
Configure soft reboot behavior

2
docs/src/man/bootc-usr-overlay.8.md
View File

@@ -5,7 +5,7 @@ will be discarded on reboot
# SYNOPSIS
**bootc usr-overlay** [*OPTIONS...*]
**bootc usr-overlay** \[*OPTIONS...*\]
# DESCRIPTION

2
docs/src/man/bootc.8.md
View File

@@ -5,7 +5,7 @@ images
# SYNOPSIS
**bootc** [*OPTIONS...*] <*SUBCOMMAND*>
**bootc** \[*OPTIONS...*\] <*SUBCOMMAND*>
# DESCRIPTION