Re: [PATCH 1/7] media: atomisp: stop producing hundreds of kernel-doc warnings

[Mauro Carvalho Chehab <mchehab@s-opensource.com>]

Em Wed, 29 Nov 2017 10:24:57 -0200
Mauro Carvalho Chehab <mchehab@s-opensource.com> escreveu:

> Em Wed, 29 Nov 2017 14:14:54 +0200
> Sakari Ailus <sakari.ailus@linux.intel.com> escreveu:
> 
> > Hi Mauro,
> > 
> > Thanks for the patch.
> > 
> > On Wed, Nov 29, 2017 at 07:08:04AM -0500, Mauro Carvalho Chehab wrote:  
> > > A recent change on Kernel 4.15-rc1 causes all tags with
> > > /** to be handled as kernel-doc markups. Well, several
> > > atomisp modules, it doesn't use kernel-doc, but some other
> > > documentation markup (doxygen?).
> > > 
> > > So, suppress all those warns by replacing /** by /*.
> > > 
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>    
> > 
> > I presume you haven't written the patch manually. There are other changes
> > that described by the comment, too, such as removing lesser
> > than-characaters.
> > 
> > It'd be good to mention how it's been generated.  
> 
> Yeah, I used a simple script, and manually fixed a few minor things
> that were still causing warnings.
> 
> The core changes were done via:
> 
> 	for i in $(find drivers/staging/media/atomisp -type f); do sed 's,/\*\* ,/\*, ' -i $i; done
> 	for i in $(find drivers/staging/media/atomisp -type f); do sed 's,/\*\*<,/\**,' -i $i; done
> 	for i in drivers/staging/media/atomisp/pci/atomisp2/css2400/runtime/debug/src/ia_css_debug.c drivers/staging/media/atomisp/pci/atomisp2/css2400/sh_css_sp.c drivers/staging/media/atomisp/pci/atomisp2/css2400/runtime/rmgr/src/rmgr_vbuf.c; do perl -ne 's,\/\*\*$,/*,g; print $_'  $i > a && mv a $i; done;
> 
> I'll add it at the patch description.
> 
> Thanks,
> Mauro

Changed patch description to the one enclosed.


commit 699a8caa3de69b2bdaa54b9347c29644bc2222a6
Author: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date:   Wed Nov 29 03:16:17 2017 -0500

    media: atomisp: stop producing hundreds of kernel-doc warnings
    
    A recent change on Kernel 4.15-rc1 causes all tags with
    /** to be handled as kernel-doc markups. Well, several
    atomisp modules, it doesn't use kernel-doc, but some other
    documentation markup (doxygen?).
    
    So, suppress all those warns by:
            - replacing /**< by /**.
            - replacing /** by /*.
    
    The core changes were done with:
    
            for i in $(find drivers/staging/media/atomisp -type f); do sed 's,/\*\* ,/\*, ' -i $i; done
            for i in $(find drivers/staging/media/atomisp -type f); do sed 's,/\*\*<,/\**,' -i $i; done
            for i in drivers/staging/media/atomisp/pci/atomisp2/css2400/runtime/debug/src/ia_css_debug.c drivers/staging/media/atomisp/pci/atomisp2/css2400/sh_css_sp.c drivers/staging/media/atomisp/pci/atomisp2/css2400/runtime/rmgr/src/rmgr_vbuf.c; do perl -ne 's,\/\*\*$,/*,g; print $_'  $i > a && mv a $i; done;
    
    A few manual adjustments were made, where needed.
    
    Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>




Thanks,
Mauro