From 29017208b890784ffd6303420848c5f069d94b22 Mon Sep 17 00:00:00 2001 From: Christopher Yeleighton Date: Mon, 26 Dec 2022 12:32:14 +0100 Subject: [PATCH] btrfs-progs: docs: describe formatting of sizes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Input must be prepared and output must be interpreted under the C locale, which requires special precautions on the client’s side. Pull-request: #561 Author: Christopher Yeleighton Signed-off-by: David Sterba --- Documentation/btrfs.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/btrfs.rst b/Documentation/btrfs.rst index e3aab4fd..81f418dd 100644 --- a/Documentation/btrfs.rst +++ b/Documentation/btrfs.rst @@ -35,6 +35,12 @@ both as **filesystem show** and as **filesystem sync**. If the command name is ambiguous, the list of conflicting options is printed. +*Sizes*, both upon input and output, can be expressed in either SI or IEC-I +units (see `numfmt(1) `_) +with the suffix `B` appended. +All numbers will be formatted according to the rules of the `C` locale +(ignoring the shell locale, see `locale(7) `_). + For an overview of a given command use **btrfs command --help** or **btrfs [command...] --help --full** to print all available options.