linux-kernel - Re: [PATCH] staging: greybus: add const type to struct kobj_type gb_audio_module

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] [day] [month] [year] [list]

Message-ID: <ZfJgK51wzy06WYdn@aschofie-mobl2>
Date: Wed, 13 Mar 2024 19:25:47 -0700
From: Alison Schofield <alison.schofield@...el.com>
To: Ayush Tiwari <ayushtiw0110@...il.com>
Cc: Larry.Finger@...inger.net, florian.c.schilhabel@...glemail.com,
	gregkh@...uxfoundation.org, linux-kernel@...r.kernel.org,
	linux-staging@...ts.linux.dev, outreachy@...ts.linux.dev
Subject: Re: [PATCH] staging: greybus: add const type to struct kobj_type
 gb_audio_module_type

On Thu, Mar 14, 2024 at 12:32:57AM +0530, Ayush Tiwari wrote:
> Add type qualifier const in struct kobj_type gb_audio_module_type to
> address checkpatch warning and conform to the kernel coding style.

Thanks for the patch. A couple of things you could address in a v2:

1) 'Constify' is not a real English word, or maybe it's made its way
into an urban dictionary by now. Anyway, it's a common patch action
and you can read more about and improve the 'why' in your description.

Try: $ git log --pretty=oneline --abbrev-commit | grep Constify
and you'll find many patch examples. I think you'll find a crisper
'why' for your patch description.

Also, here's a former Outreachy Interns blog about the topic:
https://medium.com/@bhumikagoyal/linux-kernel-const-annotation-8db591148e58

2) Now that you know about the work 'Constify' please use it in your
commit message so that it doesn't cause line wrap (80 lines) when doing 
$ git log --pretty=oneline --abbrev-commit audio_manager_module.c

See the First Patch Tutorial Section: Following the Driver commit style

Alison

> 
> Signed-off-by: Ayush Tiwari <ayushtiw0110@...il.com>
> ---
>  drivers/staging/greybus/audio_manager_module.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/staging/greybus/audio_manager_module.c b/drivers/staging/greybus/audio_manager_module.c
> index 5f9dcbdbc191..4a4dfb42f50f 100644
> --- a/drivers/staging/greybus/audio_manager_module.c
> +++ b/drivers/staging/greybus/audio_manager_module.c
> @@ -144,7 +144,7 @@ static struct attribute *gb_audio_module_default_attrs[] = {
>  };
>  ATTRIBUTE_GROUPS(gb_audio_module_default);
>  
> -static struct kobj_type gb_audio_module_type = {
> +static const struct kobj_type gb_audio_module_type = {
>  	.sysfs_ops = &gb_audio_module_sysfs_ops,
>  	.release = gb_audio_module_release,
>  	.default_groups = gb_audio_module_default_groups,
> -- 
> 2.40.1
> 
>