Re: [Ksummit-discuss] coverity, static checking etc.

[Michal Simek <monstr@monstr.eu>]

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

Hi Mauro

On 05/18/2014 06:38 PM, Mauro Carvalho Chehab wrote:
> Em Mon, 12 May 2014 08:48:11 +0200
> Michal Simek <monstr@monstr.eu> escreveu:
> 
>> The part of this discussion
>> should be also kernel-doc format checking because a lot of patches
>> are trying to use kernel-doc format but it is just broken - even checker
>> is in the kernel.
> 
> There are several drivers still using other styles for documenting functions.
> 
> I can be partially blamed for accepting such patches, but, I don't feel
> it is fair to refuse merging a patchset just because they're following some
> other documentation style. We have some really big drivers at media
> ported from another OS using Doxygen style. Fixing them would likely
> require hundreds of hours that could otherwise be used implementing
> new stuff or fixing real bugs.
> 
> So, I would rather prefer to have a (semi-)automated tool capable of
> converting from Doxygen and other styles into kernel-doc style that
> would make such conversion an easy task.

I have no experience with Doxygen but I can't see any problem.
If Doxygen is used in the kernel in any subsystem then it should
be checked if possible.
I am not definitely saying - use kernel-doc everywhere.
But I am saying when you use kernel-doc format it should be used
and checked properly.
The same is for Doxygen and others.

Warning/error should be checked and if there is any problem patch
should be rejected.

Thanks,
Michal

-- 
Michal Simek, Ing. (M.Eng), OpenPGP -> KeyID: FE3D1F91
w: www.monstr.eu p: +42-0-721842854
Maintainer of Linux kernel - Microblaze cpu - http://www.monstr.eu/fdt/
Maintainer of Linux kernel - Xilinx Zynq ARM architecture
Microblaze U-BOOT custodian and responsible for u-boot arm zynq platform



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 263 bytes --]