From: "Verma, Vishal L" <vishal.l.verma@intel.com>
To: "Jiang, Dave" <dave.jiang@intel.com>
Cc: "linux-cxl@vger.kernel.org" <linux-cxl@vger.kernel.org>,
"nvdimm@lists.linux.dev" <nvdimm@lists.linux.dev>
Subject: Re: [NDCTL PATCH] cxl: Augment documentation on cxl operational behavior
Date: Tue, 14 Nov 2023 22:43:50 +0000 [thread overview]
Message-ID: <559acb1a30b52d99cb6eea445fde938ce6a1370d.camel@intel.com> (raw)
In-Reply-To: <169878439580.80025.16527732447076656149.stgit@djiang5-mobl3>
On Tue, 2023-10-31 at 13:33 -0700, Dave Jiang wrote:
I think a more specific subject like:
cxl/Documentation: Clarify that no-op is a success for xable commands
is better?
> If a cxl operation is executed resulting in no-op, the tool will still
.. cxl enable or disable operation ..
> emit the number of targets the operation has succeeded on. For example, if
> disable-region is issued and the region is already disabled, the tool will
> still report 1 region disabled. Add verbiage to man pages to document the
> behavior.
>
> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
> ---
> Documentation/cxl/cxl-disable-bus.txt | 2 ++
> Documentation/cxl/cxl-disable-memdev.txt | 1 +
> Documentation/cxl/cxl-disable-port.txt | 2 ++
> Documentation/cxl/cxl-disable-region.txt | 2 ++
> Documentation/cxl/cxl-enable-memdev.txt | 2 ++
> Documentation/cxl/cxl-enable-port.txt | 2 ++
> Documentation/cxl/cxl-enable-region.txt | 2 ++
> Documentation/cxl/meson.build | 1 +
> Documentation/cxl/operations.txt | 17 +++++++++++++++++
> 9 files changed, 31 insertions(+)
> create mode 100644 Documentation/cxl/operations.txt
>
[..]
>
> diff --git a/Documentation/cxl/operations.txt b/Documentation/cxl/operations.txt
> new file mode 100644
Maybe call this xable-no-op.txt, 'operations' sounds a bit vague.
> index 000000000000..046e2bc19532
> --- /dev/null
> +++ b/Documentation/cxl/operations.txt
> @@ -0,0 +1,17 @@
> +// SPDX-License-Identifier: gpl-2.0
> +
> +Given any en/disabling operation, if the operation is a no-op due to the
..enable or disable command..
> +current state of a target, it is still considered successful when executed
> +even if no actual operation is performed. The target applies to a bus,
.. the target can be a bus, ..
> +decoder, memdev, or region.
> +
> +For example:
> +If a CXL region is already disabled and the cxl disable-region is called:
> +
> +----
> +# cxl disable-region region0
> +disabled 1 regions
> +----
> +
> +The operation will still succeed with the number of regions operated on
> +reported, even if the operation is a non-action.
Looking at the man page for say disable-memdev, and seeing a region
command in the example feels slightly awkward.. I wonder if we can just
drop the example, and rely only on the text description.
prev parent reply other threads:[~2023-11-14 22:43 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-31 20:33 [NDCTL PATCH] cxl: Augment documentation on cxl operational behavior Dave Jiang
2023-10-31 20:34 ` Dave Jiang
2023-11-09 12:46 ` Cao, Quanquan/曹 全全
2023-11-14 22:43 ` Verma, Vishal L [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=559acb1a30b52d99cb6eea445fde938ce6a1370d.camel@intel.com \
--to=vishal.l.verma@intel.com \
--cc=dave.jiang@intel.com \
--cc=linux-cxl@vger.kernel.org \
--cc=nvdimm@lists.linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).