diff mbox series

[v3,4/4] cxl/mem: Fix UAPI command comment

Message ID 20221222-cxl-misc-v3-4-60d4f35e4b39@intel.com
State Superseded
Headers show
Series CXL: Miscellaneous fixes | expand

Commit Message

Ira Weiny Feb. 2, 2023, 1:23 a.m. UTC
The command comment had grammatical errors.  In an attempt to fix those
it was noted that the comment and the query command were not in sync.

Now that the query command returns excluded and device unsupported
command information.  Update the kdoc and fix the grammatical errors.

[1] https://lore.kernel.org/all/63b4ec4e37cc1_5178e2941d@dwillia2-xfh.jf.intel.com.notmuch/

Signed-off-by: Ira Weiny <ira.weiny@intel.com>

---
Changes for v3:
	Adjust commit message for updated query command behavior.
---
 include/uapi/linux/cxl_mem.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Jonathan Cameron Feb. 2, 2023, 10:01 a.m. UTC | #1
On Wed, 01 Feb 2023 17:23:13 -0800
Ira Weiny <ira.weiny@intel.com> wrote:

> The command comment had grammatical errors.  In an attempt to fix those
> it was noted that the comment and the query command were not in sync.
> 
> Now that the query command returns excluded and device unsupported
> command information.  Update the kdoc and fix the grammatical errors.
> 
> [1] https://lore.kernel.org/all/63b4ec4e37cc1_5178e2941d@dwillia2-xfh.jf.intel.com.notmuch/
> 
> Signed-off-by: Ira Weiny <ira.weiny@intel.com>

Looks fine to me.

Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> ---
> Changes for v3:
> 	Adjust commit message for updated query command behavior.
> ---
>  include/uapi/linux/cxl_mem.h | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/include/uapi/linux/cxl_mem.h b/include/uapi/linux/cxl_mem.h
> index 4aee64b7cc1a..b1d41e3be4e5 100644
> --- a/include/uapi/linux/cxl_mem.h
> +++ b/include/uapi/linux/cxl_mem.h
> @@ -11,9 +11,10 @@
>  /**
>   * DOC: UAPI
>   *
> - * Not all of all commands that the driver supports are always available for use
> - * by userspace. Userspace must check the results from the QUERY command in
> - * order to determine the live set of commands.
> + * Not all of the commands that the driver supports are available for use by
> + * userspace at all times.  Userspace can check the result of the QUERY command
> + * to determine the live set of commands.  Alternatively, it can issue the
> + * command and check for failure.
>   */
>  
>  #define CXL_MEM_QUERY_COMMANDS _IOR(0xCE, 1, struct cxl_mem_query_commands)
>
diff mbox series

Patch

diff --git a/include/uapi/linux/cxl_mem.h b/include/uapi/linux/cxl_mem.h
index 4aee64b7cc1a..b1d41e3be4e5 100644
--- a/include/uapi/linux/cxl_mem.h
+++ b/include/uapi/linux/cxl_mem.h
@@ -11,9 +11,10 @@ 
 /**
  * DOC: UAPI
  *
- * Not all of all commands that the driver supports are always available for use
- * by userspace. Userspace must check the results from the QUERY command in
- * order to determine the live set of commands.
+ * Not all of the commands that the driver supports are available for use by
+ * userspace at all times.  Userspace can check the result of the QUERY command
+ * to determine the live set of commands.  Alternatively, it can issue the
+ * command and check for failure.
  */
 
 #define CXL_MEM_QUERY_COMMANDS _IOR(0xCE, 1, struct cxl_mem_query_commands)