Skip to contentSkip to conversation

staging: vme_user: vme_bridge.h: Fix mutex without comment warning

PATCH In review Riyan Dhiman 2 participants 4 messages Jul 31, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: vme_user: vme_bridge.h: Fix mutex without comment warning

Adhere to Linux kernel coding style

Reported by checkpatch:

CHECK: mutex definition without comment

---
 drivers/staging/vme_user/vme_bridge.h | 4 ++++
 1 file changed, 4 insertions(+)
drivers/staging/vme_user/vme_bridge.h +4 -0
index 9bdc41bb6602..0b1f05944f0d 100644
@@ -28,6 +28,7 @@ struct vme_master_resource {
 struct vme_slave_resource {
 	struct list_head list;
 	struct vme_bridge *parent;
+	/* Locking for VME slave resources */
 	struct mutex mtx;
 	int locked;
 	int number;
@@ -55,12 +56,14 @@ struct vme_dma_list {
 	struct list_head list;
 	struct vme_dma_resource *parent;
 	struct list_head entries;
+	/* Mutex to protect access to DMA list's entries */
 	struct mutex mtx;
 };
 
 struct vme_dma_resource {
 	struct list_head list;
 	struct vme_bridge *parent;
+	/* Mutex to protect DMA controller resources and ensure thread-safe operations */
 	struct mutex mtx;
 	int locked;
 	int number;
@@ -72,6 +75,7 @@ struct vme_dma_resource {
 struct vme_lm_resource {
 	struct list_head list;
 	struct vme_bridge *parent;
+	/* Mutex to protect LM Monitor resources and ensure thread-safe operations */
 	struct mutex mtx;
 	int locked;
 	int number;
Signature · 1 line
2.39.2
maintainer
#1 lore raw
Quoted 16 lines · Riyan Dhiman

Adhere to Linux kernel coding style

Reported by checkpatch:

CHECK: mutex definition without comment

---
 drivers/staging/vme_user/vme_bridge.h | 4 ++++
 1 file changed, 4 insertions(+)
drivers/staging/vme_user/vme_bridge.h +0 -0
index 9bdc41bb6602..0b1f05944f0d 100644

drivers/staging/vme_user/vme_bridge.h struct vme_master_resource { · line 31

Quoted 4 lines
drivers/staging/vme_user/vme_bridge.h +1 -0
@@ -28,6 +28,7 @@ struct vme_master_resource {
 struct vme_slave_resource {
 	struct list_head list;
 	struct vme_bridge *parent;
+	/* Locking for VME slave resources */

Are you sure about all of these? Please document them individually and put the proof of that in the changelog text.

thanks,

greg k-h

#2 lore raw

Hello,

Thank you for reviewing my patch. I received your feedback:

Quoted 2 lines

Are you sure about all of these? Please document them individually and put the proof of that in the changelog text.

I'd like to clarify a few points to ensure I address your concerns correctly:

1. By "document them individually", do you mean I should submit separate patches for each mutex documentation change?

2. Regarding the "proof" for the changelog text, could you please elaborate on what kind of proof you 're looking for? Should I include:
- References to the code where these mutexes are used?
- Explanations of the race conditions these mutexes prevent?
- Citations from the driver's design documentation (if available)?

3. Is there a preferred format or level of detail you'd like to see in the changelog for each documentation change?

Thank you for your time and assistance.

Regards,
Riyan Dhiman

Quoted 30 lines · Greg KH
Quoted 4 lines · Riyan Dhiman

Adhere to Linux kernel coding style

Reported by checkpatch:

Review

Quoted 8 lines

CHECK: mutex definition without comment

---
 drivers/staging/vme_user/vme_bridge.h | 4 ++++
 1 file changed, 4 insertions(+)
(quoted diff) +0 -0

b/drivers/staging/vme_user/vme_bridge.h

drivers/staging/vme_user/vme_bridge.h struct vme_master_resource { · line 31

Quoted 8 lines

index 9bdc41bb6602..0b1f05944f0d 100644

drivers/staging/vme_user/vme_bridge.h +1 -0
@@ -28,6 +28,7 @@ struct vme_master_resource {
 struct vme_slave_resource {
      struct list_head list;
      struct vme_bridge *parent;
+     /* Locking for VME slave resources */

Are you sure about all of these? Please document them individually and put the proof of that in the changelog text.

thanks,

greg k-h

maintainer
#3 lore raw

A: http://en.wikipedia.org/wiki/Top_post
Q: Were do I find info about this thing called top-posting?
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?

A: No.
Q: Should I include quotations after my reply?

http://daringfireball.net/2007/07/on_top

Quoted 11 lines · Riyan Dhiman

Hello,

Thank you for reviewing my patch. I received your feedback:

Quoted 2 lines

Are you sure about all of these? Please document them individually and put the proof of that in the changelog text.

I'd like to clarify a few points to ensure I address your concerns correctly:

1. By "document them individually", do you mean I should submit separate patches for each mutex documentation change?

Yes.

Quoted 5 lines

2. Regarding the "proof" for the changelog text, could you please elaborate on what kind of proof you 're looking for? Should I include:
- References to the code where these mutexes are used?
- Explanations of the race conditions these mutexes prevent?
- Citations from the driver's design documentation (if available)?

Whatever you feel would be needed to convince everyone that the comment is now correct.

Quoted 2 lines

3. Is there a preferred format or level of detail you'd like to see in the changelog for each documentation change?

What would you want to see if you had to review this type of change to be comfortable accepting it?

thanks,

greg k-h