From patchwork Thu Aug 29 00:17:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Verma, Vishal L" X-Patchwork-Id: 11120113 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id EA9A6174A for ; Thu, 29 Aug 2019 00:17:44 +0000 (UTC) Received: from ml01.01.org (ml01.01.org [198.145.21.10]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id D3F8F2189D for ; Thu, 29 Aug 2019 00:17:44 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org D3F8F2189D Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=intel.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-nvdimm-bounces@lists.01.org Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 65B9D2194EB7D; Wed, 28 Aug 2019 17:19:42 -0700 (PDT) X-Original-To: linux-nvdimm@lists.01.org Delivered-To: linux-nvdimm@lists.01.org Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.43; helo=mga05.intel.com; envelope-from=vishal.l.verma@intel.com; receiver=linux-nvdimm@lists.01.org Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 20F5A2021B711 for ; Wed, 28 Aug 2019 17:19:41 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Aug 2019 17:17:42 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,442,1559545200"; d="scan'208";a="356285454" Received: from vverma7-desk1.lm.intel.com ([10.232.112.185]) by orsmga005.jf.intel.com with ESMTP; 28 Aug 2019 17:17:41 -0700 From: Vishal Verma To: Subject: [ndctl PATCH 2/3] Documentation: clarify bus/dimm/region filtering Date: Wed, 28 Aug 2019 18:17:34 -0600 Message-Id: <20190829001735.30289-3-vishal.l.verma@intel.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190829001735.30289-1-vishal.l.verma@intel.com> References: <20190829001735.30289-1-vishal.l.verma@intel.com> MIME-Version: 1.0 X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Steve Scargall Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" 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 Reported-by: Steve Scargal Reported-by: Dan Williams Signed-off-by: Vishal Verma --- 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.