GGLinnk/bees
1
0
Fork 0
mirror of https://github.com/Zygo/bees.git synced 2025-05-17 13:25:45 +02:00
Code Packages

docs: deprecate the --workaround-btrfs-send option

Browse Source 
Emphasize that the option is relevant to old kernels, older than the
minimum supportable version threshold.

De-emphasize the use case of "send-workaround" as a synonym for "exclude
read-only".

Signed-off-by: Zygo Blaxell <bees@furryterror.org>
This commit is contained in:
Zygo Blaxell 2025-01-11 02:12:28 -05:00
parent e2587cae9b
commit a5d078d48b
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/options.md
View File

@ -84,19 +84,22 @@
* `--workaround-btrfs-send` or `-a` * `--workaround-btrfs-send` or `-a`
_This option is obsolete and should not be used any more._
Pretend that read-only snapshots are empty and silently discard any Pretend that read-only snapshots are empty and silently discard any
request to dedupe files referenced through them. This is a workaround for request to dedupe files referenced through them. This is a workaround
[problems with the kernel implementation of `btrfs send` and `btrfs send for [problems with old kernels running `btrfs send` and `btrfs send
-p`](btrfs-kernel.md) which make these btrfs features unusable with bees. -p`](btrfs-kernel.md) which make these btrfs features unusable with bees.
This option should be used to avoid breaking `btrfs send` on the same This option was used to avoid breaking `btrfs send` on old kernels.
filesystem. The affected kernels are now too old to be recommended for use with bees.
bees now waits for `btrfs send` to finish. There is no need for an
option to enable this.
**Note:** There is a _significant_ space tradeoff when using this option: **Note:** There is a _significant_ space tradeoff when using this option:
it is likely no space will be recovered--and possibly significant extra it is likely no space will be recovered--and possibly significant extra
space used--until the read-only snapshots are deleted. On the other space used--until the read-only snapshots are deleted.
hand, if snapshots are rotated frequently then bees will spend less time
scanning them.
## Logging options ## Logging options