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 buffer-size option.

Browse Source
This commit is contained in:
David Steele
2021-10-27 10:52:39 -04:00
parent 1f7c7b7dda
commit e1f6c066b3
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -127,10 +127,10 @@
<config-key-list> <config-key-list>
<config-key id="buffer-size" name="Buffer Size"> <config-key id="buffer-size" name="Buffer Size">
<summary>Buffer size for file operations.</summary> <summary>Buffer size for I/O operations.</summary>
<text> <text>
<p>Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.</p> <p>Buffer size used for copy, compress, encrypt, and other operations. The number of buffers used depends on options and each operation may use additional memory, e.g. <id>gz</id> compression may use an additional 256KiB of memory.</p>
<p>Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.</p> <p>Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.</p>

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

@ -221,7 +221,7 @@ testRun(void)
"\n" "\n"
"General Options:\n" "General Options:\n"
"\n" "\n"
" --buffer-size buffer size for file operations\n" " --buffer-size buffer size for I/O operations\n"
" [current=32768, default=1048576]\n" " [current=32768, default=1048576]\n"
" --cmd-ssh path to ssh client executable [default=ssh]\n" " --cmd-ssh path to ssh client executable [default=ssh]\n"
" --compress-level-network network compression level [default=3]\n" " --compress-level-network network compression level [default=3]\n"
@ -364,11 +364,11 @@ testRun(void)
const char *optionHelp = strZ(strNewFmt( const char *optionHelp = strZ(strNewFmt(
"%s - 'archive-push' command - 'buffer-size' option help\n" "%s - 'archive-push' command - 'buffer-size' option help\n"
"\n" "\n"
"Buffer size for file operations.\n" "Buffer size for I/O operations.\n"
"\n" "\n"
"Set the buffer size used for copy, compress, and uncompress functions. A\n" "Buffer size used for copy, compress, encrypt, and other operations. The number\n"
"maximum of 3 buffers will be in use at a time per process. An additional\n" "of buffers used depends on options and each operation may use additional\n"
"maximum of 256K per process may be used for zlib buffers.\n" "memory, e.g. gz compression may use an additional 256KiB of memory.\n"
"\n" "\n"
"Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the\n" "Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the\n"
"multiplier is a power of 1024. For example, the case-insensitive value 32k (or\n" "multiplier is a power of 1024. For example, the case-insensitive value 32k (or\n"