Skip to contentSkip to conversation

staging: rts5208: rtsx.c: Fix checkpatch warnings.

PATCH In review MingChia Chung 2 participants 6 messages Aug 22, 2016 – Aug 25, 2016 Staging

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: rts5208: rtsx.c: Fix checkpatch warnings.

This patch fixes a minor checkpatch warnings:

"WARNING: Block comments use a trailing */ on a separate line"

---
 drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)
drivers/staging/rts5208/rtsx.c +28 -14
index e992e03..a880411 100644
@@ -81,14 +81,16 @@ static int slave_alloc(struct scsi_device *sdev)
 
 static int slave_configure(struct scsi_device *sdev)
 {
-	/* Scatter-gather buffers (all but the last) must have a length
+	/*
+   * Scatter-gather buffers (all but the last) must have a length
 	 * divisible by the bulk maxpacket size.  Otherwise a data packet
 	 * would end up being short, causing a premature end to the data
 	 * transfer.  Since high-speed bulk pipes have a maxpacket size
 	 * of 512, we'll use that as the scsi device queue's DMA alignment
 	 * mask.  Guaranteeing proper alignment of the first buffer will
 	 * have the desired effect because, except at the beginning and
-	 * the end, scatter-gather buffers follow page boundaries. */
+	 * the end, scatter-gather buffers follow page boundaries.
+   */
 	blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
 
 	/* Set the SCSI level to at least 2.  We'll leave it at 3 if that's
@@ -185,8 +187,10 @@ static int command_abort(struct scsi_cmnd *srb)
 	return SUCCESS;
 }
 
-/* This invokes the transport reset mechanism to reset the state of the
- * device */
+/*
+ * This invokes the transport reset mechanism to reset the state of the
+ * device
+ */
 static int device_reset(struct scsi_cmnd *srb)
 {
 	int result = 0;
@@ -654,15 +658,19 @@ static void rtsx_release_resources(struct rtsx_dev *dev)
 	kfree(dev->chip);
 }
 
-/* First stage of disconnect processing: stop all commands and remove
- * the host */
+/*
+ * First stage of disconnect processing: stop all commands and remove
+ * the host
+ */
 static void quiesce_and_remove_host(struct rtsx_dev *dev)
 {
 	struct Scsi_Host *host = rtsx_to_host(dev);
 	struct rtsx_chip *chip = dev->chip;
 
-	/* Prevent new transfers, stop the current command, and
-	 * interrupt a SCSI-scan or device-reset delay */
+	/*
+   * Prevent new transfers, stop the current command, and
+	 * interrupt a SCSI-scan or device-reset delay
+   */
 	mutex_lock(&dev->dev_mutex);
 	scsi_lock(host);
 	rtsx_set_stat(chip, RTSX_STAT_DISCONNECT);
@@ -674,9 +682,11 @@ static void quiesce_and_remove_host(struct rtsx_dev *dev)
 	/* Wait some time to let other threads exist */
 	wait_timeout(100);
 
-	/* queuecommand won't accept any new commands and the control
+	/*
+   * queuecommand won't accept any new commands and the control
 	 * thread won't execute a previously-queued command.  If there
-	 * is such a command pending, complete it with an error. */
+	 * is such a command pending, complete it with an error.
+   */
 	mutex_lock(&dev->dev_mutex);
 	if (chip->srb) {
 		chip->srb->result = DID_NO_CONNECT << 16;
@@ -696,8 +706,10 @@ static void release_everything(struct rtsx_dev *dev)
 {
 	rtsx_release_resources(dev);
 
-	/* Drop our reference to the host; the SCSI core will free it
-	 * when the refcount becomes 0. */
+	/*
+   * Drop our reference to the host; the SCSI core will free it
+	 * when the refcount becomes 0.
+   */
 	scsi_host_put(rtsx_to_host(dev));
 }
 
@@ -936,8 +948,10 @@ static int rtsx_probe(struct pci_dev *pci,
 
 	rtsx_init_chip(dev->chip);
 
-	/* set the supported max_lun and max_id for the scsi host
-	 * NOTE: the minimal value of max_id is 1 */
+	/*
+   * set the supported max_lun and max_id for the scsi host
+	 * NOTE: the minimal value of max_id is 1
+   */
 	host->max_id = 1;
 	host->max_lun = dev->chip->max_lun;
 
Signature · 1 line
2.9.2
#1 lore raw
Quoted 14 lines · MingChia Chung

This patch fixes a minor checkpatch warnings:

"WARNING: Block comments use a trailing */ on a separate line"

---
 drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)
drivers/staging/rts5208/rtsx.c +0 -0
index e992e03..a880411 100644

drivers/staging/rts5208/rtsx.c static int slave_alloc(struct scsi_device *sdev) · line 85

Quoted 6 lines
drivers/staging/rts5208/rtsx.c +2 -1
@@ -81,14 +81,16 @@ static int slave_alloc(struct scsi_device *sdev)
 
 static int slave_configure(struct scsi_device *sdev)
 {
-	/* Scatter-gather buffers (all but the last) must have a length
+	/*
+   * Scatter-gather buffers (all but the last) must have a length

The alignment doesnot look correct here. Also in some more places later in this patch.

regards
Sudip

#2 lore raw
Quoted 25 lines · Sudip Mukherjee
Quoted 14 lines · MingChia Chung

This patch fixes a minor checkpatch warnings:

"WARNING: Block comments use a trailing */ on a separate line"

---
 drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)
drivers/staging/rts5208/rtsx.c +0 -0
index e992e03..a880411 100644

drivers/staging/rts5208/rtsx.c static int slave_alloc(struct scsi_device *sdev) · line 85

Quoted 6 lines
drivers/staging/rts5208/rtsx.c +2 -1
@@ -81,14 +81,16 @@ static int slave_alloc(struct scsi_device *sdev)
 
 static int slave_configure(struct scsi_device *sdev)
 {
-	/* Scatter-gather buffers (all but the last) must have a length
+	/*
+   * Scatter-gather buffers (all but the last) must have a length

The alignment doesnot look correct here. Also in some more places later in this patch.

Quoted 2 lines

regards
Sudip

I sent this patch by following docs ([1] and [2]). The style for long comments needs the begining and ending almost-blank lines. There is no the begining almost-blank line only for the files in net/ and drivers/net/.
Please let me know what I misunderstood.

[1]: Linux kernel coding style, ch. 8 Commenting
https://www.kernel.org/doc/Documentation/CodingStyle
[2]: Linus Torvalds on comment styles
https://lkml.org/lkml/2016/7/8/625

regards,
MingChia

#3 lore raw
Quoted 26 lines · Ming-Chia Chung
Quoted 25 lines · Sudip Mukherjee
Quoted 14 lines · MingChia Chung

This patch fixes a minor checkpatch warnings:

"WARNING: Block comments use a trailing */ on a separate line"

---
 drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)
drivers/staging/rts5208/rtsx.c +0 -0
index e992e03..a880411 100644

drivers/staging/rts5208/rtsx.c static int slave_alloc(struct scsi_device *sdev) · line 85

Quoted 6 lines
drivers/staging/rts5208/rtsx.c +2 -1
@@ -81,14 +81,16 @@ static int slave_alloc(struct scsi_device *sdev)
 
 static int slave_configure(struct scsi_device *sdev)
 {
-	/* Scatter-gather buffers (all but the last) must have a length
+	/*
+   * Scatter-gather buffers (all but the last) must have a length

The alignment doesnot look correct here. Also in some more places later in this patch.

Quoted 8 lines
Quoted 2 lines

regards
Sudip

I sent this patch by following docs ([1] and [2]). The style for long comments needs the begining and ending almost-blank lines. There is no the begining almost-blank line only for the files in net/ and drivers/net/.
Please let me know what I misunderstood.

After applying the patch the file was like:

        /*

* Scatter-gather buffers (all but the last) must have a length
* divisible by the bulk maxpacket size. Otherwise a data packet
* would end up being short, causing a premature end to the data
* transfer. Since high-speed bulk pipes have a maxpacket size

See the alignment of the second line. Please use tab instead of space. And also checkpatch should have warned you not to use space before the Signed-off-by.

regards
sudip

#4 lore raw
Quoted 43 lines · Sudip Mukherjee
Quoted 26 lines · Ming-Chia Chung
Quoted 25 lines · Sudip Mukherjee
Quoted 14 lines · MingChia Chung

This patch fixes a minor checkpatch warnings:

"WARNING: Block comments use a trailing */ on a separate line"

---
 drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)
drivers/staging/rts5208/rtsx.c +0 -0
index e992e03..a880411 100644

drivers/staging/rts5208/rtsx.c static int slave_alloc(struct scsi_device *sdev) · line 85

Quoted 6 lines
drivers/staging/rts5208/rtsx.c +2 -1
@@ -81,14 +81,16 @@ static int slave_alloc(struct scsi_device *sdev)
 
 static int slave_configure(struct scsi_device *sdev)
 {
-	/* Scatter-gather buffers (all but the last) must have a length
+	/*
+   * Scatter-gather buffers (all but the last) must have a length

The alignment doesnot look correct here. Also in some more places later in this patch.

Quoted 8 lines
Quoted 2 lines

regards
Sudip

I sent this patch by following docs ([1] and [2]). The style for long comments needs the begining and ending almost-blank lines. There is no the begining almost-blank line only for the files in net/ and drivers/net/.
Please let me know what I misunderstood.

After applying the patch the file was like:

        /*

* Scatter-gather buffers (all but the last) must have a length
* divisible by the bulk maxpacket size. Otherwise a data packet
* would end up being short, causing a premature end to the data
* transfer. Since high-speed bulk pipes have a maxpacket size

Quoted 5 lines

See the alignment of the second line. Please use tab instead of space. And also checkpatch should have warned you not to use space before the Signed-off-by.

regards
sudip

Thank you for detailed explanation. I enabled "expandtab" in vim so that I didn't realize the alignment is wrong. Now, I install 'linuxsty.vim' to view the code. But checkpatch.pl didn't show the warning of space. Here is my command:
kernels/staging$ perl scripts/checkpatch.pl -f drivers/staging/rts5208/rtsx.c

Thanks,
MingChia

#5 lore raw
Quoted 48 lines · Ming-Chia Chung
Quoted 37 lines · Sudip Mukherjee
Quoted 26 lines · Ming-Chia Chung
Quoted 25 lines · Sudip Mukherjee
Quoted 14 lines · MingChia Chung

This patch fixes a minor checkpatch warnings:

"WARNING: Block comments use a trailing */ on a separate line"

---
 drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)
drivers/staging/rts5208/rtsx.c +0 -0
index e992e03..a880411 100644

drivers/staging/rts5208/rtsx.c static int slave_alloc(struct scsi_device *sdev) · line 85

Quoted 6 lines
drivers/staging/rts5208/rtsx.c +2 -1
@@ -81,14 +81,16 @@ static int slave_alloc(struct scsi_device *sdev)
 
 static int slave_configure(struct scsi_device *sdev)
 {
-	/* Scatter-gather buffers (all but the last) must have a length
+	/*
+   * Scatter-gather buffers (all but the last) must have a length

The alignment doesnot look correct here. Also in some more places later in this patch.

Quoted 8 lines
Quoted 2 lines

regards
Sudip

I sent this patch by following docs ([1] and [2]). The style for long comments needs the begining and ending almost-blank lines. There is no the begining almost-blank line only for the files in net/ and drivers/net/.
Please let me know what I misunderstood.

After applying the patch the file was like:

Quoted 9 lines
        /*

* Scatter-gather buffers (all but the last) must have a length
* divisible by the bulk maxpacket size. Otherwise a data packet
* would end up being short, causing a premature end to the data
* transfer. Since high-speed bulk pipes have a maxpacket size

See the alignment of the second line. Please use tab instead of space. And also checkpatch should have warned you not to use space before the Signed-off-by.

Quoted 5 lines

Thank you for detailed explanation. I enabled "expandtab" in vim so that I didn't realize the alignment is wrong. Now, I install 'linuxsty.vim' to view the code. But checkpatch.pl didn't show the warning of space. Here is my command:
kernels/staging$ perl scripts/checkpatch.pl -f drivers/staging/rts5208/rtsx.c

Please run checkpatch on your patch and it will show you the warning about space before Signed-off-by. But it missed the place where space was used inplace of tab. Maybe you can send a patch to fix checkpatch.

Added Cc: to Joe and Andy.

regards
sudip