[PATCH] staging: iio: gyro: add comment to mutex

[PATCH] staging: iio: gyro: add comment to mutex

[Anchal Jain]

Fix the checkpatch.pl issues:
CHECK: struct mutes definition without comment

Signed-off-by: Anchal Jain <anchalj109@gmail.com>
---
 drivers/staging/iio/gyro/adis16060_core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/staging/iio/gyro/adis16060_core.c b/drivers/staging/iio/gyro/adis16060_core.c
index ab816a2..96230b6 100644
--- a/drivers/staging/iio/gyro/adis16060_core.c
+++ b/drivers/staging/iio/gyro/adis16060_core.c
@@ -33,7 +33,7 @@
 struct adis16060_state {
 	struct spi_device		*us_w;
 	struct spi_device		*us_r;
-	struct mutex			buf_lock;
+	struct mutex			buf_lock; /* protect tx and rx */
 
 	u8 buf[3] ____cacheline_aligned;
 };
-- 
1.9.1

Re: [Outreachy kernel] [PATCH] staging: iio: gyro: add comment to mutex

[Alison Schofield]

On Wed, Sep 28, 2016 at 10:37:17PM +0530, Anchal Jain wrote:
> Fix the checkpatch.pl issues:
> CHECK: struct mutes definition without comment
                    ^^spelling
> 
> Signed-off-by: Anchal Jain <anchalj109@gmail.com>

Hi Anchal,  I'm going to be picky on these, because I sense you
are getting on a roll here and we should establish a pattern.

- see spelling above.
- include driver name in IIO commit paths.
  Caveat: if the subdir and driver names get so crazy long that you
  can't fit a good commit message, then leave off the subdir.
- tab out the comment instead of space.
- At first I thought tx and rx were kind of terse, but when I scroll
  up and see the comment above, it all makes sense. 
- I might have said 'protect transfer buffers'

Please update with the minor cleanups and resend to the wider
'CC list as suggested in your previous patch.  

alisons

> ---
>  drivers/staging/iio/gyro/adis16060_core.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/staging/iio/gyro/adis16060_core.c b/drivers/staging/iio/gyro/adis16060_core.c
> index ab816a2..96230b6 100644
> --- a/drivers/staging/iio/gyro/adis16060_core.c
> +++ b/drivers/staging/iio/gyro/adis16060_core.c
> @@ -33,7 +33,7 @@
>  struct adis16060_state {
>  	struct spi_device		*us_w;
>  	struct spi_device		*us_r;
> -	struct mutex			buf_lock;
> +	struct mutex			buf_lock; /* protect tx and rx */
>  
>  	u8 buf[3] ____cacheline_aligned;
>  };
> -- 
> 1.9.1
> 
> -- 
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To post to this group, send email to outreachy-kernel@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20160928170708.GA6196%40life-desktop.
> For more options, visit https://groups.google.com/d/optout.

Re: [Outreachy kernel] [PATCH] staging: iio: gyro: add comment to mutex

[Julia Lawall]

On Wed, 28 Sep 2016, Alison Schofield wrote:

> On Wed, Sep 28, 2016 at 10:37:17PM +0530, Anchal Jain wrote:
> > Fix the checkpatch.pl issues:
> > CHECK: struct mutes definition without comment
>                     ^^spelling
> >
> > Signed-off-by: Anchal Jain <anchalj109@gmail.com>
>
> Hi Anchal,  I'm going to be picky on these, because I sense you
> are getting on a roll here and we should establish a pattern.
>
> - see spelling above.
> - include driver name in IIO commit paths.
>   Caveat: if the subdir and driver names get so crazy long that you
>   can't fit a good commit message, then leave off the subdir.
> - tab out the comment instead of space.
> - At first I thought tx and rx were kind of terse, but when I scroll
>   up and see the comment above, it all makes sense.

tx and rx seem well understood.  A bit more concrete than transfer
buffers.

julia

> - I might have said 'protect transfer buffers'
>
> Please update with the minor cleanups and resend to the wider
> 'CC list as suggested in your previous patch.
>
> alisons
>
> > ---
> >  drivers/staging/iio/gyro/adis16060_core.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/staging/iio/gyro/adis16060_core.c b/drivers/staging/iio/gyro/adis16060_core.c
> > index ab816a2..96230b6 100644
> > --- a/drivers/staging/iio/gyro/adis16060_core.c
> > +++ b/drivers/staging/iio/gyro/adis16060_core.c
> > @@ -33,7 +33,7 @@
> >  struct adis16060_state {
> >  	struct spi_device		*us_w;
> >  	struct spi_device		*us_r;
> > -	struct mutex			buf_lock;
> > +	struct mutex			buf_lock; /* protect tx and rx */
> >
> >  	u8 buf[3] ____cacheline_aligned;
> >  };
> > --
> > 1.9.1
> >
> > --
> > You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> > To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> > To post to this group, send email to outreachy-kernel@googlegroups.com.
> > To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20160928170708.GA6196%40life-desktop.
> > For more options, visit https://groups.google.com/d/optout.
>
> --
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To post to this group, send email to outreachy-kernel@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20160928175504.GA10225%40d830.WORKGROUP.
> For more options, visit https://groups.google.com/d/optout.
>