[PATCH] staging: dgnc: Break up long comment

[PATCH] staging: dgnc: Break up long comment

[Elizabeth Ferdman]

This patch splits a long comment up into two lines; error found by checkpatch

Signed-off-by: Elizabeth Ferdman <gnudevliz@gmail.com>
---
 drivers/staging/dgnc/dgnc_neo.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/dgnc/dgnc_neo.c b/drivers/staging/dgnc/dgnc_neo.c
index e794056..cb63351 100644
--- a/drivers/staging/dgnc/dgnc_neo.c
+++ b/drivers/staging/dgnc/dgnc_neo.c
@@ -996,7 +996,8 @@ static irqreturn_t neo_intr(int irq, void *voidbrd)
 
  case UART_17158_TXRDY:
  /*
- * TXRDY interrupt clears after reading ISR register for the UART channel.
+ * TXRDY interrupt clears after reading
+ * ISR register for the UART channel.
  */
 
  /*
-- 
2.1.4

Re: [Outreachy kernel] [PATCH] staging: dgnc: Break up long comment

[Julia Lawall]

On Wed, 21 Sep 2016, Elizabeth Ferdman wrote:

> This patch splits a long comment up into two lines; error found by checkpatch
>
> Signed-off-by: Elizabeth Ferdman <gnudevliz@gmail.com>
> ---
>  drivers/staging/dgnc/dgnc_neo.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/staging/dgnc/dgnc_neo.c b/drivers/staging/dgnc/dgnc_neo.c
> index e794056..cb63351 100644
> --- a/drivers/staging/dgnc/dgnc_neo.c
> +++ b/drivers/staging/dgnc/dgnc_neo.c
> @@ -996,7 +996,8 @@ static irqreturn_t neo_intr(int irq, void *voidbrd)
>
>   case UART_17158_TXRDY:
>   /*
> - * TXRDY interrupt clears after reading ISR register for the UART channel.
> + * TXRDY interrupt clears after reading
> + * ISR register for the UART channel.

The form of the patch is OK, but I don't think that he change is an
improvement.  I guess it was one character over before, or something like
that, because even with the added character at the front for the change,
the line looks fine.  But the main problem with the change is that the
lines now look visually similar in a way that doesn't correspond to the
semantics of the comment.  One has the impression that there are two
independent points, one about TXRDY and one about ISR, and that a period
was incorrectly omitted at the end of the first line.  But this is not the
case.  TXRDY is the subject and ISR is the object.

julia

>   */
>
>   /*
> --
> 2.1.4
>
> --
> 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/20160922011045.GA3636%40localhost.
> For more options, visit https://groups.google.com/d/optout.
>

[PATCH] staging: dgnc: Break up long comment

[Elizabeth Ferdman]

On Thu, Sep 22, 2016 at 08:08:20AM +0200, Julia Lawall wrote:
> 
> 
> On Wed, 21 Sep 2016, Elizabeth Ferdman wrote:
> 
> > This patch splits a long comment up into two lines; error found by checkpatch
> >
> > Signed-off-by: Elizabeth Ferdman <gnudevliz@gmail.com>
> > ---
> >  drivers/staging/dgnc/dgnc_neo.c | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> >
> > diff --git a/drivers/staging/dgnc/dgnc_neo.c b/drivers/staging/dgnc/dgnc_neo.c
> > index e794056..cb63351 100644
> > --- a/drivers/staging/dgnc/dgnc_neo.c
> > +++ b/drivers/staging/dgnc/dgnc_neo.c
> > @@ -996,7 +996,8 @@ static irqreturn_t neo_intr(int irq, void *voidbrd)
> >
> >   case UART_17158_TXRDY:
> >   /*
> > - * TXRDY interrupt clears after reading ISR register for the UART channel.
> > + * TXRDY interrupt clears after reading
> > + * ISR register for the UART channel.
> 
> The form of the patch is OK, but I don't think that he change is an
> improvement.  I guess it was one character over before, or something like
> that, because even with the added character at the front for the change,
> the line looks fine.  But the main problem with the change is that the
> lines now look visually similar in a way that doesn't correspond to the
> semantics of the comment.  One has the impression that there are two
> independent points, one about TXRDY and one about ISR, and that a period
> was incorrectly omitted at the end of the first line.  But this is not the
> case.  TXRDY is the subject and ISR is the object.
> 
> julia
> 
> >   */
> >
> >   /*
> > --
> > 2.1.4
> >
> > --
> > 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/20160922011045.GA3636%40localhost.
> > For more options, visit https://groups.google.com/d/optout.
> >

Julia, thanks for the feedback. It was caught by checkpatch, but it
wasn't even over 80 chars. I must have been looking at the bigger
number in vim. Since this shouldn't have been patched in the first
place, I'm not going to do any revising here. I'll just move on to
another one.

Elizabeth

Re: [Outreachy kernel] [PATCH] staging: dgnc: Break up long comment

[Julia Lawall]

On Thu, 22 Sep 2016, Elizabeth Ferdman wrote:

> On Thu, Sep 22, 2016 at 08:08:20AM +0200, Julia Lawall wrote:
> >
> >
> > On Wed, 21 Sep 2016, Elizabeth Ferdman wrote:
> >
> > > This patch splits a long comment up into two lines; error found by checkpatch
> > >
> > > Signed-off-by: Elizabeth Ferdman <gnudevliz@gmail.com>
> > > ---
> > >  drivers/staging/dgnc/dgnc_neo.c | 3 ++-
> > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/drivers/staging/dgnc/dgnc_neo.c b/drivers/staging/dgnc/dgnc_neo.c
> > > index e794056..cb63351 100644
> > > --- a/drivers/staging/dgnc/dgnc_neo.c
> > > +++ b/drivers/staging/dgnc/dgnc_neo.c
> > > @@ -996,7 +996,8 @@ static irqreturn_t neo_intr(int irq, void *voidbrd)
> > >
> > >   case UART_17158_TXRDY:
> > >   /*
> > > - * TXRDY interrupt clears after reading ISR register for the UART channel.
> > > + * TXRDY interrupt clears after reading
> > > + * ISR register for the UART channel.
> >
> > The form of the patch is OK, but I don't think that he change is an
> > improvement.  I guess it was one character over before, or something like
> > that, because even with the added character at the front for the change,
> > the line looks fine.  But the main problem with the change is that the
> > lines now look visually similar in a way that doesn't correspond to the
> > semantics of the comment.  One has the impression that there are two
> > independent points, one about TXRDY and one about ISR, and that a period
> > was incorrectly omitted at the end of the first line.  But this is not the
> > case.  TXRDY is the subject and ISR is the object.
> >
> > julia
> >
> > >   */
> > >
> > >   /*
> > > --
> > > 2.1.4
> > >
> > > --
> > > 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/20160922011045.GA3636%40localhost.
> > > For more options, visit https://groups.google.com/d/optout.
> > >
>
> Julia, thanks for the feedback. It was caught by checkpatch, but it
> wasn't even over 80 chars. I must have been looking at the bigger
> number in vim. Since this shouldn't have been patched in the first
> place, I'm not going to do any revising here. I'll just move on to
> another one.

Good job for not top posting, but it is better to put your reply right
under the text you are replying to.  I had to scan through your message
several times before finding your comment...

julia

>
> Elizabeth
>
> --
> 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/20160922224339.GC3579%40localhost.
> For more options, visit https://groups.google.com/d/optout.
>