All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] Staging: fpgaboot: Delete newline at end of file
@ 2019-02-28 16:27 Elisa Tsai
  2019-02-28 20:12 ` [Outreachy kernel] " Julia Lawall
  2019-03-01  8:00 ` Greg KH
  0 siblings, 2 replies; 6+ messages in thread
From: Elisa Tsai @ 2019-02-28 16:27 UTC (permalink / raw)
  To: outreachy-kernel; +Cc: E-Tsai

From: E-Tsai <etsai042@gmail.com>

This patch fixes the checkpatch.pl warning:
WARNING: please write a paragraph that describes the config symbol fully

Signed-off-by: E-Tsai <etsai042@gmail.com>
---
 drivers/staging/gs_fpgaboot/Kconfig | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/staging/gs_fpgaboot/Kconfig b/drivers/staging/gs_fpgaboot/Kconfig
index 550645291fab..f1179eef2d78 100644
--- a/drivers/staging/gs_fpgaboot/Kconfig
+++ b/drivers/staging/gs_fpgaboot/Kconfig
@@ -5,4 +5,4 @@ config GS_FPGABOOT
 	tristate "Xilinx FPGA firmware download module"
 	default n
 	help
-	  Xilinx FPGA firmware download module
+	  Xilinx FPGA firmware download module
\ No newline at end of file
-- 
2.17.1



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

* Re: [Outreachy kernel] [PATCH] Staging: fpgaboot: Delete newline at end of file
  2019-02-28 16:27 [PATCH] Staging: fpgaboot: Delete newline at end of file Elisa Tsai
@ 2019-02-28 20:12 ` Julia Lawall
  2019-03-01  3:18   ` etsai042
  2019-03-01  8:00 ` Greg KH
  1 sibling, 1 reply; 6+ messages in thread
From: Julia Lawall @ 2019-02-28 20:12 UTC (permalink / raw)
  To: Elisa Tsai; +Cc: outreachy-kernel



On Fri, 1 Mar 2019, Elisa Tsai wrote:

> From: E-Tsai <etsai042@gmail.com>
>
> This patch fixes the checkpatch.pl warning:
> WARNING: please write a paragraph that describes the config symbol fully
>
> Signed-off-by: E-Tsai <etsai042@gmail.com>

If your real name is Elisa Tsai, you should put that.

> ---
>  drivers/staging/gs_fpgaboot/Kconfig | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/staging/gs_fpgaboot/Kconfig b/drivers/staging/gs_fpgaboot/Kconfig
> index 550645291fab..f1179eef2d78 100644
> --- a/drivers/staging/gs_fpgaboot/Kconfig
> +++ b/drivers/staging/gs_fpgaboot/Kconfig
> @@ -5,4 +5,4 @@ config GS_FPGABOOT
>  	tristate "Xilinx FPGA firmware download module"
>  	default n
>  	help
> -	  Xilinx FPGA firmware download module
> +	  Xilinx FPGA firmware download module

I don't see the change here.

This is probably not the best first patch to send, because without
expertise in the device, you won't know what paragraph to write.

julia

> \ No newline at end of file
> --
> 2.17.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/20190228162703.14828-1-etsai042%40gmail.com.
> For more options, visit https://groups.google.com/d/optout.
>


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

* Re: [Outreachy kernel] [PATCH] Staging: fpgaboot: Delete newline at end of file
  2019-02-28 20:12 ` [Outreachy kernel] " Julia Lawall
@ 2019-03-01  3:18   ` etsai042
  2019-03-01  8:20     ` Julia Lawall
  0 siblings, 1 reply; 6+ messages in thread
From: etsai042 @ 2019-03-01  3:18 UTC (permalink / raw)
  To: outreachy-kernel


