diff mbox

[1/2] ndctl: add information about size suffixes to docs

Message ID 1478726177-21904-1-git-send-email-ross.zwisler@linux.intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ross Zwisler Nov. 9, 2016, 9:16 p.m. UTC
Add information about the supported size suffixes to the documentation for
ndctl-create-namespace.  This prevents users from doing silly things like
$((32*1024*1024*1024)) on the command line when running ndctl commands.

Signed-off-by: Ross Zwisler <ross.zwisler@linux.intel.com>
---
 Documentation/ndctl-create-namespace.txt | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Dan Williams Nov. 9, 2016, 11:47 p.m. UTC | #1
On Wed, Nov 9, 2016 at 1:16 PM, Ross Zwisler
<ross.zwisler@linux.intel.com> wrote:
> Add information about the supported size suffixes to the documentation for
> ndctl-create-namespace.  This prevents users from doing silly things like
> $((32*1024*1024*1024)) on the command line when running ndctl commands.
>
> Signed-off-by: Ross Zwisler <ross.zwisler@linux.intel.com>
> ---
>  Documentation/ndctl-create-namespace.txt | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/ndctl-create-namespace.txt b/Documentation/ndctl-create-namespace.txt
> index a2f5e5b..5b62b95 100644
> --- a/Documentation/ndctl-create-namespace.txt
> +++ b/Documentation/ndctl-create-namespace.txt
> @@ -79,8 +79,10 @@ OPTIONS
>  -s::
>  --size=::
>         For NVDIMM devices that support namespace labels, set the
> -       namespace size.  Otherwise it defaults to the maximum size
> -       specified by platform firmware.
> +       namespace size in bytes.  Otherwise it defaults to the maximum
> +       size specified by platform firmware.  This option supports the
> +       suffixes "k" or "K" for KiB, "m" or "M" for MiB, "g" or "G" for
> +       GiB and "t" or "T" for TiB.
>
>  -e::
>  --reconfig=::


Thanks Ross. Applied.
diff mbox

Patch

diff --git a/Documentation/ndctl-create-namespace.txt b/Documentation/ndctl-create-namespace.txt
index a2f5e5b..5b62b95 100644
--- a/Documentation/ndctl-create-namespace.txt
+++ b/Documentation/ndctl-create-namespace.txt
@@ -79,8 +79,10 @@  OPTIONS
 -s::
 --size=::
 	For NVDIMM devices that support namespace labels, set the
-	namespace size.  Otherwise it defaults to the maximum size
-	specified by platform firmware.
+	namespace size in bytes.  Otherwise it defaults to the maximum
+	size specified by platform firmware.  This option supports the
+	suffixes "k" or "K" for KiB, "m" or "M" for MiB, "g" or "G" for
+	GiB and "t" or "T" for TiB.
 
 -e::
 --reconfig=::