linux-kernel - RE: [PATCH v2] Staging: comedi: addi-data: Fix long CamelCase function names

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Tue, 11 Mar 2014 17:53:39 +0000
From:	Hartley Sweeten <HartleyS@...ionengravers.com>
To:	Joe Perches <joe@...ches.com>
CC:	Fred Akers <knivey@...ops.net>,
	"gregkh@...uxfoundation.org" <gregkh@...uxfoundation.org>,
	"abbotti@....co.uk" <abbotti@....co.uk>,
	"devel@...verdev.osuosl.org" <devel@...verdev.osuosl.org>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: RE: [PATCH v2] Staging: comedi: addi-data: Fix long CamelCase
 function names

On Tuesday, March 11, 2014 10:49 AM, Joe Perches wrote:
> On Tue, 2014-03-11 at 17:42 +0000, Hartley Sweeten wrote:
>> On Tuesday, March 11, 2014 10:33 AM, Fred Akers wrote:
>>> This patch fixes a few function names that are very long and are
>>> not in the correct naming style
> []
>>> diff --git a/drivers/staging/comedi/drivers/addi-data/hwdrv_apci035.c b/drivers/staging/comedi/drivers/addi-data/hwdrv_apci035.c
> []
>>> @@ -111,7 +111,7 @@ static int i_Temp;
>>>  static int i_Flag = 1;
>>>  /*
>>>  +----------------------------------------------------------------------------+
>>> -| Function   Name   : int i_APCI035_ConfigTimerWatchdog                      |
>>> +| Function   Name   : int apci035_timer_config                      |
>>>  |			  (struct comedi_device *dev,struct comedi_subdevice *s,               |
>>>  |                      struct comedi_insn *insn,unsigned int *data)                     |
>>>  +----------------------------------------------------------------------------+
>> 
>> Nitpick... These obvious function comment blocks should be removed.
>> That should be a separate patch. Maybe a patch 1/2 before this one so
>> you don't have to update the comments.
>
> Maybe convert them to kernel-doc style?
>
> /**
>  * foobar() - short function description of foobar
>  * @arg1:	Describe the first argument to foobar.
>  * @arg2:	Describe the second argument to foobar.
>  *		One can provide multiple line descriptions
>  *		for arguments.

For exported functions I agree, but the (dev, s, insn, data) is athe standard
parameter list for most of the comedi subdevice callbacks. I don't think
these need any comments.

Regards,
Hartley

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/