From: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
To: linux-btrfs@vger.kernel.org
Cc: calestyo@scientia.net
Subject: [PATCH] improve documentation of snapshot unaware defrag
Date: Sun, 27 Dec 2015 04:03:27 +0100 [thread overview]
Message-ID: <1451185407-11422-1-git-send-email-mail@christoph.anton.mitterer.name> (raw)
In-Reply-To: <CAL3q7H6TGU2rz+zP8hcHxaDGx47nTrCndYvP9ArS+Z0HmZ86=A@mail.gmail.com>
In btrfs-filesystem(8), improved the documentation of snapshot unaware
defragmentation and included the exact kernel version numbers being affected as
well as the possible effects.
No longer use th word "unlink" which is easily understood as "deleting a file".
Moved the warning more to the beginning of "defragment" subcommand's
documentation where it's more visible to readers.
Added the same warning to the "autodefrag" option of btrfs-mount(5).
Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
---
Documentation/btrfs-filesystem.asciidoc | 11 +++++++----
Documentation/btrfs-mount.asciidoc | 7 +++++++
2 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/Documentation/btrfs-filesystem.asciidoc b/Documentation/btrfs-filesystem.asciidoc
index 31cd51b..600bbac 100644
--- a/Documentation/btrfs-filesystem.asciidoc
+++ b/Documentation/btrfs-filesystem.asciidoc
@@ -55,6 +55,13 @@ if the free space is too fragmented.
Use 0 to take the kernel default, which is 256kB but may change in the future.
You can also turn on compression in defragment operations.
+
+WARNING: Defragmenting with Linux kernel versions < 3.9 or ≥ 3.14-rc2 as well as
+with Linux stable kernel versions ≥ 3.10.31, ≥ 3.12.12 or ≥ 3.13.4 will break up
+the ref-links of CoW data (for example files copied with `cp --reflink`,
+snapshots or de-duplicated data).
+This may cause considerable increase of space usage depending on the broken up
+ref-links.
++
`Options`
+
-v::::
@@ -79,10 +86,6 @@ target extent size, do not touch extents bigger than <size>
For <start>, <len>, <size> it is possible to append
units designator: \'K', \'M', \'G', \'T', \'P', or \'E', which represent
KiB, MiB, GiB, TiB, PiB, or EiB, respectively. Case does not matter.
-+
-WARNING: defragmenting with kernels up to 2.6.37 will unlink COW-ed copies of data,
-don't use it if you use snapshots, have de-duplicated your data or made
-copies with `cp --reflink`.
*label* [<dev>|<mountpoint>] [<newlabel>]::
Show or update the label of a filesystem.
diff --git a/Documentation/btrfs-mount.asciidoc b/Documentation/btrfs-mount.asciidoc
index 39215a8..d364594 100644
--- a/Documentation/btrfs-mount.asciidoc
+++ b/Documentation/btrfs-mount.asciidoc
@@ -26,6 +26,13 @@ MOUNT OPTIONS
Auto defragmentation detects small random writes into files and queue
them up for the defrag process. Works best for small files;
Not well suited for large database workloads.
+ +
+ WARNING: Defragmenting with Linux kernel versions < 3.9 or ≥ 3.14-rc2 as
+ well as with Linux stable kernel versions ≥ 3.10.31, ≥ 3.12.12 or
+ ≥ 3.13.4 will break up the ref-links of CoW data (for example files
+ copied with `cp --reflink`, snapshots or de-duplicated data).
+ This may cause considerable increase of space usage depending on the
+ broken up ref-links.
*check_int*::
*check_int_data*::
--
2.6.4
next prev parent reply other threads:[~2015-12-27 3:08 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-21 1:26 defrag vs autodefrag Donald Pearson
2015-12-21 3:22 ` Duncan
2015-12-21 8:14 ` Hugo Mills
2015-12-21 9:28 ` Filipe Manana
2015-12-22 20:16 ` Christoph Anton Mitterer
2015-12-22 20:30 ` Hugo Mills
2015-12-23 2:16 ` Duncan
2015-12-27 3:03 ` Christoph Anton Mitterer [this message]
2015-12-27 3:10 ` [PATCH] improve documentation of snapshot unaware defrag Christoph Anton Mitterer
2015-12-27 7:09 ` Duncan
2015-12-28 0:50 ` Christoph Anton Mitterer
2015-12-28 1:58 ` Hugo Mills
2015-12-28 2:07 ` Christoph Anton Mitterer
2015-12-28 9:12 ` Duncan
2015-12-28 2:51 ` Duncan
2015-12-28 3:03 ` Christoph Anton Mitterer
2015-12-28 6:12 ` Duncan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1451185407-11422-1-git-send-email-mail@christoph.anton.mitterer.name \
--to=mail@christoph.anton.mitterer.name \
--cc=calestyo@scientia.net \
--cc=linux-btrfs@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).