[PATCH]board/Kconfig: Add a paragraph that describes the simbol

[PATCH]board/Kconfig: Add a paragraph that describes the simbol

[Keila Novo]

Commit:
The staging board allows continous upstream
in-tree development and integration of 
new platform devices.

Signed-off-by: Keila Novo <laurana5@gmail.com>
---
 drivers/staging/board/Kconfig | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/staging/board/Kconfig b/drivers/staging/board/Kconfig
index 3f287c4..830337d 100644
--- a/drivers/staging/board/Kconfig
+++ b/drivers/staging/board/Kconfig
@@ -1,3 +1,7 @@
+#
+#Staging board gives support and configures the kernel build
+#with new type of devices, making them compatible.
+#
 config STAGING_BOARD
 	bool "Staging Board Support"
 	depends on OF_ADDRESS && OF_IRQ && CLKDEV_LOOKUP
-- 
2.7.4

Re: [PATCH]board/Kconfig: Add a paragraph that describes the simbol

[Greg Kroah-Hartman]

On Thu, Sep 29, 2016 at 05:28:37PM +0200, Keila Novo wrote:
> 
> Commit:

What is that line for?

> The staging board allows continous upstream
> in-tree development and integration of 
> new platform devices.

You have trailing whitespace, and you wrapped your paragraph at an odd
line length, why?

> 
> Signed-off-by: Keila Novo <laurana5@gmail.com>
> ---
>  drivers/staging/board/Kconfig | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/staging/board/Kconfig b/drivers/staging/board/Kconfig
> index 3f287c4..830337d 100644
> --- a/drivers/staging/board/Kconfig
> +++ b/drivers/staging/board/Kconfig
> @@ -1,3 +1,7 @@
> +#
> +#Staging board gives support and configures the kernel build
> +#with new type of devices, making them compatible.
> +#

I don't understand that sentence at all, could you rephrase it somehow?

And why not an extra ' ' after the comment character?

And finally, why make this change at all?  Kconfig files usually do not
have comments in them, right?

thanks,

greg k-h

Fwd: Re: [PATCH]board/Kconfig: Add a paragraph that describes the simbol

[keila novo]

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

---------- Mensaje reenviado ----------
De: "keila novo" <laurana5@gmail.com>
Fecha: 4 oct. 2016 7:41
Asunto: Re: [PATCH]board/Kconfig: Add a paragraph that describes the simbol
Para: "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>
Cc:

I made that change because when a checked with chechpatch.pl, it took a
warning that said: "please write a paragraph that describes the config
symbol fully". So I tried to fix it adding a little paragraph on the top of
the file.
I will try to add the changes that you suggest , I will do my best.

Thanks,

Keila



2016-10-04 6:23 GMT+02:00 Greg Kroah-Hartman <gregkh@linuxfoundation.org>:

> On Thu, Sep 29, 2016 at 05:28:37PM +0200, Keila Novo wrote:
> >
> > Commit:
>
> What is that line for?
>
> > The staging board allows continous upstream
> > in-tree development and integration of
> > new platform devices.
>
> You have trailing whitespace, and you wrapped your paragraph at an odd
> line length, why?
>
> >
> > Signed-off-by: Keila Novo <laurana5@gmail.com>
> > ---
> >  drivers/staging/board/Kconfig | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/drivers/staging/board/Kconfig
> b/drivers/staging/board/Kconfig
> > index 3f287c4..830337d 100644
> > --- a/drivers/staging/board/Kconfig
> > +++ b/drivers/staging/board/Kconfig
> > @@ -1,3 +1,7 @@
> > +#
> > +#Staging board gives support and configures the kernel build
> > +#with new type of devices, making them compatible.
> > +#
>
> I don't understand that sentence at all, could you rephrase it somehow?
>
> And why not an extra ' ' after the comment character?
>
> And finally, why make this change at all?  Kconfig files usually do not
> have comments in them, right?
>
> thanks,
>
> greg k-h
>

