In preparation for inject-error, move the --human option description to a file that can be included. Reword the description improving the grammar, and making it more generic.
The example in the list man page for --human was also missing a [verse] keyword, making the --human part of the example appear in a single line rather than formatted json - fix that. Cc: Dan Williams <[email protected]> Signed-off-by: Vishal Verma <[email protected]> --- Documentation/ndctl/human-option.txt | 5 +++++ Documentation/ndctl/ndctl-list.txt | 8 ++------ 2 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 Documentation/ndctl/human-option.txt diff --git a/Documentation/ndctl/human-option.txt b/Documentation/ndctl/human-option.txt new file mode 100644 index 0000000..ce2fefa --- /dev/null +++ b/Documentation/ndctl/human-option.txt @@ -0,0 +1,5 @@ +-u:: +--human:: + Format numbers representing storage sizes, or offsets as human + readable strings with units instead of the default machine-friendly + raw-integer data. Convert other numeric fields into hexadecimal strings. diff --git a/Documentation/ndctl/ndctl-list.txt b/Documentation/ndctl/ndctl-list.txt index cdcf238..e19ded8 100644 --- a/Documentation/ndctl/ndctl-list.txt +++ b/Documentation/ndctl/ndctl-list.txt @@ -180,12 +180,7 @@ include::xable-region-options.txt[] ] } --u:: ---human:: - By default 'ndctl list' will output machine-friendly raw-integer - data. Instead, with this flag, numbers representing storage size - will be formatted as human readable strings with units, other - fields are converted to hexadecimal strings. Example: +include::human-option.txt[] [verse] # ndctl list --region=7 @@ -198,6 +193,7 @@ include::xable-region-options.txt[] "badblock_count":8 } +[verse] # ndctl list --human --region=7 { "dev":"region7", -- 2.9.5 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
