Skip to content

Commit 3e0bb1e

Browse files
committed
docs: Set bin_name for subcommands and use full title
`bin_name` will be displayed in the `SYNOPSIS` section, with this, the generated man pages have correct name and synopsis. Also, remove `.title("bootc")` to let the subcommands have their own titles. Signed-off-by: Yihuang Yu <[email protected]>
1 parent 0fb86b8 commit 3e0bb1e

12 files changed

+20
-13
lines changed

docs/src/man/bootc-edit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ bootc-edit - Apply full changes to the host specification
44

55
# SYNOPSIS
66

7-
**bootc-edit** \[**-f**\|**\--filename**\] \[**\--quiet**\]
7+
**bootc edit** \[**-f**\|**\--filename**\] \[**\--quiet**\]
88
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
99

1010
# DESCRIPTION

docs/src/man/bootc-install-print-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ processes using \`install to-filesystem\` that want to honor e.g.
77

88
# SYNOPSIS
99

10-
**bootc-install-print-configuration** \[**-h**\|**\--help**\]
10+
**bootc install print-configuration** \[**-h**\|**\--help**\]
1111
\[**-V**\|**\--version**\]
1212

1313
# DESCRIPTION

docs/src/man/bootc-install-to-disk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ bootc-install-to-disk - Install to the target block device
44

55
# SYNOPSIS
66

7-
**bootc-install-to-disk** \[**\--wipe**\] \[**\--block-setup**\]
7+
**bootc install to-disk** \[**\--wipe**\] \[**\--block-setup**\]
88
\[**\--filesystem**\] \[**\--root-size**\] \[**\--source-imgref**\]
99
\[**\--target-transport**\] \[**\--target-imgref**\]
1010
\[**\--enforce-container-sigpolicy**\] \[**\--target-ostree-remote**\]

docs/src/man/bootc-install-to-existing-root.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ root filesystem
55

66
# SYNOPSIS
77

8-
**bootc-install-to-existing-root** \[**\--replace**\]
8+
**bootc install to-existing-root** \[**\--replace**\]
99
\[**\--source-imgref**\] \[**\--target-transport**\]
1010
\[**\--target-imgref**\] \[**\--enforce-container-sigpolicy**\]
1111
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]

docs/src/man/bootc-install-to-filesystem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ bootc-install-to-filesystem - Install to the target filesystem
44

55
# SYNOPSIS
66

7-
**bootc-install-to-filesystem** \[**\--root-mount-spec**\]
7+
**bootc install to-filesystem** \[**\--root-mount-spec**\]
88
\[**\--boot-mount-spec**\] \[**\--replace**\]
99
\[**\--acknowledge-destructive**\] \[**\--skip-finalize**\]
1010
\[**\--source-imgref**\] \[**\--target-transport**\]

docs/src/man/bootc-install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ bootc-install - Install the running container to a target
44

55
# SYNOPSIS
66

7-
**bootc-install** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
7+
**bootc install** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
88
\<*subcommands*\>
99

1010
# DESCRIPTION

docs/src/man/bootc-rollback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ queued upgrade) then it will be discarded
77

88
# SYNOPSIS
99

10-
**bootc-rollback** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
10+
**bootc rollback** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
1111

1212
# DESCRIPTION
1313

docs/src/man/bootc-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ bootc-status - Display status
44

55
# SYNOPSIS
66

7-
**bootc-status** \[**\--json**\] \[**\--booted**\]
7+
**bootc status** \[**\--json**\] \[**\--booted**\]
88
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
99

1010
# DESCRIPTION

docs/src/man/bootc-switch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ bootc-switch - Target a new container image reference to boot
44

55
# SYNOPSIS
66

7-
**bootc-switch** \[**\--quiet**\] \[**\--transport**\]
7+
**bootc switch** \[**\--quiet**\] \[**\--transport**\]
88
\[**\--enforce-container-sigpolicy**\] \[**\--ostree-remote**\]
99
\[**\--retain**\] \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
1010
\<*TARGET*\>

docs/src/man/bootc-upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ bootc-upgrade - Download and queue an updated container image to apply
44

55
# SYNOPSIS
66

7-
**bootc-upgrade** \[**\--quiet**\] \[**\--check**\] \[**\--apply**\]
7+
**bootc upgrade** \[**\--quiet**\] \[**\--check**\] \[**\--apply**\]
88
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
99

1010
# DESCRIPTION

0 commit comments

Comments
 (0)