[PATCH] docs: usb:gadget:hid: fix hid_gadget_test code in documentation of hid section

[PATCH] docs: usb:gadget:hid: fix hid_gadget_test code in documentation of hid section

[qiurui]

Fix bzero buffer before read()

Signed-off-by: qiurui <qiurui@kylinos.cn>
---
 Documentation/usb/gadget_hid.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/usb/gadget_hid.rst b/Documentation/usb/gadget_hid.rst
index e623416de4f1..c4ee81a6b48e 100644
--- a/Documentation/usb/gadget_hid.rst
+++ b/Documentation/usb/gadget_hid.rst
@@ -410,6 +410,7 @@ Sample code::
 		}
 
 		if (FD_ISSET(fd, &rfds)) {
+			bzero(buf, SIZE);
 			cmd_len = read(fd, buf, BUF_LEN - 1);
 			printf("recv report:");
 			for (i = 0; i < cmd_len; i++)
@@ -419,6 +420,7 @@ Sample code::
 
 		if (FD_ISSET(STDIN_FILENO, &rfds)) {
 			memset(report, 0x0, sizeof(report));
+			bzero(buf, SIZE);
 			cmd_len = read(STDIN_FILENO, buf, BUF_LEN - 1);
 
 			if (cmd_len == 0)
-- 
2.34.1

Re: [PATCH] docs: usb:gadget:hid: fix hid_gadget_test code in documentation of hid section

[Matthew Wilcox]

On Mon, May 06, 2024 at 10:44:08AM +0800, qiurui wrote:
> Fix bzero buffer before read()

why would we want to do that?

> Signed-off-by: qiurui <qiurui@kylinos.cn>
> ---
>  Documentation/usb/gadget_hid.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/usb/gadget_hid.rst b/Documentation/usb/gadget_hid.rst
> index e623416de4f1..c4ee81a6b48e 100644
> --- a/Documentation/usb/gadget_hid.rst
> +++ b/Documentation/usb/gadget_hid.rst
> @@ -410,6 +410,7 @@ Sample code::
>  		}
>  
>  		if (FD_ISSET(fd, &rfds)) {
> +			bzero(buf, SIZE);
>  			cmd_len = read(fd, buf, BUF_LEN - 1);
>  			printf("recv report:");
>  			for (i = 0; i < cmd_len; i++)
> @@ -419,6 +420,7 @@ Sample code::
>  
>  		if (FD_ISSET(STDIN_FILENO, &rfds)) {
>  			memset(report, 0x0, sizeof(report));
> +			bzero(buf, SIZE);
>  			cmd_len = read(STDIN_FILENO, buf, BUF_LEN - 1);
>  
>  			if (cmd_len == 0)
> -- 
> 2.34.1
> 
> 

Re: [PATCH] docs: usb:gadget:hid: fix hid_gadget_test code in documentation of hid section

[Greg KH]

On Mon, May 06, 2024 at 10:44:08AM +0800, qiurui wrote:
> Fix bzero buffer before read()
> 
> Signed-off-by: qiurui <qiurui@kylinos.cn>
> ---
>  Documentation/usb/gadget_hid.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/usb/gadget_hid.rst b/Documentation/usb/gadget_hid.rst
> index e623416de4f1..c4ee81a6b48e 100644
> --- a/Documentation/usb/gadget_hid.rst
> +++ b/Documentation/usb/gadget_hid.rst
> @@ -410,6 +410,7 @@ Sample code::
>  		}
>  
>  		if (FD_ISSET(fd, &rfds)) {
> +			bzero(buf, SIZE);
>  			cmd_len = read(fd, buf, BUF_LEN - 1);
>  			printf("recv report:");
>  			for (i = 0; i < cmd_len; i++)
> @@ -419,6 +420,7 @@ Sample code::
>  
>  		if (FD_ISSET(STDIN_FILENO, &rfds)) {
>  			memset(report, 0x0, sizeof(report));
> +			bzero(buf, SIZE);
>  			cmd_len = read(STDIN_FILENO, buf, BUF_LEN - 1);
>  
>  			if (cmd_len == 0)
> -- 
> 2.34.1
> 
> 

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman.  You have sent him
a patch that has triggered this response.  He used to manually respond
to these common problems, but in order to save his sanity (he kept
writing the same thing over and over, yet to different people), I was
created.  Hopefully you will not take offence and will fix the problem
in your patch and resubmit it so that it can be accepted into the Linux
kernel tree.

You are receiving this message because of the following common error(s)
as indicated below:

- You did not specify a description of why the patch is needed, or
  possibly, any description at all, in the email body.  Please read the
  section entitled "The canonical patch format" in the kernel file,
  Documentation/process/submitting-patches.rst for what is needed in
  order to properly describe the change.

- You did not write a descriptive Subject: for the patch, allowing Greg,
  and everyone else, to know what this patch is all about.  Please read
  the section entitled "The canonical patch format" in the kernel file,
  Documentation/process/submitting-patches.rst for what a proper
  Subject: line should look like.

- It looks like you did not use your "real" name for the patch on either
  the Signed-off-by: line, or the From: line (both of which have to
  match).  Please read the kernel file,
  Documentation/process/submitting-patches.rst for how to do this
  correctly.

If you wish to discuss this problem further, or you have questions about
how to resolve this issue, please feel free to respond to this email and
Greg will reply once he has dug out from the pending patches received
from other developers.

thanks,

greg k-h's patch email bot