btrfs-progs/Documentation
Qu Wenruo 87b3197d81 btrfs-progs: move space cache removal to rescue group
The option "--clear-space-cache" is not really that suitable for "btrfs
check" group, as there are some concerns:

- Allowing transid mismatch
- No leaf item checks

  Thoe behaviour are inherited from the default open ctree flags for
  "btrfs check", which can be unsafe if the end user just wants to clear
  the cache.

- Unclear if the cache clearing would happen along with repair

  Thankfully the clearing of space cache is done without any repair

Thus there is a proposal to move space cache removal to rescue group,
and this patch would do that exactly.

However this would lead to some behavior changes:

- Transid mismatch would be treated as error
- Leaf items size/offset would still be checked

  If we hit any above error, we should just abort without doing any
  write.

These change would increase the safety of the space cache removal, thus
I believe it's worthy to introduce such behavior change.

Since we're here, also add a small explanation on why we need this
dedicated tool to clear space cache (especially for v1 cache).

Issue: #698
Signed-off-by: Qu Wenruo <wqu@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2023-11-03 18:04:37 +01:00
..
_static btrfs-progs: docs: updates 2023-08-28 17:24:25 +02:00
_templates btrfs-progs: docs: update template, more about subvolumes 2022-01-11 15:46:33 +01:00
dev btrfs-progs: docs: add document for RAID stripe tree design 2023-11-03 18:04:37 +01:00
Administration.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
Auto-repair.rst btrfs-progs: docs: updates, clarifications 2022-12-14 02:56:16 +01:00
Balance.rst btrfs-progs: docs: add balance filter examples 2023-06-09 12:44:03 +02:00
CHANGES.rst btrfs-progs: docs: distinguish Changes title 2022-08-16 15:18:10 +02:00
Checksumming.rst btrfs-progs: docs: add more chapters 2021-12-17 11:53:44 +01:00
CmdLineConventions btrfs-progs: docs: fix typos 2022-12-07 21:00:25 +01:00
CodingConventions
Common-features.rst btrfs-progs: docs: updates, formatting, status page 2023-06-01 20:49:17 +02:00
Compression.rst btrfs-progs: docs: add more chapters 2021-12-17 11:53:44 +01:00
Contributors.rst btrfs-progs: docs: add 6.5 kernel development statistics 2023-09-01 13:58:41 +02:00
Convert.rst btrfs-progs: docs: add more chapters (part 2) 2021-12-17 11:53:44 +01:00
Custom-ioctls.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
Deduplication.rst btrfs-progs: docs: typo fixups and formatting updates 2022-12-22 18:44:47 +01:00
Defragmentation.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
DocConventions.rst btrfs-progs: docs: update doc style and conventions 2023-07-27 14:45:29 +02:00
Feature-by-version.rst btrfs-progs: docs: fixups, references 2023-06-01 20:50:04 +02:00
Glossary.rst btrfs-progs: docs: use command role for programs or command lines 2023-04-27 01:48:47 +02:00
Hardware.rst btrfs-progs: docs: separate chapter for hardware considerations 2022-05-17 21:12:19 +02:00
INSTALL.rst btrfs-progs: docs: link INSTALL to docs 2022-05-12 13:56:03 +02:00
Inline-files.rst btrfs-progs: docs: use command role for programs or command lines 2023-04-27 01:48:47 +02:00
Interoperability.rst btrfs-progs: docs: update Interoperability 2023-08-28 17:24:58 +02:00
Introduction.rst btrfs-progs: docs: typo/clarity fix in Introduction 2023-04-25 16:59:42 +02:00
Kernel-by-version.rst btrfs-progs: docs: update kernel changes 2023-08-28 17:24:25 +02:00
Makefile.in btrfs-progs: docs: convert btrfs-ioctl.asciidoc to RST 2022-05-18 13:28:35 +02:00
Qgroups.rst btrfs-progs: docs: add more chapters (part 2) 2021-12-17 11:53:44 +01:00
Quick-start.rst btrfs-progs: docs: updates 2023-08-28 17:24:25 +02:00
Reflink.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
Resize.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
Scrub.rst btrfs-progs: docs: add more chapters (part 2) 2021-12-17 11:53:44 +01:00
Seeding-device.rst btrfs-progs: docs: add more chapters 2021-12-17 11:53:44 +01:00
Send-receive.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
Source-repositories.rst btrfs-progs: docs: fixups, references 2023-06-01 20:50:04 +02:00
Status.rst btrfs-progs: docs: updates 2023-09-12 23:18:35 +02:00
Subpage.rst btrfs-progs: docs: updates 2023-08-28 17:24:25 +02:00
Subvolumes.rst btrfs-progs: docs: add more chapters (part 3) 2021-12-17 15:35:10 +01:00
Swapfile.rst btrfs-progs: docs: swapfile and hibernation 2022-12-06 23:19:12 +01:00
Tree-checker.rst btrfs-progs: docs: fix typos 2022-12-07 21:00:25 +01:00
Trim.rst btrfs-progs: docs: updates 2023-08-28 17:24:25 +02:00
Volume-management.rst btrfs-progs: docs: add more chapters (part 3) 2021-12-17 15:35:10 +01:00
Zoned-mode.rst btrfs-progs: docs: add more chapters (part 3) 2021-12-17 15:35:10 +01:00
btrfs-balance.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-check.rst btrfs-progs: move space cache removal to rescue group 2023-11-03 18:04:37 +01:00
btrfs-convert.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-device.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-filesystem.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-find-root.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-image.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-inspect-internal.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-ioctl.rst btrfs-progs: docs: updates 2023-09-12 23:18:35 +02:00
btrfs-man5.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-map-logical.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-property.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-qgroup.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-quota.rst btrfs-progs: docs: document squota 2023-10-03 01:11:54 +02:00
btrfs-receive.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-replace.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-rescue.rst btrfs-progs: move space cache removal to rescue group 2023-11-03 18:04:37 +01:00
btrfs-restore.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-scrub.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-select-super.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-send.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-subvolume.rst btrfs-progs: subvolume create: add option -p option to create parent directories 2023-10-21 15:51:07 +02:00
btrfs.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfsck.8
btrfstune.rst btrfs-progs: docs: updates 2023-09-12 23:18:35 +02:00
ch-balance-examples.rst btrfs-progs: docs: add balance filter examples 2023-06-09 12:44:03 +02:00
ch-balance-filters.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-balance-intro.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-bootloaders.rst btrfs-progs: docs: fixups, references 2023-06-01 20:50:04 +02:00
ch-checksumming.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-compression.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-convert-intro.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-file-attributes.rst btrfs-progs: docs: updates 2023-09-12 23:18:35 +02:00
ch-flexibility.rst btrfs-progs: docs: fixups, references 2023-06-01 20:50:04 +02:00
ch-fs-limits.rst btrfs-progs: docs: fixups, references 2023-06-01 20:50:04 +02:00
ch-hardware-considerations.rst btrfs-progs: docs: typo fixups and formatting updates 2022-12-22 18:44:47 +01:00
ch-mount-options.rst btrfs-progs: docs: updates 2023-09-12 23:18:35 +02:00
ch-quota-intro.rst btrfs-progs: docs: document squota 2023-10-03 01:11:54 +02:00
ch-scrub-intro.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-seeding-device.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-subvolume-intro.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-swapfile.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-sysfs.rst btrfs-progs: docs: fixups, references 2023-06-01 20:50:04 +02:00
ch-volume-management-intro.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-zoned-intro.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
conf.py btrfs-progs: docs: drop copyright year from manual pages 2023-01-25 16:19:51 +01:00
fsck.btrfs.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
index.rst btrfs-progs: docs: updates 2023-08-28 17:24:25 +02:00
man-index.rst btrfs-progs: docs: drop indices from pages 2021-11-26 00:48:24 +01:00
mkfs.btrfs.rst btrfs-progs: mkfs: add option to specify device uuid 2023-10-21 15:51:07 +02:00
trouble-index.rst btrfs-progs: docs: use command role for programs or command lines 2023-04-27 01:48:47 +02:00