[-- Attachment #2: Type: text/html, Size: 2667 bytes --]

Re: Fwd: Re: [PATCH]board/Kconfig: Add a paragraph that describes the simbol

[Greg Kroah-Hartman]

Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?

A: No.
Q: Should I include quotations after my reply?


http://daringfireball.net/2007/07/on_top

On Tue, Oct 04, 2016 at 10:18:47AM +0200, keila novo wrote:
> ---------- Mensaje reenviado ----------
> De: "keila novo" <laurana5@gmail.com>
> Fecha: 4 oct. 2016 7:41
> Asunto: Re: [PATCH]board/Kconfig: Add a paragraph that describes the simbol
> Para: "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>
> Cc:
> 
> I made that change because when a checked with chechpatch.pl, it took a warning
> that said: "please write a paragraph that describes the config symbol fully".
> So I tried to fix it adding a little paragraph on the top of the file.

The "paragraph" should be in the help section for that Kconfig option,
not as a comment in the file.  If you run checkpatch.pl on the file
after you made this change, I think you will still have the same
warning, right?

But, to write a help entry for a Kconfig option, requires that you
understand what the driver and option does.  Based on your paragraph, I
don't know if you do know what this code is here for.  So perhaps you
might want to move on to a different type of warning fix?

In other words, don't make a change just because a warning shows up, but
because you understand what the warning means, and what the change you
are making does.

Hope this helps,

greg k-h

Re: Fwd: Re: [PATCH]board/Kconfig: Add a paragraph that describes the simbol

[keila novo]

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

El 4 oct. 2016 10:29, "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>
escribió:
>
>
> Q: Why is top-posting such a bad thing?
> A: Top-posting.
> Q: What is the most annoying thing in e-mail?
>
> A: No.
> Q: Should I include quotations after my reply?
>
>
> http://daringfireball.net/2007/07/on_top
>
> On Tue, Oct 04, 2016 at 10:18:47AM +0200, keila novo wrote:
> > ---------- Mensaje reenviado ----------
> > De: "keila novo" <laurana5@gmail.com>
> > Fecha: 4 oct. 2016 7:41
> > Asunto: Re: [PATCH]board/Kconfig: Add a paragraph that describes the
simbol
> > Para: "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>
> > Cc:
> >
> > I made that change because when a checked with chechpatch.pl, it took a
warning
> > that said: "please write a paragraph that describes the config symbol
fully".
> > So I tried to fix it adding a little paragraph on the top of the file.
>
> The "paragraph" should be in the help section for that Kconfig option,
> not as a comment in the file.  If you run checkpatch.pl on the file
> after you made this change, I think you will still have the same
> warning, right?
>
> But, to write a help entry for a Kconfig option, requires that you
> understand what the driver and option does.  Based on your paragraph, I
> don't know if you do know what this code is here for.  So perhaps you
> might want to move on to a different type of warning fix?
>
> In other words, don't make a change just because a warning shows up, but
> because you understand what the warning means, and what the change you
> are making does.
>
> Hope this helps,
>
> greg k-h

Thank you for your help. I will read more documentation to understand what
the code works for and I will try to complete it well. Also, I will start
again looking for another warning to fix it.

Thanks
Keila

[-- Attachment #2: Type: text/html, Size: 2576 bytes --]

[PATCH]board/Kconfig: Add a paragraph that describes the simbol.

[Keila]

The staging board allows continous upstream in-tree development and
integration of new platform devices.
---
 drivers/staging/board/Kconfig | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/staging/board/Kconfig b/drivers/staging/board/Kconfig
index 006b134..deb7fda 100644
--- a/drivers/staging/board/Kconfig
+++ b/drivers/staging/board/Kconfig
@@ -1,7 +1,6 @@
-#These is a Linux kernel configuration item. STAGING_BOARD directly depends on
-#OF_ADDRESS && OF_IRQ && CLKDEV_LOOKUP.
-#It will only be visible, if OF_ADDRESS, OF_IRQ and CLKDEV_LOOKUP are different
-#from 'n'.
+#
+#Staging board gives support and configures the Kernel build.
+#
 config STAGING_BOARD
 	bool "Staging Board Support"
 	depends on OF_ADDRESS && OF_IRQ && CLKDEV_LOOKUP
-- 
2.7.4