Reword the option descriptions in xable-{bus,dimm,region}-options.txt to
clarify that the options are a filtering restriction rather than a
directive to perform an action on the supplied objects, especially in
case of the 'all' keyword.Link: https://github.com/pmem/ndctl/issues/106 Cc: Jeff Moyer <[email protected]> Reported-by: Steve Scargal <[email protected]> Reported-by: Dan Williams <[email protected]> Signed-off-by: Vishal Verma <[email protected]> --- Documentation/ndctl/xable-bus-options.txt | 7 ++++--- Documentation/ndctl/xable-dimm-options.txt | 7 ++++--- Documentation/ndctl/xable-region-options.txt | 7 ++++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/Documentation/ndctl/xable-bus-options.txt b/Documentation/ndctl/xable-bus-options.txt index 8813113..6e0435a 100644 --- a/Documentation/ndctl/xable-bus-options.txt +++ b/Documentation/ndctl/xable-bus-options.txt @@ -1,4 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -Enforce that the operation only be carried on devices that are -attached to the given bus. Where 'bus' can be a provider name or a bus -id number. +A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the +operation to the specified bus(es). The keyword 'all' can be specified +to indicate the lack of any restriction, however this is the same as +not supplying a --bus option at all. diff --git a/Documentation/ndctl/xable-dimm-options.txt b/Documentation/ndctl/xable-dimm-options.txt index 8826c2b..c5b9c8c 100644 --- a/Documentation/ndctl/xable-dimm-options.txt +++ b/Documentation/ndctl/xable-dimm-options.txt @@ -1,4 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -A 'nmemX' device name, or a dimm id number. The keyword 'all' can -be specified to carry out the operation on every dimm in the system, -optionally filtered by bus id (see --bus= option). +A 'nmemX' device name, or a dimm id number. Restrict the operation to +the specified dimm(s). The keyword 'all' can be specified to indicate +the lack of any restriction, however this is the same as not supplying +a --dimm option at all. diff --git a/Documentation/ndctl/xable-region-options.txt b/Documentation/ndctl/xable-region-options.txt index d5198f5..e098684 100644 --- a/Documentation/ndctl/xable-region-options.txt +++ b/Documentation/ndctl/xable-region-options.txt @@ -1,4 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -A 'regionX' device name, or a region id number. The keyword 'all' can -be specified to carry out the operation on every region in the system, -optionally filtered by bus id (see --bus= option). +A 'regionX' device name, or a region id number. Restrict the operation to +the specified region(s). The keyword 'all' can be specified to indicate +the lack of any restriction, however this is the same as not supplying a +--region option at all. -- 2.20.1 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
