2021-12-30 15:29:39

by Paulo Miguel Almeida

Subject: [PATCH v3] staging: pi433: add comment to rx_lock mutex definition

Checkpatch reports: CHECK: struct mutex definition without comment.
Fix this by documenting what rx_mutex struct is used for in pi433 driver.

Signed-off-by: Paulo Miguel Almeida <[email protected]>
---
v3: wrote a more succinct desc so it doesn't become out-of-date (Req: Greg k-h)
v2: ellaborate on reasons why the mutex lock is used in the driver (Req: Greg k-h)
v1: https://lore.kernel.org/lkml/[email protected]/

---
drivers/staging/pi433/pi433_if.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/staging/pi433/pi433_if.c b/drivers/staging/pi433/pi433_if.c
index 29bd37669059..68c09fa016ed 100644
--- a/drivers/staging/pi433/pi433_if.c
+++ b/drivers/staging/pi433/pi433_if.c
@@ -92,7 +92,7 @@ struct pi433_device {
u32 rx_bytes_to_drop;
u32 rx_bytes_dropped;
unsigned int rx_position;
- struct mutex rx_lock;
+ struct mutex rx_lock; /* protects rx_* variable accesses */
wait_queue_head_t rx_wait_queue;

/* fifo wait queue */
--
2.25.4

2022-01-03 13:29:48

by Greg Kroah-Hartman

Subject: Re: [PATCH v3] staging: pi433: add comment to rx_lock mutex definition

On Fri, Dec 31, 2021 at 04:29:31AM +1300, Paulo Miguel Almeida wrote:
> Checkpatch reports: CHECK: struct mutex definition without comment.
> Fix this by documenting what rx_mutex struct is used for in pi433 driver.

Please wrap your changelog comments at 72 columns.

thanks,

greg k-h

2022-01-03 23:26:25

by Paulo Miguel Almeida

Subject: [PATCH v4] staging: pi433: add comment to rx_lock mutex definition

Checkpatch reports: CHECK: struct mutex definition without comment.
Fix this by documenting what rx_mutex struct is used for in pi433
driver.

Signed-off-by: Paulo Miguel Almeida <[email protected]>
---
v4: wrap changelog comments at 72 columns where possible (Req:
Greg k-h)
v3: wrote a more succinct desc so it doesn't become out-of-date (Req:
Greg k-h)
v2: ellaborate on reasons why the mutex lock is used in driver (Req:
Greg k-h)
v1: https://lore.kernel.org/lkml/[email protected]/
---
drivers/staging/pi433/pi433_if.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/staging/pi433/pi433_if.c b/drivers/staging/pi433/pi433_if.c
index 29bd37669059..68c09fa016ed 100644
--- a/drivers/staging/pi433/pi433_if.c
+++ b/drivers/staging/pi433/pi433_if.c
@@ -92,7 +92,7 @@ struct pi433_device {
u32 rx_bytes_to_drop;
u32 rx_bytes_dropped;
unsigned int rx_position;
- struct mutex rx_lock;
+ struct mutex rx_lock; /* protects rx_* variable accesses */
wait_queue_head_t rx_wait_queue;

/* fifo wait queue */
--
2.25.4