[-- Attachment #1.1: Type: text/plain, Size: 2767 bytes --]

Hi, Julia! There is a checkpatch.pl warning 
of drivers/staging/gs_fpgaboot/Kconfig because, as it is written in 
Documentation/kbuild/kconfig-language.txt (line178):
------------
Every line starts with a key word and can be followed by multiple
- help text: "help" or "---help---"
  This defines a help text. The end of the help text is determined by
  the indentation level, this means it ends at the first line which has
  a smaller indentation than the first line of the help text.
  "---help---" and "help" do not differ in behaviour, "---help---" is
  used to help visually separate configuration logic from help within
  the file as an aid to developers.
------------
The newline at the end of Kconfig file is the reason of this warning, 
deleting it is the change I made. I did not made major change to its 
context, just fixed its code style.

在 2019年3月1日星期五 UTC+8上午4:12:20,Julia Lawall写道:
>
>
>
> On Fri, 1 Mar 2019, Elisa Tsai wrote: 
>
> > From: E-Tsai <etsa...@gmail.com <javascript:>> 
> > 
> > This patch fixes the checkpatch.pl warning: 
> > WARNING: please write a paragraph that describes the config symbol fully 
> > 
> > Signed-off-by: E-Tsai <etsa...@gmail.com <javascript:>> 
>
> If your real name is Elisa Tsai, you should put that. 
>
> > --- 
> >  drivers/staging/gs_fpgaboot/Kconfig | 2 +- 
> >  1 file changed, 1 insertion(+), 1 deletion(-) 
> > 
> > diff --git a/drivers/staging/gs_fpgaboot/Kconfig 
> b/drivers/staging/gs_fpgaboot/Kconfig 
> > index 550645291fab..f1179eef2d78 100644 
> > --- a/drivers/staging/gs_fpgaboot/Kconfig 
> > +++ b/drivers/staging/gs_fpgaboot/Kconfig 
> > @@ -5,4 +5,4 @@ config GS_FPGABOOT 
> >          tristate "Xilinx FPGA firmware download module" 
> >          default n 
> >          help 
> > -          Xilinx FPGA firmware download module 
> > +          Xilinx FPGA firmware download module 
>
> I don't see the change here. 
>
> This is probably not the best first patch to send, because without 
> expertise in the device, you won't know what paragraph to write. 
>
> julia 
>
> > \ No newline at end of file 
> > -- 
> > 2.17.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-kern...@googlegroups.com <javascript:>. 
> > To post to this group, send email to outreach...@googlegroups.com 
> <javascript:>. 
> > To view this discussion on the web visit 
> https://groups.google.com/d/msgid/outreachy-kernel/20190228162703.14828-1-etsai042%40gmail.com. 
>
> > For more options, visit https://groups.google.com/d/optout. 
> > 
>

[-- Attachment #1.2: Type: text/html, Size: 5216 bytes --]

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

* Re: [Outreachy kernel] [PATCH] Staging: fpgaboot: Delete newline at end of file
  2019-02-28 16:27 [PATCH] Staging: fpgaboot: Delete newline at end of file Elisa Tsai
  2019-02-28 20:12 ` [Outreachy kernel] " Julia Lawall
@ 2019-03-01  8:00 ` Greg KH
  1 sibling, 0 replies; 6+ messages in thread
From: Greg KH @ 2019-03-01  8:00 UTC (permalink / raw)
  To: Elisa Tsai; +Cc: outreachy-kernel

On Fri, Mar 01, 2019 at 12:27:03AM +0800, Elisa Tsai wrote:
> From: E-Tsai <etsai042@gmail.com>
> 
> This patch fixes the checkpatch.pl warning:
> WARNING: please write a paragraph that describes the config symbol fully
> 
> Signed-off-by: E-Tsai <etsai042@gmail.com>

As Julia said, use your real name here and for the From: line.

Please fix up and resend.

thanks,

greg k-h


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

* Re: [Outreachy kernel] [PATCH] Staging: fpgaboot: Delete newline at end of file
  2019-03-01  3:18   ` etsai042
@ 2019-03-01  8:20     ` Julia Lawall
  2019-03-01  8:30       ` etsai042
  0 siblings, 1 reply; 6+ messages in thread
From: Julia Lawall @ 2019-03-01  8:20 UTC (permalink / raw)
  To: etsai042; +Cc: outreachy-kernel

[-- Attachment #1: Type: text/plain, Size: 3887 bytes --]



On Thu, 28 Feb 2019, etsai042@gmail.com wrote:

> Hi, Julia! There is a checkpatch.pl warning
> of drivers/staging/gs_fpgaboot/Kconfig because, as it is written in
> Documentation/kbuild/kconfig-language.txt (line178):------------
> Every line starts with a key word and can be followed by multiple
> - help text: "help" or "---help---"
>   This defines a help text. The end of the help text is determined by
>   the indentation level, this means it ends at the first line which has
>   a smaller indentation than the first line of the help text.
>   "---help---" and "help" do not differ in behaviour, "---help---" is
>   used to help visually separate configuration logic from help within
>   the file as an aid to developers.
> ------------
> The newline at the end of Kconfig file is the reason of this warning,
> deleting it is the change I made. I did not made major change to its
> context, just fixed its code style.

OK, this is a good example, of why a log message of "Fix checkpatch
warning X" is not very helpful.  There is no way to guess the relationship
between the warning message and the change.  The log message should say
what you do and why.  So here is would be

"Add a missing newline at the end of a Kconfig file, to silence the
checkpatch warning ..."

julia

>
> 在 2019年3月1日星期五 UTC+8上午4:12:20,Julia Lawall写道:
>
>
>       On Fri, 1 Mar 2019, Elisa Tsai wrote:
>
>       > From: E-Tsai <etsa...@gmail.com>
>       >
>       > This patch fixes the checkpatch.pl warning:
>       > WARNING: please write a paragraph that describes the config
>       symbol fully
>       >
>       > Signed-off-by: E-Tsai <etsa...@gmail.com>
>
>       If your real name is Elisa Tsai, you should put that.
>
>       > ---
>       >  drivers/staging/gs_fpgaboot/Kconfig | 2 +-
>       >  1 file changed, 1 insertion(+), 1 deletion(-)
>       >
>       > diff --git a/drivers/staging/gs_fpgaboot/Kconfig
>       b/drivers/staging/gs_fpgaboot/Kconfig
>       > index 550645291fab..f1179eef2d78 100644
>       > --- a/drivers/staging/gs_fpgaboot/Kconfig
>       > +++ b/drivers/staging/gs_fpgaboot/Kconfig
>       > @@ -5,4 +5,4 @@ config GS_FPGABOOT
>       >          tristate "Xilinx FPGA firmware download module"
>       >          default n
>       >          help
>       > -          Xilinx FPGA firmware download module
>       > +          Xilinx FPGA firmware download module
>
>       I don't see the change here.
>
>       This is probably not the best first patch to send, because
>       without
>       expertise in the device, you won't know what paragraph to write.
>
>       julia
>
>       > \ No newline at end of file
>       > --
>       > 2.17.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-kern...@googlegroups.com.
>       > To post to this group, send email to
>       outreach...@googlegroups.com.
>       > To view this discussion on the web visithttps://groups.google.com/d/msgid/outreachy-kernel/20190228162703.14828-1-e
>       tsai042%40gmail.com.
>       > 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 visithttps://groups.google.com/d/msgid/outreachy-kernel/7cbedee6-4634-4634-830e-
> 0084b6e921f7%40googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.
>
>

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

* Re: [Outreachy kernel] [PATCH] Staging: fpgaboot: Delete newline at end of file
  2019-03-01  8:20     ` Julia Lawall
@ 2019-03-01  8:30       ` etsai042
  0 siblings, 0 replies; 6+ messages in thread
From: etsai042 @ 2019-03-01  8:30 UTC (permalink / raw)
  To: outreachy-kernel


[-- Attachment #1.1: Type: text/plain, Size: 4379 bytes --]

Thanks Julia! I'll be more careful with it :D

在 2019年3月1日星期五 UTC+8下午4:20:28,Julia Lawall写道:
>
>
>
> On Thu, 28 Feb 2019, etsa...@gmail.com <javascript:> wrote: 
>
> > Hi, Julia! There is a checkpatch.pl warning 
> > of drivers/staging/gs_fpgaboot/Kconfig because, as it is written in 
> > Documentation/kbuild/kconfig-language.txt (line178):------------ 
> > Every line starts with a key word and can be followed by multiple 
> > - help text: "help" or "---help---" 
> >   This defines a help text. The end of the help text is determined by 
> >   the indentation level, this means it ends at the first line which has 
> >   a smaller indentation than the first line of the help text. 
> >   "---help---" and "help" do not differ in behaviour, "---help---" is 
> >   used to help visually separate configuration logic from help within 
> >   the file as an aid to developers. 
> > ------------ 
> > The newline at the end of Kconfig file is the reason of this warning, 
> > deleting it is the change I made. I did not made major change to its 
> > context, just fixed its code style. 
>
> OK, this is a good example, of why a log message of "Fix checkpatch 
> warning X" is not very helpful.  There is no way to guess the relationship 
> between the warning message and the change.  The log message should say 
> what you do and why.  So here is would be 
>
> "Add a missing newline at the end of a Kconfig file, to silence the 
> checkpatch warning ..." 
>
> julia 
>
> > 
> > 在 2019年3月1日星期五 UTC+8上午4:12:20,Julia Lawall写道: 
> > 
> > 
> >       On Fri, 1 Mar 2019, Elisa Tsai wrote: 
> > 
> >       > From: E-Tsai <etsa...@gmail.com> 
> >       > 
> >       > This patch fixes the checkpatch.pl warning: 
> >       > WARNING: please write a paragraph that describes the config 
> >       symbol fully 
> >       > 
> >       > Signed-off-by: E-Tsai <etsa...@gmail.com> 
> > 
> >       If your real name is Elisa Tsai, you should put that. 
> > 
> >       > --- 
> >       >  drivers/staging/gs_fpgaboot/Kconfig | 2 +- 
> >       >  1 file changed, 1 insertion(+), 1 deletion(-) 
> >       > 
> >       > diff --git a/drivers/staging/gs_fpgaboot/Kconfig 
> >       b/drivers/staging/gs_fpgaboot/Kconfig 
> >       > index 550645291fab..f1179eef2d78 100644 
> >       > --- a/drivers/staging/gs_fpgaboot/Kconfig 
> >       > +++ b/drivers/staging/gs_fpgaboot/Kconfig 
> >       > @@ -5,4 +5,4 @@ config GS_FPGABOOT 
> >       >          tristate "Xilinx FPGA firmware download module" 
> >       >          default n 
> >       >          help 
> >       > -          Xilinx FPGA firmware download module 
> >       > +          Xilinx FPGA firmware download module 
> > 
> >       I don't see the change here. 
> > 
> >       This is probably not the best first patch to send, because 
> >       without 
> >       expertise in the device, you won't know what paragraph to write. 
> > 
> >       julia 
> > 
> >       > \ No newline at end of file 
> >       > -- 
> >       > 2.17.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-kern...@googlegroups.com. 
> >       > To post to this group, send email to 
> >       outreach...@googlegroups.com. 
> >       > To view this discussion on the web visithttps://
> groups.google.com/d/msgid/outreachy-kernel/20190228162703.14828-1-e 
> >       tsai042%40gmail.com. 
> >       > 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-kern...@googlegroups.com <javascript:>. 
> > To post to this group, send email to outreach...@googlegroups.com 
> <javascript:>. 
> > To view this discussion on the web visithttps://
> groups.google.com/d/msgid/outreachy-kernel/7cbedee6-4634-4634-830e- 
> > 0084b6e921f7%40googlegroups.com. 
> > For more options, visit https://groups.google.com/d/optout. 
> > 
> >


[-- Attachment #1.2: Type: text/html, Size: 8808 bytes --]

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

end of thread, other threads:[~2019-03-01  8:30 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-02-28 16:27 [PATCH] Staging: fpgaboot: Delete newline at end of file Elisa Tsai
2019-02-28 20:12 ` [Outreachy kernel] " Julia Lawall
2019-03-01  3:18   ` etsai042
2019-03-01  8:20     ` Julia Lawall
2019-03-01  8:30       ` etsai042
2019-03-01  8:00 ` Greg KH

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.