From patchwork Wed Mar 14 22:26:41 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vishal Verma X-Patchwork-Id: 10283667 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id C2E26602C2 for ; Wed, 14 Mar 2018 22:26:50 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A798E286D0 for ; Wed, 14 Mar 2018 22:26:50 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 9C34A286D4; Wed, 14 Mar 2018 22:26:50 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received: from ml01.01.org (ml01.01.org [198.145.21.10]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 253E3286D0 for ; Wed, 14 Mar 2018 22:26:49 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id F0DBC2228352E; Wed, 14 Mar 2018 15:20:25 -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.93; helo=mga11.intel.com; envelope-from=vishal.l.verma@intel.com; receiver=linux-nvdimm@lists.01.org Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) (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 1AAFB21E49035 for ; Wed, 14 Mar 2018 15:20:23 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 14 Mar 2018 15:26:45 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.48,307,1517904000"; d="scan'208";a="25768906" Received: from vverma7-desk1.lm.intel.com ([10.232.112.218]) by orsmga006.jf.intel.com with ESMTP; 14 Mar 2018 15:26:44 -0700 From: Vishal Verma To: Subject: [ndctl PATCH v2] ndctl, docs: cleanup the man page for create-namespace Date: Wed, 14 Mar 2018 16:26:41 -0600 Message-Id: <20180314222641.2826-1-vishal.l.verma@intel.com> X-Mailer: git-send-email 2.14.3 X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP Clean up some rendering artifacts in the man page for ndctl-create-namespace. Cc: Dan Williams Reviewed-by: Dan Williams Signed-off-by: Vishal Verma --- Documentation/ndctl/ndctl-create-namespace.txt | 54 +++++++++++++------------- 1 file changed, 26 insertions(+), 28 deletions(-) v2: Make the "In the latter case.." paragraph a continuation of the first bullet. diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt index c8b1c99..8de6689 100644 --- a/Documentation/ndctl/ndctl-create-namespace.txt +++ b/Documentation/ndctl/ndctl-create-namespace.txt @@ -171,32 +171,31 @@ OPTIONS Section 6.5.10 NVDIMM Label Methods) support "labelled namespace" operation. - There are two cases where the kernel will default to - label-less operation: - - * NVDIMM does not support labels - - * The NVDIMM supports labels, but the Label Index Block (see - UEFI 2.7) is not present and there is no capacity aliasing - between 'blk' and 'pmem' regions. - - In the latter case the configuration can be upgraded to - labelled operation by writing an index block on all DIMMs in a - region and re-enabling that region. The 'autolabel' capability - of 'ndctl create-namespace --reconfig' tries to do this by - default if it can determine that all DIMM capacity is - referenced by the namespace being reconfigured. It will - otherwise fail to autolabel and remain in label-less mode if - it finds a DIMM contributes capacity to more than one region. - This check prevents inadvertent data loss of that other region - is in active use. The --autolabel option is implied by - default, the --no-autolabel option can be used to disable this - behavior. When automatic labeling fails and labelled operation - is still desired the safety policy can be bypassed by the - following commands, note that all data on all regions is - forfeited by running these commands: - - [verse] + - There are two cases where the kernel will default to + label-less operation: + + * NVDIMM does not support labels + + * The NVDIMM supports labels, but the Label Index Block (see + UEFI 2.7) is not present and there is no capacity aliasing + between 'blk' and 'pmem' regions. + + - In the latter case the configuration can be upgraded to + labelled operation by writing an index block on all DIMMs in a + region and re-enabling that region. The 'autolabel' capability + of 'ndctl create-namespace --reconfig' tries to do this by + default if it can determine that all DIMM capacity is + referenced by the namespace being reconfigured. It will + otherwise fail to autolabel and remain in label-less mode if + it finds a DIMM contributes capacity to more than one region. + This check prevents inadvertent data loss of that other region + is in active use. The --autolabel option is implied by + default, the --no-autolabel option can be used to disable this + behavior. When automatic labeling fails and labelled operation + is still desired the safety policy can be bypassed by the + following commands, note that all data on all regions is + forfeited by running these commands: + ndctl disable-region all ndctl init-labels all ndctl enable-region all @@ -222,5 +221,4 @@ linkndctl:ndctl-zero-labels[1], linkndctl:ndctl-init-labels[1], linkndctl:ndctl-disable-namespace[1], linkndctl:ndctl-enable-namespace[1], -http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf[UEFI NVDIMM Label Protocol -] +http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf[UEFI NVDIMM Label Protocol]