Skip to contentSkip to conversation

Staging: fpgaboot: Delete newline at end of file

PATCH Superseded Elisa Tsai 3 participants 6 messages Feb 28, 2019 – Mar 1, 2019 Staging

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Elisa Tsai

author
#0 lore raw

PATCH 1/1 Staging: fpgaboot: Delete newline at end of file

From: E-Tsai <[email protected]>

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

---
 drivers/staging/gs_fpgaboot/Kconfig | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/gs_fpgaboot/Kconfig +1 -1
index 550645291fab..f1179eef2d78 100644
@@ -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
Signature · 1 line
2.17.1
#1 lore raw
Quoted 6 lines · Elisa Tsai

From: E-Tsai <[email protected]>

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

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

Quoted 9 lines
---
 drivers/staging/gs_fpgaboot/Kconfig | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/gs_fpgaboot/Kconfig +0 -0
index 550645291fab..f1179eef2d78 100644

drivers/staging/gs_fpgaboot/Kconfig config GS_FPGABOOT · line 8

Quoted 5 lines
drivers/staging/gs_fpgaboot/Kconfig +1 -1
@@ -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

Quoted 11 lines

\ 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 [email protected]. To post to this group, send email to [email protected].
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.

#2 lore raw

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.

Quoted 54 lines · 在 2019年3月1日星期五 UTC+8上午4:12:20,Julia Lawall写道:
Quoted 6 lines · Elisa Tsai

From: E-Tsai <[email protected] <javascript:>>

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

Signed-off-by E-Tsai <[email protected] <javascript:>>

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

Review

Quoted 5 lines

---

 drivers/staging/gs_fpgaboot/Kconfig | 2 +- 
 1 file changed, 1 insertion(+), 1 deletion(-) 
(quoted diff) +0 -0

b/drivers/staging/gs_fpgaboot/Kconfig

drivers/staging/gs_fpgaboot/Kconfig config GS_FPGABOOT · line 8

Quoted 9 lines

index 550645291fab..f1179eef2d78 100644

drivers/staging/gs_fpgaboot/Kconfig +1 -1
@@ -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

Quoted 6 lines

\ No newline at end of file

Signature · 4 lines
2.17.1 

-- 
You received this message because you are subscribed to the Google 

Groups "outreachy-kernel" group.

Quoted 1 line

To unsubscribe from this group and stop receiving emails from it, send

an email to [email protected] <javascript:>.

Quoted 1 line

To post to this group, send email to [email protected]

<javascript:>.

Quoted 1 line

To view this discussion on the web visit

https://groups.google.com/d/msgid/outreachy-kernel/20190228162703.14828-1-etsai042%40gmail.com.

Quoted 2 lines

For more options, visit https://groups.google.com/d/optout.

#3 lore raw
Quoted 7 lines · On Thu, 28 Feb 2019, [email protected] 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

Quoted 8 lines

  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

Quoted 67 lines · 在 2019年3月1日星期五 UTC+8上午4:12:20,Julia Lawall写道:

On Fri, 1 Mar 2019, Elisa Tsai wrote:

> From: E-Tsai <[email protected]>
>
> This patch fixes the checkpatch.pl warning:
> WARNING: please write a paragraph that describes the config symbol fully
>
> Signed-off-by: E-Tsai <[email protected]>

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 [email protected].
> To post to this group, send email to
[email protected].
> 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 [email protected].
To post to this group, send email to [email protected].
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.

#4 lore raw

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

Quoted 103 lines · 在 2019年3月1日星期五 UTC+8下午4:20:28,Julia Lawall写道:
Quoted 7 lines · On Thu, 28 Feb 2019, [email protected] <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

Quoted 8 lines

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

Quoted 40 lines · 在 2019年3月1日星期五 UTC+8上午4:12:20,Julia Lawall写道:

On Fri, 1 Mar 2019, Elisa Tsai wrote:

> From: E-Tsai <[email protected]>
>
> This patch fixes the checkpatch.pl warning:
> WARNING: please write a paragraph that describes the config symbol fully
>
> Signed-off-by: E-Tsai <[email protected]>

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

Quoted 12 lines

> \ 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 [email protected]. > To post to this group, send email to [email protected].
> To view this discussion on the web visithttps://

groups.google.com/d/msgid/outreachy-kernel/20190228162703.14828-1-e

Quoted 6 lines
      tsai042%40gmail.com. 
      > For more options, visit https://groups.google.com/d/optout. 
      > 
Signature · 1 line
You received this message because you are subscribed to the Google 

Groups

Quoted 2 lines

"outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send

an

Quoted 2 lines

email to [email protected] <javascript:>. To post to this group, send email to [email protected]

<javascript:>.

Quoted 1 line

To view this discussion on the web visithttps://

groups.google.com/d/msgid/outreachy-kernel/7cbedee6-4634-4634-830e-

Quoted 4 lines

0084b6e921f7%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.