btrfs-progs: fsck: Add more explanation on low memory mode
diff mbox

Message ID 1463710867-27127-1-git-send-email-quwenruo@cn.fujitsu.com
State New
Headers show

Commit Message

Qu Wenruo May 20, 2016, 2:21 a.m. UTC
It seems the initial support for low memory mode will come in recent
release, it's better to add more explanation on the unsupported
functions, to avoid user reporting known bugs.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 Documentation/btrfs-check.asciidoc | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

Comments

David Sterba June 1, 2016, 1:55 p.m. UTC | #1
On Fri, May 20, 2016 at 10:21:07AM +0800, Qu Wenruo wrote:
> It seems the initial support for low memory mode will come in recent
> release, it's better to add more explanation on the unsupported
> functions, to avoid user reporting known bugs.
> 
> Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
> ---
>  Documentation/btrfs-check.asciidoc | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/btrfs-check.asciidoc b/Documentation/btrfs-check.asciidoc
> index 4e27863..6b09662 100644
> --- a/Documentation/btrfs-check.asciidoc
> +++ b/Documentation/btrfs-check.asciidoc
> @@ -97,7 +97,14 @@ NOTE: Do not use unless you know what you're doing.
>  check fs in low memory usage mode(experimental)
>  May takes longer time than normal check.
>  +
> -NOTE: Doesn't work with '--repair' option yet.
> +[NOTE]
> +==========================
> +As this feature is still under development, some functions are not implemented
> +yet
> +
> +- No support for '--repair' yet.
> +- Only reduce memory usage of extent tree check. No effect for fs tree yet.
> +==========================

The help text is too short to be useful, I'd like to see something more
comprehensive so the user knows what the low-mem mode does compared to
the current state.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch
diff mbox

diff --git a/Documentation/btrfs-check.asciidoc b/Documentation/btrfs-check.asciidoc
index 4e27863..6b09662 100644
--- a/Documentation/btrfs-check.asciidoc
+++ b/Documentation/btrfs-check.asciidoc
@@ -97,7 +97,14 @@  NOTE: Do not use unless you know what you're doing.
 check fs in low memory usage mode(experimental)
 May takes longer time than normal check.
 +
-NOTE: Doesn't work with '--repair' option yet.
+[NOTE]
+==========================
+As this feature is still under development, some functions are not implemented
+yet
+
+- No support for '--repair' yet.
+- Only reduce memory usage of extent tree check. No effect for fs tree yet.
+==========================
 
 EXIT STATUS
 -----------