Skip to content

Commit 867b8c8

Browse files
committed
docs: Disable "version" option for subcommands
Subcommands don't have their own versions, so disable the "version" option. Signed-off-by: Yihuang Yu <[email protected]>
1 parent 3e0bb1e commit 867b8c8

12 files changed

+12
-59
lines changed

docs/src/man/bootc-edit.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ bootc-edit - Apply full changes to the host specification
55
# SYNOPSIS
66

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

1010
# DESCRIPTION
1111

@@ -34,10 +34,6 @@ Only changes to the \`spec\` section are honored.
3434

3535
: Print help (see a summary with -h)
3636

37-
**-V**, **\--version**
38-
39-
: Print version
40-
4137
# VERSION
4238

4339
v0.1.11

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ processes using \`install to-filesystem\` that want to honor e.g.
88
# SYNOPSIS
99

1010
**bootc install print-configuration** \[**-h**\|**\--help**\]
11-
\[**-V**\|**\--version**\]
1211

1312
# DESCRIPTION
1413

@@ -25,10 +24,6 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`.
2524

2625
: Print help (see a summary with -h)
2726

28-
**-V**, **\--version**
29-
30-
: Print version
31-
3227
# VERSION
3328

3429
v0.1.11

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ bootc-install-to-disk - Install to the target block device
1010
\[**\--enforce-container-sigpolicy**\] \[**\--target-ostree-remote**\]
1111
\[**\--skip-fetch-check**\] \[**\--disable-selinux**\] \[**\--karg**\]
1212
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
13-
\[**\--via-loopback**\] \[**-h**\|**\--help**\]
14-
\[**-V**\|**\--version**\] \<*DEVICE*\>
13+
\[**\--via-loopback**\] \[**-h**\|**\--help**\] \<*DEVICE*\>
1514

1615
# DESCRIPTION
1716

@@ -128,10 +127,6 @@ firmware will be skipped
128127

129128
: Print help (see a summary with -h)
130129

131-
**-V**, **\--version**
132-
133-
: Print version
134-
135130
\<*DEVICE*\>
136131

137132
: Target block device for installation. The entire device will be

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ root filesystem
1212
\[**\--disable-selinux**\] \[**\--karg**\]
1313
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
1414
\[**\--acknowledge-destructive**\] \[**-h**\|**\--help**\]
15-
\[**-V**\|**\--version**\] \[*ROOT_PATH*\]
15+
\[*ROOT_PATH*\]
1616

1717
# DESCRIPTION
1818

@@ -117,10 +117,6 @@ firmware will be skipped
117117

118118
: Print help (see a summary with -h)
119119

120-
**-V**, **\--version**
121-
122-
: Print version
123-
124120
\[*ROOT_PATH*\] \[default: /target\]
125121

126122
: Path to the mounted root; its expected to invoke podman with \`-v

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ bootc-install-to-filesystem - Install to the target filesystem
1212
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
1313
\[**\--disable-selinux**\] \[**\--karg**\]
1414
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
15-
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\] \<*ROOT_PATH*\>
15+
\[**-h**\|**\--help**\] \<*ROOT_PATH*\>
1616

1717
# DESCRIPTION
1818

@@ -140,10 +140,6 @@ firmware will be skipped
140140

141141
: Print help (see a summary with -h)
142142

143-
**-V**, **\--version**
144-
145-
: Print version
146-
147143
\<*ROOT_PATH*\>
148144

149145
: Path to the mounted root filesystem.

docs/src/man/bootc-install.md

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

55
# SYNOPSIS
66

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

109
# DESCRIPTION
1110

@@ -35,10 +34,6 @@ includes other setup and metadata.
3534

3635
: Print help (see a summary with -h)
3736

38-
**-V**, **\--version**
39-
40-
: Print version
41-
4237
# SUBCOMMANDS
4338

4439
bootc-install-to-disk(8)

docs/src/man/bootc-rollback.md

Lines changed: 1 addition & 5 deletions
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**\]
1111

1212
# DESCRIPTION
1313

@@ -32,10 +32,6 @@ rollback invocation.
3232

3333
: Print help (see a summary with -h)
3434

35-
**-V**, **\--version**
36-
37-
: Print version
38-
3935
# VERSION
4036

4137
v0.1.11

docs/src/man/bootc-status.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ bootc-status - Display status
55
# SYNOPSIS
66

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

1010
# DESCRIPTION
1111

@@ -31,10 +31,6 @@ The exact API format is not currently declared stable.
3131

3232
: Print help (see a summary with -h)
3333

34-
**-V**, **\--version**
35-
36-
: Print version
37-
3834
# VERSION
3935

4036
v0.1.11

docs/src/man/bootc-switch.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ bootc-switch - Target a new container image reference to boot
66

77
**bootc switch** \[**\--quiet**\] \[**\--transport**\]
88
\[**\--enforce-container-sigpolicy**\] \[**\--ostree-remote**\]
9-
\[**\--retain**\] \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
10-
\<*TARGET*\>
9+
\[**\--retain**\] \[**-h**\|**\--help**\] \<*TARGET*\>
1110

1211
# DESCRIPTION
1312

@@ -55,10 +54,6 @@ includes a default policy which requires signatures.
5554

5655
: Print help (see a summary with -h)
5756

58-
**-V**, **\--version**
59-
60-
: Print version
61-
6257
\<*TARGET*\>
6358

6459
: Target image to use for the next boot

docs/src/man/bootc-upgrade.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ bootc-upgrade - Download and queue an updated container image to apply
55
# SYNOPSIS
66

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

1010
# DESCRIPTION
1111

@@ -50,10 +50,6 @@ userspace-only restart.
5050

5151
: Print help (see a summary with -h)
5252

53-
**-V**, **\--version**
54-
55-
: Print version
56-
5753
# VERSION
5854

5955
v0.1.11

0 commit comments

Comments
 (0)