2017-11-26 16:06:07

by Ashish Kalra

Subject: [PATCH] Removed Warning shown in checkpatch.pl for comment and white space

checkpatch.pl was showing warnings due to incorrected space at the end
of line and also not using * at start of second comment line, Corrected
the same and now there is zero warning

Signed-off-by: Ashish Kalra <[email protected]>
---
drivers/bcma/driver_pcie2.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/bcma/driver_pcie2.c b/drivers/bcma/driver_pcie2.c
index b1a6e327cb23..cf889fc62ac7 100644
--- a/drivers/bcma/driver_pcie2.c
+++ b/drivers/bcma/driver_pcie2.c
@@ -83,7 +83,8 @@ static void bcma_core_pcie2_hw_ltr_war(struct bcma_drv_pcie2 *pcie2)
bcma_core_pcie2_set_ltr_vals(pcie2);

/* TODO:
- si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0); */
+ *si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0);
+ */

/* enable the LTR */
devstsctr2 |= PCIE2_CAP_DEVSTSCTRL2_LTRENAB;
--
2.14.1

2017-11-28 02:12:10

by Ashish Kalra

Subject: [PATCH v2] drivers: bcma: driver_pcie2.c: Comment format correction & moving trailing */ to a separate line as per checkpatch

This patch fixes the checkpatch.pl warning:

WARNING: Block comments use * on subsequent lines
+ /* TODO:
+ si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0); */

WARNING: Block comments use a trailing */ on a separate line
+ si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0); */

total: 0 errors, 2 warnings, 200 lines checked
Signed-off-by: Ashish Kalra <[email protected]>
---
changes from v1 (https://lkml.org/lkml/2017/11/26/85)
v2: Improved commit message as per review from Morgan Freeman <[email protected]>

drivers/bcma/driver_pcie2.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/bcma/driver_pcie2.c b/drivers/bcma/driver_pcie2.c
index b1a6e327cb23..cf889fc62ac7 100644
--- a/drivers/bcma/driver_pcie2.c
+++ b/drivers/bcma/driver_pcie2.c
@@ -83,7 +83,8 @@ static void bcma_core_pcie2_hw_ltr_war(struct bcma_drv_pcie2 *pcie2)
bcma_core_pcie2_set_ltr_vals(pcie2);

/* TODO:
- si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0); */
+ *si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0);
+ */

/* enable the LTR */
devstsctr2 |= PCIE2_CAP_DEVSTSCTRL2_LTRENAB;
--
2.14.1

2017-11-26 17:27:53

by Morgan Freeman

Subject: Re: [PATCH] Removed Warning shown in checkpatch.pl for comment and white space

On Sun, Nov 26, 2017 at 09:35:50PM +0530, Ashish Kalra wrote:

Hi Ashish,

> checkpatch.pl was showing warnings due to incorrected space at the end
> of line and also not using * at start of second comment line, Corrected
> the same and now there is zero warning

Your patch subject is incorrect in many ways :

o It doesn't mention what driver you are cleaning.
o Don't mention the tool you used in the subject, in fact I would run
checkpatch.pl on your patch itself before sending.
o Always write commit log in *imperative mood*

Perhaps this might help you :
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes



> Signed-off-by: Ashish Kalra <[email protected]>
> ---
> drivers/bcma/driver_pcie2.c | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/bcma/driver_pcie2.c b/drivers/bcma/driver_pcie2.c
> index b1a6e327cb23..cf889fc62ac7 100644
> --- a/drivers/bcma/driver_pcie2.c
> +++ b/drivers/bcma/driver_pcie2.c
> @@ -83,7 +83,8 @@ static void bcma_core_pcie2_hw_ltr_war(struct bcma_drv_pcie2 *pcie2)
> bcma_core_pcie2_set_ltr_vals(pcie2);
>
> /* TODO:
> - si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0); */
> + *si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0);
> + */
>
> /* enable the LTR */
> devstsctr2 |= PCIE2_CAP_DEVSTSCTRL2_LTRENAB;
> --
> 2.14.1
>

2017-11-28 08:36:03

by Morgan Freeman

Subject: Re: [PATCH v2] drivers: bcma: driver_pcie2.c: Comment format correction & moving trailing */ to a separate line as per checkpatch

Hi Ashish,

On Tue, Nov 28, 2017 at 07:41:42AM +0530, Ashish Kalra wrote:
> This patch fixes the checkpatch.pl warning:

Write in _imperative_mood_ as I said before.
Like "Use this..." or "Make this..."


> WARNING: Block comments use * on subsequent lines
> + /* TODO:
> + si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0); */
>
> WARNING: Block comments use a trailing */ on a separate line
> + si_core_wrapperreg(pcie2, 3, 0x60, 0x8080, 0); */
>
> total: 0 errors, 2 warnings, 200 lines checked

No need to mention all of this!

> Signed-off-by: Ashish Kalra <[email protected]>
> ---
> changes from v1 (https://lkml.org/lkml/2017/11/26/85)
> v2: Improved commit message as per review from Morgan Freeman <[email protected]>

Your patch subject is again *wrong* here.

Look here: https://pastebin.com/X7x89Q4v

Please take a look at this :
https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

Also, don't send me the patch directly, instead to the relevant maintainer and
CC me.


Thanks
Himanshu Jha