documentation: btrbk.conf.5: explain stream_buffer_remote

2019-12-23 12:10:17 +01:00 · 2019-12-23 12:10:17 +01:00 · 73c24e0495
parent 631a4c30fe
commit 73c24e0495
1 changed files with 7 additions and 0 deletions
--- a/doc/btrbk.conf.5.asciidoc
+++ b/doc/btrbk.conf.5.asciidoc
@ -315,6 +315,13 @@ additional, multi-threaded process to the command pipe.
 *stream_buffer_remote* <size>|no::
    Add a buffer on remote hosts (either source or target). Defaults
    to ``no''.
+
+--
+Enable this if you prefer buffering on the remote side, or even on
+both sides: reasons for this depend on available memory, disk and cpu
+performance (btrfs send/receive, compression), as well as networking
+constraints.
+--

 *rate_limit* <rate>|no::
    Limit the read rate of the btrfs send stream to '<rate>' bytes per