linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings.
@ 2016-08-22 16:54 MingChia Chung
  2016-08-22 17:21 ` Sudip Mukherjee
  0 siblings, 1 reply; 6+ messages in thread
From: MingChia Chung @ 2016-08-22 16:54 UTC (permalink / raw)
  To: gregkh, shaun.ren, bhaktipriya96, janani.rvchndrn, bhumirks,
	dilekuzulmez, devel, linux-kernel

  This patch fixes a minor checkpatch warnings:

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

  Signed-off-by: Ming-Chia Chung <Quexint@gmail.com>
---
 drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)

diff --git a/drivers/staging/rts5208/rtsx.c b/drivers/staging/rts5208/rtsx.c
index e992e03..a880411 100644
--- a/drivers/staging/rts5208/rtsx.c
+++ b/drivers/staging/rts5208/rtsx.c
@@ -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;
 
-- 
2.9.2

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings.
  2016-08-22 16:54 [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings MingChia Chung
@ 2016-08-22 17:21 ` Sudip Mukherjee
  2016-08-23  0:19   ` Ming-Chia Chung
  0 siblings, 1 reply; 6+ messages in thread
From: Sudip Mukherjee @ 2016-08-22 17:21 UTC (permalink / raw)
  To: MingChia Chung
  Cc: gregkh, shaun.ren, bhaktipriya96, janani.rvchndrn, bhumirks,
	dilekuzulmez, devel, linux-kernel

On Tue, Aug 23, 2016 at 12:54:17AM +0800, MingChia Chung wrote:
>   This patch fixes a minor checkpatch warnings:
> 
>   "WARNING: Block comments use a trailing */ on a separate line"
> 
>   Signed-off-by: Ming-Chia Chung <Quexint@gmail.com>
> ---
>  drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
>  1 file changed, 28 insertions(+), 14 deletions(-)
> 
> diff --git a/drivers/staging/rts5208/rtsx.c b/drivers/staging/rts5208/rtsx.c
> index e992e03..a880411 100644
> --- a/drivers/staging/rts5208/rtsx.c
> +++ b/drivers/staging/rts5208/rtsx.c
> @@ -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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings.
  2016-08-22 17:21 ` Sudip Mukherjee
@ 2016-08-23  0:19   ` Ming-Chia Chung
  2016-08-23  6:31     ` Sudip Mukherjee
  0 siblings, 1 reply; 6+ messages in thread
From: Ming-Chia Chung @ 2016-08-23  0:19 UTC (permalink / raw)
  To: Sudip Mukherjee
  Cc: gregkh, shaun.ren, bhaktipriya96, janani.rvchndrn, bhumirks,
	dilekuzulmez, devel, linux-kernel

On Mon, Aug 22, 2016 at 10:51:27PM +0530, Sudip Mukherjee wrote:
> On Tue, Aug 23, 2016 at 12:54:17AM +0800, MingChia Chung wrote:
> >   This patch fixes a minor checkpatch warnings:
> > 
> >   "WARNING: Block comments use a trailing */ on a separate line"
> > 
> >   Signed-off-by: Ming-Chia Chung <Quexint@gmail.com>
> > ---
> >  drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
> >  1 file changed, 28 insertions(+), 14 deletions(-)
> > 
> > diff --git a/drivers/staging/rts5208/rtsx.c b/drivers/staging/rts5208/rtsx.c
> > index e992e03..a880411 100644
> > --- a/drivers/staging/rts5208/rtsx.c
> > +++ b/drivers/staging/rts5208/rtsx.c
> > @@ -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

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings.
  2016-08-23  0:19   ` Ming-Chia Chung
@ 2016-08-23  6:31     ` Sudip Mukherjee
  2016-08-25 13:59       ` Ming-Chia Chung
  0 siblings, 1 reply; 6+ messages in thread
From: Sudip Mukherjee @ 2016-08-23  6:31 UTC (permalink / raw)
  To: Ming-Chia Chung
  Cc: gregkh, shaun.ren, bhaktipriya96, janani.rvchndrn, bhumirks,
	dilekuzulmez, devel, linux-kernel

On Tue, Aug 23, 2016 at 08:19:46AM +0800, Ming-Chia Chung wrote:
> On Mon, Aug 22, 2016 at 10:51:27PM +0530, Sudip Mukherjee wrote:
> > On Tue, Aug 23, 2016 at 12:54:17AM +0800, MingChia Chung wrote:
> > >   This patch fixes a minor checkpatch warnings:
> > > 
> > >   "WARNING: Block comments use a trailing */ on a separate line"
> > > 
> > >   Signed-off-by: Ming-Chia Chung <Quexint@gmail.com>
> > > ---
> > >  drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
> > >  1 file changed, 28 insertions(+), 14 deletions(-)
> > > 
> > > diff --git a/drivers/staging/rts5208/rtsx.c b/drivers/staging/rts5208/rtsx.c
> > > index e992e03..a880411 100644
> > > --- a/drivers/staging/rts5208/rtsx.c
> > > +++ b/drivers/staging/rts5208/rtsx.c
> > > @@ -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
> 
> 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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings.
  2016-08-23  6:31     ` Sudip Mukherjee
