From patchwork Wed Mar 29 05:01:46 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Williams X-Patchwork-Id: 9650903 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 21432602BE for ; Wed, 29 Mar 2017 05:06:58 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id EEEC928447 for ; Wed, 29 Mar 2017 05:06:57 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id E3D1C28452; Wed, 29 Mar 2017 05:06:57 +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.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=no 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 AFACB28447 for ; Wed, 29 Mar 2017 05:06:57 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 8395E20D2C3BA; Tue, 28 Mar 2017 22:06:57 -0700 (PDT) X-Original-To: linux-nvdimm@lists.01.org Delivered-To: linux-nvdimm@lists.01.org Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) (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 DAC792041FBD0 for ; Tue, 28 Mar 2017 22:06:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=intel.com; i=@intel.com; q=dns/txt; s=intel; t=1490764016; x=1522300016; h=subject:from:to:date:message-id:mime-version: content-transfer-encoding; bh=vCsFr5rH/sMZYNZ+2aNImjjynlh4lf9TJ1Vx18SkMPE=; b=OIPDJMQTlV61F6nmHLq9KyrG5UZo7TRG8nb5DunGUhXMi/kk/ftUx04Y 0Jb/ztgOoL1XlgFC8lyYoQcYXoAxsw==; Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Mar 2017 22:06:56 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.36,239,1486454400"; d="scan'208";a="949273329" Received: from dwillia2-desk3.jf.intel.com (HELO dwillia2-desk3.amr.corp.intel.com) ([10.54.39.125]) by orsmga003.jf.intel.com with ESMTP; 28 Mar 2017 22:06:56 -0700 Subject: [ndctl PATCH] Documentation, write-labels: add man page From: Dan Williams To: linux-nvdimm@lists.01.org Date: Tue, 28 Mar 2017 22:01:46 -0700 Message-ID: <149076370694.25786.17308120640237891256.stgit@dwillia2-desk3.amr.corp.intel.com> User-Agent: StGit/0.17.1-9-g687f MIME-Version: 1.0 X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP Unlike read-labels, the write-labels command is meant to be run against one dimm at a time. This hopefully avoids confusion trying to match input files to output devices. Signed-off-by: Dan Williams --- Documentation/Makefile.am | 1 + Documentation/ndctl-write-labels.txt | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 Documentation/ndctl-write-labels.txt diff --git a/Documentation/Makefile.am b/Documentation/Makefile.am index eea11e087012..d72085df4845 100644 --- a/Documentation/Makefile.am +++ b/Documentation/Makefile.am @@ -2,6 +2,7 @@ man1_MANS = \ ndctl.1 \ ndctl-zero-labels.1 \ ndctl-read-labels.1 \ + ndctl-write-labels.1 \ ndctl-init-labels.1 \ ndctl-check-labels.1 \ ndctl-enable-region.1 \ diff --git a/Documentation/ndctl-write-labels.txt b/Documentation/ndctl-write-labels.txt new file mode 100644 index 000000000000..bace46fba160 --- /dev/null +++ b/Documentation/ndctl-write-labels.txt @@ -0,0 +1,29 @@ +ndctl-write-labels(1) +===================== + +NAME +---- +ndctl-write-labels - write data to the label area on a dimm + +SYNOPSIS +-------- +[verse] +'ndctl write-labels [-i ]' + +include::labels-description.txt[] +Read data from the input filename, or stdin, and write it to the given + device. Note that the device must not be active in any region, +otherwise the kernel will not allow write access to the device's label +data area. + +OPTIONS +------- +include::labels-options.txt[] +-i:: +--input:: + input file + +SEE ALSO +-------- +http://pmem.io/documents/NVDIMM_Namespace_Spec.pdf[NVDIMM Namespace +Specification]