btrfs-progs/Documentation
Colin Snover 66f08f9528 btrfs-progs: docs: enhance the scrub chapter
- Explain that scrub is device based

- Add extra warning on NOCOW files
  Which implies NODATASUM, and can cause unexpected stale data to be
  returned.

- Explain the limitation of scrub
  As it can only do very basic checksum verification and very basic
  mirror based repair.

Signed-off-by: Colin Snover <csnover@users.noreply.github.com>
[ Add an SoB line and commit message, remove the mention of btrfs-check errors,
  as there is no evidence/example where btrfs-check failed to choose a good mirror. ]
Signed-off-by: Qu Wenruo <wqu@suse.com>
2024-11-04 18:31:38 +10:30
..
_static btrfs-progs: docs: restyle the landing page 2023-12-01 00:54:27 +01:00
_templates btrfs-progs: docs: update template, more about subvolumes 2022-01-11 15:46:33 +01:00
dev btrfs-progs: docs: Added DEV_ITEM object id. 2024-10-29 10:17:26 +10:30
Administration.rst btrfs-progs: docs: include sysfs to Administration 2024-07-30 20:05:11 +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: cross references, ioctl updates 2023-12-06 17:44:28 +01:00
Compression.rst btrfs-progs: docs: add more chapters 2021-12-17 11:53:44 +01:00
Contributors.rst btrfs-progs: docs: add 6.11 kernel development statistics 2024-09-17 16:19:03 +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: run codespell throughout fixing typos automagically 2024-07-30 19:56:08 +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: run codespell throughout fixing typos automagically 2024-07-30 19:56:08 +02:00
Feature-by-version.rst btrfs-progs: run codespell throughout fixing typos automagically 2024-07-30 19:56:08 +02:00
Glossary.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01: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: inline files vs tail packing 2024-09-17 16:47:42 +02:00
Interoperability.rst btrfs-progs: docs: list supported fs-verity ioctls 2024-07-30 20:05:11 +02:00
Introduction.rst btrfs-progs: docs: cross references, ioctl updates 2023-12-06 17:44:28 +01:00
Kernel-by-version.rst btrfs-progs: fix the typo inside kernel-by-version.rst 2024-10-29 09:39:09 +10:30
Makefile.in btrfs-progs: install btrfs-ioctl manual page 2024-09-17 14:33:22 +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: clarify btrfs-send checksum 2024-08-14 23:59:47 +02:00
Source-repositories.rst btrfs-progs: docs: update source repositories, workflows 2024-07-30 20:05:11 +02:00
Status.rst btrfs-progs: docs: update feature status 2024-09-17 16:19:03 +02:00
Subpage.rst btrfs-progs: docs: mkfs and sectorsize updates 2024-01-18 02:44:58 +01: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 sphinx code-block warnings 2024-01-10 22:49:06 +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: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
btrfs-check.rst btrfs-progs: docs: clarify how btrfs check works with replicas 2024-11-04 18:31:38 +10:30
btrfs-convert.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-device.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
btrfs-filesystem.rst btrfs-progs: fi resize: warn if new size is < 256M 2024-09-17 16:19:03 +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: add warning for -s option of btrfs-image 2024-07-30 19:56:41 +02:00
btrfs-inspect-internal.rst btrfs-progs: list-chunks: update help and documentation 2024-07-30 19:53:33 +02:00
btrfs-ioctl.rst btrfs-progs: docs: add new encoded rw ioctls to the list 2024-07-30 20:05:11 +02:00
btrfs-man5.rst btrfs-progs: install btrfs-ioctl manual page 2024-09-17 14:33:22 +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: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
btrfs-qgroup.rst btrfs-progs: clarify unlinked and deleted terminology for subvolumes 2024-05-17 18:13:18 +02:00
btrfs-quota.rst btrfs-progs: docs: document squota 2023-10-03 01:11:54 +02:00
btrfs-receive.rst btrfs-progs: docs: clarify receive --dump encoding 2024-06-24 19:19:04 +02:00
btrfs-replace.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
btrfs-rescue.rst btrfs-progs: check: remove inode cache clearing functionality 2023-12-05 17:57:04 +01:00
btrfs-restore.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
btrfs-scrub.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01: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 delete: add new option for recursive deletion 2024-09-17 17:00:03 +02:00
btrfs.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
btrfsck.8
btrfstune.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01: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: recalculate checksumming performance 2024-02-13 07:15:31 +01:00
ch-compression.rst btrfs-progs: docs: fix incorrect description about compression with O_DIRECT 2024-03-25 22:57:50 +01:00
ch-convert-intro.rst btrfs-progs: docs: clarify potential problems with convert 2024-02-20 10:52:08 +01:00
ch-file-attributes.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
ch-flexibility.rst btrfs-progs: docs: fixups, references 2023-06-01 20:50:04 +02:00
ch-fs-limits.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
ch-hardware-considerations.rst btrfs-progs: docs: update memory related problems 2024-03-25 23:33:25 +01:00
ch-mount-options.rst btrfs-progs: docs: update the rescue mount options 2024-06-24 19:20:18 +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: enhance the scrub chapter 2024-11-04 18:31:38 +10:30
ch-seeding-device.rst btrfs-progs: docs: formatting updates 2023-07-26 14:59:10 +02:00
ch-subvolume-intro.rst btrfs-progs: docs: fix new typos 2024-08-14 23:58:14 +02:00
ch-swapfile.rst btrfs-progs: docs: clarify swapfile an multi-device filesystem 2024-07-30 20:05:11 +02:00
ch-sysfs.rst btrfs-progs: docs: fix new typos 2024-08-14 23:58:14 +02:00
ch-volume-management-intro.rst btrfs-procs: docs: add warning about balance to replace failing device 2024-11-04 18:31:38 +10:30
ch-zoned-intro.rst btrfs-progs: docs: add zone reclaim 2024-07-30 20:05:11 +02:00
conf.py btrfs-progs: install btrfs-ioctl manual page 2024-09-17 14:33:22 +02:00
fsck.btrfs.rst btrfs-progs: docs: use manref role for all manual page references 2024-02-16 09:38:16 +01:00
html-preview.sh btrfs-progs: ci: build html manual page previews if source changed 2024-07-30 19:53:32 +02:00
index.rst btrfs-progs: docs: say where to get help 2024-11-04 16:11:06 +10:30
man-index.rst btrfs-progs: install btrfs-ioctl manual page 2024-09-17 14:33:22 +02:00
man-preview.sh btrfs-progs: run codespell throughout fixing typos automagically 2024-07-30 19:56:08 +02:00
mkfs.btrfs.rst btrfs-progs: mkfs: rework --subvol CLI option 2024-10-10 14:14:32 +10:30
plot-contribs.svg btrfs-progs: docs: update 6.11 contribution graphs 2024-10-15 23:39:08 +02:00
plot-patches.svg btrfs-progs: docs: update 6.11 contribution graphs 2024-10-15 23:39:08 +02:00
plot-sloc-lines.svg btrfs-progs: docs: update 6.11 contribution graphs 2024-10-15 23:39:08 +02:00
requirements.txt btrfs-progs: docs: add config file for readthedocs.io 2023-12-05 16:36:24 +01:00
trouble-index.rst btrfs-progs: docs: clarify transid verify error recoverability 2024-11-04 18:31:37 +10:30