db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-07-15 01:04:37 +02:00
Code Issues Releases Activity

Improve documentation for cmd-ssh, repo-host-cmd, pg-host-cmd options.

Browse Source 
Use "command" instead of "exe" and make the descriptions more consistent.
This commit is contained in:
David Steele
2021-10-27 11:08:32 -04:00
parent e1f6c066b3
commit fa564ee196
2 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -141,11 +141,11 @@
</config-key>
<!-- CONFIG - GENERAL SECTION - CMD-SSH KEY -->
<config-key id="cmd-ssh" name="SSH client command">
<summary>Path to ssh client executable.</summary>
<config-key id="cmd-ssh" name="SSH Client Command">
<summary>SSH client command.</summary>
<text>
<p>Use a specific SSH client when an alternate is desired or the <file>ssh</file> executable is not in $PATH.</p>
<p>Use a specific SSH client command when an alternate is desired or the <file>ssh</file> command is not in $PATH.</p>
</text>
<example>/usr/bin/ssh</example>
@ -625,10 +625,10 @@
<!-- CONFIG - REPO SECTION - REPO-HOST-CMD KEY -->
<config-key id="repo-host-cmd" name="Repository Host Command">
<summary><backrest/> exe path on the repository host.</summary>
<summary>Repository host <backrest/> command.</summary>
<text>
<p>Required only if the path to <exe/> is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.</p>
<p>Required only if the path to the <backrest/> command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.</p>
</text>
<default>same as local</default>
@ -1470,10 +1470,10 @@
<config-key-list>
<!-- CONFIG - STANZA SECTION - PG-HOST-CMD KEY -->
<config-key id="pg-host-cmd" name="PostgreSQL Host Command">
<summary><backrest/> exe path on the <postgres/> host.</summary>
<summary><postgres/> host <backrest/> command.</summary>
<text>
<p>Required only if the path to <exe/> is different on the local and <postgres/> hosts. If not defined, the database host exe path will be set the same as the local exe path.</p>
<p>Required only if the path to the <backrest/> command is different on the local and <postgres/> hosts. If not defined, the <postgres/> host command will be set the same as the local command.</p>
</text>
<default>same as local</default>

4
test/src/module/command/helpTest.c
View File

@ -223,7 +223,7 @@ testRun(void)
"\n"
" --buffer-size buffer size for I/O operations\n"
" [current=32768, default=1048576]\n"
" --cmd-ssh path to ssh client executable [default=ssh]\n"
" --cmd-ssh SSH client command [default=ssh]\n"
" --compress-level-network network compression level [default=3]\n"
" --config pgBackRest configuration file\n"
" [default=/etc/pgbackrest/pgbackrest.conf]\n"
@ -276,7 +276,7 @@ testRun(void)
" --repo-gcs-key-type GCS repository key type [default=service]\n"
" --repo-host repository host when operating remotely via\n"
" SSH [current=backup.example.net]\n"
" --repo-host-cmd pgBackRest exe path on the repository host\n"
" --repo-host-cmd repository host pgBackRest command\n"
" [default=/path/to/pgbackrest]\n"
" --repo-host-config pgBackRest repository host configuration\n"
" file\n"