1
0
mirror of https://github.com/Zygo/bees.git synced 2025-08-03 22:33:28 +02:00

docs: reorganize options, add workaround for btrfs send

options.md was a disorganized mess that markdown couldn't parse properly.

Break the options list down into sections by theme.  Add the new
'--workaround-btrfs-send' option to the new 'Workarounds' section.

Clean up the rest of the text and fix some inconsistencies.

Signed-off-by: Zygo Blaxell <bees@furryterror.org>
This commit is contained in:
Zygo Blaxell
2018-11-17 00:46:58 -05:00
parent 23f3e4ec42
commit d9c788d30a
3 changed files with 101 additions and 53 deletions

View File

@@ -38,9 +38,6 @@ Unfixed kernel bugs (as of 4.14.71):
`rsync` is copying from, while `rsync` will rename the new file over
the old file to replace it.
* **btrfs send** has various problems when bees is deduping RO snapshots,
especially if the snapshot is used as a parent for incremental send.
Minor kernel problems with workarounds:
* **Slow backrefs** (aka toxic extents): Under certain conditions,
@@ -52,6 +49,19 @@ Minor kernel problems with workarounds:
to get slow. In the bees log, such blocks are labelled as 'toxic'
hash/block addresses.
* **btrfs send** has various bugs that are triggered when bees is
deduping snapshots. bees provides the [`--workaround-btrfs-send`
option](options.md) which should be used whenever `btrfs send` and
bees are run on the same filesystem.
This issue affects:
* `btrfs send` (any mode) and bees active at the same time.
* `btrfs send` in incremental mode (using `-p` option) with bees
active at the same or different times.
Note `btrfs receive` is not affected. It is OK to run bees with no
workarounds on a filesystem that receives btrfs snapshots.
Older kernels:
* Older kernels have various data corruption and deadlock/hang issues