db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-10-30 23:37:45 +02:00
Code Issues Releases Activity

Describe discrete option values in a list where appropriate.

Browse Source 
In the documentation and help output the possible values for most options are described as a list but there were several commands for which formatting was done in a different style.

Formatting has been applied to commands and their options to display option values as a list:

* `info` command, `--type` option
* `verify` command, `--output` option
* `version` command, `--output` option
* `manifest` command, `--output` option
This commit is contained in:
Anton Kurochkin
2025-06-09 17:34:17 +03:00
committed by GitHub
parent 8aa2d88bac
commit 2e76e9fc69
4 changed files with 41 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/src/build/help/help.xml
View File

@@ -146,7 +146,11 @@
<summary>Output type.</summary>
<text>
<p>Output may be text (default) or num to display the installed <backrest/> version as an integer.</p>
<p>The following output formats are supported:</p>
<list>
<list-item><id>text</id> - Display the installed <backrest/> version as text.</list-item>
<list-item><id>num</id> - Display the installed <backrest/> version as an integer.</list-item>
</list>
</text>
<example>num</example>

11
doc/xml/release/2025/2.56.0.xml
View File

@@ -30,6 +30,17 @@
<release-doc-list>
<release-improvement-list>
<release-item>
<github-pull-request id="2638"/>
<release-item-contributor-list>
<release-item-contributor id="anton.kurochkin"/>
<release-item-reviewer id="david.steele"/>
</release-item-contributor-list>
<p>Describe discrete option values in a list where appropriate.</p>
</release-item>
<release-item>
<github-pull-request id="2633"/>

25
src/build/help/help.xml
View File

@@ -2274,8 +2274,8 @@
<p>The following output types are supported:</p>
<list>
<list-item><id>text</id></list-item>
<list-item><id>json</id></list-item>
<list-item><id>text</id> - Human-readable summary of manifest information.</list-item>
<list-item><id>json</id> - Exhaustive machine-readable manifest information in JSON format.</list-item>
</list>
</text>
@@ -2612,7 +2612,13 @@
<summary>Filter on backup type.</summary>
<text>
<p>Filter the output using one of the following backup types: <id>full</id>, <id>incr</id>, <id>diff</id>.</p>
<p>Filter the output using one of the following backup types:</p>
<list>
<list-item><id>full</id> - Output only full backups.</list-item>
<list-item><id>diff</id> - Output only differential backups.</list-item>
<list-item><id>incr</id> - Output only incremental backups.</list-item>
</list>
</text>
<example>full</example>
@@ -2719,7 +2725,12 @@
<option id="output" name="Output">
<summary>Output type.</summary>
<text> <p>Output may be none (default) or text. Requesting text generates output to stdout.</p>
<text>
<p>The following output types are supported:</p>
<list>
<list-item><id>none</id> - No verify output.</list-item>
<list-item><id>text</id> - Output verify information to stdout.</list-item>
</list>
</text>
<example>text</example>
@@ -2749,7 +2760,11 @@
<summary>Output type.</summary>
<text>
<p>Output may be text (default) or num to display the installed <backrest/> version as an integer.</p>
<p>The following output types are supported:</p>
<list>
<list-item><id>text</id> - Display the installed <backrest/> version as text.</list-item>
<list-item><id>num</id> - Display the installed <backrest/> version as an integer.</list-item>
</list>
</text>
<example>num</example>

6
test/src/build/help/help.xml
View File

@@ -280,7 +280,11 @@
<summary>Output type.</summary>
<text>
<p>Output may be text (default) or num to display the installed <backrest/> version as an integer.</p>
<p>The following output formats are supported:</p>
<list>
<list-item><id>text</id> - Display the installed <backrest/> version as text.</list-item>
<list-item><id>num</id> - Display the installed <backrest/> version as an integer.</list-item>
</list>
</text>
<example>num</example>