2015-11-22 19:20:18

by Jitendra

[permalink] [raw]
Subject: [PATCH] staging: comedi: Coding style warning fix for block comments

This patch is to comedilib.h file that fixes up following warnings
reported by checkpatch.pl :
I) Block comments use * on subsequent lines

Signed-off-by: Jitendra Kumar Khasdev <[email protected]>
---
drivers/staging/comedi/comedilib.h | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/drivers/staging/comedi/comedilib.h b/drivers/staging/comedi/comedilib.h
index 56baf85..ccbe17b 100644
--- a/drivers/staging/comedi/comedilib.h
+++ b/drivers/staging/comedi/comedilib.h
@@ -1,20 +1,20 @@
/*
- linux/include/comedilib.h
- header file for kcomedilib
-
- COMEDI - Linux Control and Measurement Device Interface
- Copyright (C) 1998-2001 David A. Schleef <[email protected]>
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-*/
+ * linux/include/comedilib.h
+ * header file for kcomedilib
+ *
+ * COMEDI - Linux Control and Measurement Device Interface
+ * Copyright (C) 1998-2001 David A. Schleef <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ */

#ifndef _LINUX_COMEDILIB_H
#define _LINUX_COMEDILIB_H
--
1.9.1


2015-11-22 19:24:44

by Andy Shevchenko

[permalink] [raw]
Subject: Re: [PATCH] staging: comedi: Coding style warning fix for block comments

On Sun, Nov 22, 2015 at 9:19 PM, Jitendra Kumar Khasdev
<[email protected]> wrote:
> This patch is to comedilib.h file that fixes up following warnings
> reported by checkpatch.pl :
> I) Block comments use * on subsequent lines
>
> Signed-off-by: Jitendra Kumar Khasdev <[email protected]>
> ---
> drivers/staging/comedi/comedilib.h | 32 ++++++++++++++++----------------
> 1 file changed, 16 insertions(+), 16 deletions(-)
>
> diff --git a/drivers/staging/comedi/comedilib.h b/drivers/staging/comedi/comedilib.h
> index 56baf85..ccbe17b 100644
> --- a/drivers/staging/comedi/comedilib.h
> +++ b/drivers/staging/comedi/comedilib.h
> @@ -1,20 +1,20 @@
> /*
> - linux/include/comedilib.h

I don't think the file name is somehow useful here.


> - header file for kcomedilib

Perhaps

* Header file for kcomedilib.

> -
> - COMEDI - Linux Control and Measurement Device Interface
> - Copyright (C) 1998-2001 David A. Schleef <[email protected]>
> -
> - This program is free software; you can redistribute it and/or modify
> - it under the terms of the GNU General Public License as published by
> - the Free Software Foundation; either version 2 of the License, or
> - (at your option) any later version.
> -
> - This program is distributed in the hope that it will be useful,
> - but WITHOUT ANY WARRANTY; without even the implied warranty of
> - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> - GNU General Public License for more details.
> -*/
> + * linux/include/comedilib.h
> + * header file for kcomedilib
> + *
> + * COMEDI - Linux Control and Measurement Device Interface
> + * Copyright (C) 1998-2001 David A. Schleef <[email protected]>
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + */
>
> #ifndef _LINUX_COMEDILIB_H
> #define _LINUX_COMEDILIB_H
> --
> 1.9.1
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to [email protected]
> More majordomo info at http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at http://www.tux.org/lkml/



--
With Best Regards,
Andy Shevchenko

2015-11-23 10:27:51

by Ian Abbott

[permalink] [raw]
Subject: Re: [PATCH] staging: comedi: Coding style warning fix for block comments

On 22/11/15 19:24, Andy Shevchenko wrote:
> On Sun, Nov 22, 2015 at 9:19 PM, Jitendra Kumar Khasdev
> <[email protected]> wrote:
>> This patch is to comedilib.h file that fixes up following warnings
>> reported by checkpatch.pl :
>> I) Block comments use * on subsequent lines
>>
>> Signed-off-by: Jitendra Kumar Khasdev <[email protected]>
>> ---
>> drivers/staging/comedi/comedilib.h | 32 ++++++++++++++++----------------
>> 1 file changed, 16 insertions(+), 16 deletions(-)
>>
>> diff --git a/drivers/staging/comedi/comedilib.h b/drivers/staging/comedi/comedilib.h
>> index 56baf85..ccbe17b 100644
>> --- a/drivers/staging/comedi/comedilib.h
>> +++ b/drivers/staging/comedi/comedilib.h
>> @@ -1,20 +1,20 @@
>> /*
>> - linux/include/comedilib.h
>
> I don't think the file name is somehow useful here.

To be fair, this patch is merely fixing the comment style, rather than
changing the contents. Although I wouldn't mind if this line were
changed, especially as the existing pathname is wrong.

It could be changed to be just the basename of the header file like this:

* comedilib.h

which is similar to the header comment in comedidev.h.

>
>
>> - header file for kcomedilib
>
> Perhaps
>
> * Header file for kcomedilib.

No objections there.

--
-=( Ian Abbott @ MEV Ltd. E-mail: <[email protected]> )=-
-=( Web: http://www.mev.co.uk/ )=-

2015-11-23 10:30:04

by Ian Abbott

[permalink] [raw]
Subject: Re: [PATCH] staging: comedi: Coding style warning fix for block comments

On 22/11/15 19:19, Jitendra Kumar Khasdev wrote:
> This patch is to comedilib.h file that fixes up following warnings
> reported by checkpatch.pl :
> I) Block comments use * on subsequent lines
>
> Signed-off-by: Jitendra Kumar Khasdev <[email protected]>
> ---
> drivers/staging/comedi/comedilib.h | 32 ++++++++++++++++----------------
> 1 file changed, 16 insertions(+), 16 deletions(-)

Please could you mention comedilib.h in the Subject line? E.g.:

staging: comedi: comedilib.h: Fix block comments

It helps to localize the affected area more.

--
-=( Ian Abbott @ MEV Ltd. E-mail: <[email protected]> )=-
-=( Web: http://www.mev.co.uk/ )=-