Messages in this thread | | | Date | Mon, 21 Sep 2015 23:27:48 +0530 | Subject | Re: [PATCH] Staging: comedi: Coding style warning fix for block comments | From | punit vara <> |
| |
On Mon, Sep 21, 2015 at 11:15 PM, Ian Abbott <abbotti@mev.co.uk> wrote: > On 20/09/15 09:50, Punit Vara wrote: >> >> This patch is to comedidev.h file that fixes up following warnings >> reported by checkpatch.pl : >> >> -Block comments use a trailing */ on a separate line >> -Block comments use * on subsequent lines >> >> Signed-off-by: Punit Vara <punitvara@gmail.com> >> --- >> drivers/staging/comedi/comedidev.h | 62 >> ++++++++++++++++++++------------------ >> 1 file changed, 32 insertions(+), 30 deletions(-) >> >> diff --git a/drivers/staging/comedi/comedidev.h >> b/drivers/staging/comedi/comedidev.h >> index 28a5d3a..5b0ab03 100644 >> --- a/drivers/staging/comedi/comedidev.h >> +++ b/drivers/staging/comedi/comedidev.h >> @@ -1,20 +1,20 @@ >> /* >> - include/linux/comedidev.h >> - header file for kernel-only structures, variables, and constants >> - >> - COMEDI - Linux Control and Measurement Device Interface >> - Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org> >> - >> - 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. >> -*/ >> + * include/linux/comedidev.h >> + * header file for kernel-only structures, variables, and constants >> + * >> + * COMEDI - Linux Control and Measurement Device Interface >> + * Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org> >> + * >> + * 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 _COMEDIDEV_H >> #define _COMEDIDEV_H >> @@ -105,7 +105,7 @@ struct comedi_buf_map { >> struct kref refcount; >> }; >> >> -/** >> +/* > > > The '/**' here and on most of the other comments is deliberate. It is used > to mark things up with "kernel-doc" - see > "Documentation/kernel-doc-nano-HOWTO.txt". > >> * struct comedi_async - control data for asynchronous comedi commands >> * @prealloc_buf: preallocated buffer >> * @prealloc_bufsz: buffer size (in bytes) >> @@ -215,7 +215,7 @@ struct comedi_async { >> unsigned int x); >> }; >> >> -/** >> +/* >> * comedi_async callback "events" >> * @COMEDI_CB_EOS: end-of-scan >> * @COMEDI_CB_EOA: end-of-acquisition/output > > > Admittedly, this wasn't a valid kernel-doc comment, but I'm planning to fix > that shortly. > > Please don't bother fixing this patch as I'm about to send a larger series > of patches to comedidev.h to add more documentation and I will fix the > incorrect block comments in that series. > > -- > -=( Ian Abbott @ MEV Ltd. E-mail: <abbotti@mev.co.uk> )=- > -=( Web: http://www.mev.co.uk/ )=-
Yes sir. It was my previous patch .After Greg sir told me about that I got that mistake afterwards I didnt repeat that mistake in following patches. and yes you can fix that comments in your patches .
Have a nice day sir ;-)
| |