From patchwork Mon Aug 6 21:21:30 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masayoshi Mizuma X-Patchwork-Id: 10557969 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 3FAB415A6 for ; Mon, 6 Aug 2018 21:21:50 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2E59B29BCC for ; Mon, 6 Aug 2018 21:21:50 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 220EE29BFE; Mon, 6 Aug 2018 21:21: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=-2.8 required=2.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, T_DKIM_INVALID 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 C398F29BCC for ; Mon, 6 Aug 2018 21:21:49 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 69AED210DBE73; Mon, 6 Aug 2018 14:21:49 -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=2607:f8b0:400d:c0d::242; helo=mail-qt0-x242.google.com; envelope-from=msys.mizuma@gmail.com; receiver=linux-nvdimm@lists.01.org Received: from mail-qt0-x242.google.com (mail-qt0-x242.google.com [IPv6:2607:f8b0:400d:c0d::242]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 28791210DBE70 for ; Mon, 6 Aug 2018 14:21:47 -0700 (PDT) Received: by mail-qt0-x242.google.com with SMTP id h4-v6so15589651qtj.7 for ; Mon, 06 Aug 2018 14:21:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id; bh=1P17TOs17GNKDt8L5OrFjVIsqKNpRL2dw0ISEG8PIQg=; b=cheLrSHKLu+iSmWHcI90XiwoKNyB+dxFYJ17NzJG+l4KqS6ELnY7QATQyQNjbmcgvr 7SyzBSlz1SFo5z0KI9ZvXz+J+PiwGFpuru9AyY8j2Rhq9BaluXR/IAskYiVjD1HFuzzZ pGr+73AgBS0ZDfclzjv07tMFtLU0hQzoYPVhaXLlUrg2KsMuf2cFkGXDyDWSkeNW+VXe 2XJPnIsuxLTiyem6YywbxpPECEknNzlHc6NLgFaxBtY07LRAl8JdxR4CQwrAkcaAxfxH M9qTiXAByIJtN7/cNQH7EZk5faKdfiUS87WhtntJTQJsGc2ZeAWwZJkAfiHGx2hwN5tT tUjA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=1P17TOs17GNKDt8L5OrFjVIsqKNpRL2dw0ISEG8PIQg=; b=rAYIy7ovvh7y810OKG1tbHlm6nuatOQmTfTbJEUBIxp3rFIR1GDFf3gTzdXtJsWIdT tW5o11Jv2j19iI/BzaP1ugDTVIqlxL6qBxFoyc1+tKqndLUf2G9XbkAl+C2NUsrzFnEQ 6quILzjnxLk97sk72GDuChT1YEQyUlg9HQP4hH5MundwpBNz5/9pontwrC2uIRODG3sj FiJPzHVib7H8653P7JOffTJ42V8YYXtsbaytHtpKcPhFo7Sl2Nbn+v28n/ahrYkhcjfT BmOOGq6MLMlTXTiP9GUePz7qSiNTjJ/21rD0v/Hz+67yqHMumD3fQ5EFHZRA60fsQ+yC FReQ== X-Gm-Message-State: AOUpUlG9kCnkgDNlL5oBVd1y7OvbEkxT1FVwjLeN+R6cSOHjzrftSVzl QpDMonsZ9Lp+IiEh50ihhXWcpmw= X-Google-Smtp-Source: AAOMgpdPGKIwFUGHqYcyZFU8GbHzBGThLzayPrCv9hk7q3EI1QcKyXWBj4ItZQx/UDdHiYKtDHIEjA== X-Received: by 2002:aed:24b0:: with SMTP id t45-v6mr16208830qtc.86.1533590506992; Mon, 06 Aug 2018 14:21:46 -0700 (PDT) Received: from gabell.bos.redhat.com (nat-pool-bos-t.redhat.com. [66.187.233.206]) by smtp.gmail.com with ESMTPSA id k89-v6sm7620408qte.14.2018.08.06.14.21.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 06 Aug 2018 14:21:46 -0700 (PDT) From: Masayoshi Mizuma To: linux-nvdimm@lists.01.org Subject: [PATCH] ndctl, documentation: Clarify the dimm id for ndctl list d option Date: Mon, 6 Aug 2018 17:21:30 -0400 Message-Id: <20180806212130.1605-1-msys.mizuma@gmail.com> X-Mailer: git-send-email 2.17.1 X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Masayoshi Mizuma MIME-Version: 1.0 Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP From: Masayoshi Mizuma User may be confused the dimm id description of ndctl list -d option because ndctl list says id, but the id is not useful to d option. ]# ndctl list -d nmem7 | jq -r .id cdab-0a-07e0-fefffeff ]# ndctl list -d cdab-0a-07e0-fefffeff ]# The appropriate id here is X in 'nmemX' (Above example, X is 7). Let's clarify the description. Signed-off-by: Masayoshi Mizuma --- Documentation/ndctl/ndctl-list.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/ndctl/ndctl-list.txt b/Documentation/ndctl/ndctl-list.txt index 13ebdcd..1b5882a 100644 --- a/Documentation/ndctl/ndctl-list.txt +++ b/Documentation/ndctl/ndctl-list.txt @@ -64,9 +64,10 @@ include::xable-region-options.txt[] -d:: --dimm=:: - An 'nmemX' device name, or dimm id number. Filter listing by - devices that reference the given dimm. For example to see all - namespaces comprised of storage capacity on nmem0: + An 'nmemX' device name, or dimm id number. The dimm id number + here is X in 'nmemX'. Filter listing by devices that reference + the given dimm. For example to see all namespaces comprised + of storage capacity on nmem0: ---- # ndctl list --dimm=nmem0 --namespaces ----