@ 2016-08-25 13:59       ` Ming-Chia Chung
  2016-08-25 16:50         ` Sudip Mukherjee
  0 siblings, 1 reply; 6+ messages in thread
From: Ming-Chia Chung @ 2016-08-25 13:59 UTC (permalink / raw)
  To: Sudip Mukherjee
  Cc: gregkh, shaun.ren, bhaktipriya96, janani.rvchndrn, bhumirks,
	dilekuzulmez, devel, linux-kernel

On Tue, Aug 23, 2016 at 12:01:36PM +0530, Sudip Mukherjee wrote:
> On Tue, Aug 23, 2016 at 08:19:46AM +0800, Ming-Chia Chung wrote:
> > On Mon, Aug 22, 2016 at 10:51:27PM +0530, Sudip Mukherjee wrote:
> > > On Tue, Aug 23, 2016 at 12:54:17AM +0800, MingChia Chung wrote:
> > > >   This patch fixes a minor checkpatch warnings:
> > > > 
> > > >   "WARNING: Block comments use a trailing */ on a separate line"
> > > > 
> > > >   Signed-off-by: Ming-Chia Chung <Quexint@gmail.com>
> > > > ---
> > > >  drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
> > > >  1 file changed, 28 insertions(+), 14 deletions(-)
> > > > 
> > > > diff --git a/drivers/staging/rts5208/rtsx.c b/drivers/staging/rts5208/rtsx.c
> > > > index e992e03..a880411 100644
> > > > --- a/drivers/staging/rts5208/rtsx.c
> > > > +++ b/drivers/staging/rts5208/rtsx.c
> > > > @@ -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
> > 
> > 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

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings.
  2016-08-25 13:59       ` Ming-Chia Chung
@ 2016-08-25 16:50         ` Sudip Mukherjee
  0 siblings, 0 replies; 6+ messages in thread
From: Sudip Mukherjee @ 2016-08-25 16:50 UTC (permalink / raw)
  To: Ming-Chia Chung; +Cc: gregkh, devel, linux-kernel, Andy Whitcroft, Joe Perches

On Thu, Aug 25, 2016 at 09:59:46PM +0800, Ming-Chia Chung wrote:
> On Tue, Aug 23, 2016 at 12:01:36PM +0530, Sudip Mukherjee wrote:
> > On Tue, Aug 23, 2016 at 08:19:46AM +0800, Ming-Chia Chung wrote:
> > > On Mon, Aug 22, 2016 at 10:51:27PM +0530, Sudip Mukherjee wrote:
> > > > On Tue, Aug 23, 2016 at 12:54:17AM +0800, MingChia Chung wrote:
> > > > >   This patch fixes a minor checkpatch warnings:
> > > > > 
> > > > >   "WARNING: Block comments use a trailing */ on a separate line"
> > > > > 
> > > > >   Signed-off-by: Ming-Chia Chung <Quexint@gmail.com>
> > > > > ---
> > > > >  drivers/staging/rts5208/rtsx.c | 42 ++++++++++++++++++++++++++++--------------
> > > > >  1 file changed, 28 insertions(+), 14 deletions(-)
> > > > > 
> > > > > diff --git a/drivers/staging/rts5208/rtsx.c b/drivers/staging/rts5208/rtsx.c
> > > > > index e992e03..a880411 100644
> > > > > --- a/drivers/staging/rts5208/rtsx.c
> > > > > +++ b/drivers/staging/rts5208/rtsx.c
> > > > > @@ -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
> > > 
> > > 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.
> > 
> 
> 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

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2016-08-25 16:51 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-08-22 16:54 [PATCH] staging: rts5208: rtsx.c: Fix checkpatch warnings MingChia Chung
2016-08-22 17:21 ` Sudip Mukherjee
2016-08-23  0:19   ` Ming-Chia Chung
2016-08-23  6:31     ` Sudip Mukherjee
2016-08-25 13:59       ` Ming-Chia Chung
2016-08-25 16:50         ` Sudip Mukherjee

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).