From: "Fabio M. De Francesco" <fabio.maria.de.francesco@linux.intel.com>
To: Ayush Tiwari <ayushtiw0110@gmail.com>
Cc: Larry.Finger@lwfinger.net, florian.c.schilhabel@googlemail.com,
gregkh@linuxfoundation.org, linux-kernel@vger.kernel.org,
linux-staging@lists.linux.dev, outreachy@lists.linux.dev
Subject: Re: [PATCH v3] staging: greybus: Constify static struct kobj_type gb_audio_module_type
Date: Thu, 14 Mar 2024 14:27:50 +0100 [thread overview]
Message-ID: <2457147.jE0xQCEvom@fdefranc-mobl3> (raw)
In-Reply-To: <ZfKxooDH2ef6/1y3@ayush-HP-Pavilion-Gaming-Laptop-15-ec0xxx>
On Thursday, 14 March 2024 09:13:22 CET Ayush Tiwari wrote:
> Constify static struct kobj_type gb_audio_module_type to prevent
> modification of data shared across many instances, ensuring that the
> structure's usage is consistent and predictable throughout the driver
> and allows the compiler to place it in read-only memory.
> The kernel builds successfully without errors or new warnings,
> verifying the change.
>
> Signed-off-by: Ayush Tiwari <ayushtiw0110@gmail.com>
> ---
I think that the "Subject" line should be made shorter by deleting all the
unnecessary information. I'm not asking you to make a new version just to
address my comment, but please keep the following in mind for your next
patches.
The "Subject" line is provided (1) to briefly explain what this patch is
doing and (2) to uniquely identify the patch (e.g., in git-log output).
I'd write something like the following:
"staging: greybus: Constify gb_audio_module_type"
Who reads the subject doesn't need, and probably doesn't want, to know that
the variable you are making "const" has a "static" modifier or that its type
is "struct kobj_type". These information add nothing relevant to what the
patch is doing.
Examples of shorter, yet sufficient, "Subject" lines:
7ab4de60028e virtio-mem: Constify mem_id_table
01e1932a1748 iommu/vt-d: Constify intel_dma_ops
Thanks,
Fabio
> Changes in v3: added the message that verifies the change,
> as suggested by Julia
>
> Changes in v2: incorporated changes in commit message
> as suggested by Alison
> ---
> 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,
prev parent reply other threads:[~2024-03-14 13:27 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-14 8:13 [PATCH v3] staging: greybus: Constify static struct kobj_type gb_audio_module_type Ayush Tiwari
2024-03-14 8:15 ` Julia Lawall
2024-03-14 13:27 ` Fabio M. De Francesco [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2457147.jE0xQCEvom@fdefranc-mobl3 \
--to=fabio.maria.de.francesco@linux.intel.com \
--cc=Larry.Finger@lwfinger.net \
--cc=ayushtiw0110@gmail.com \
--cc=florian.c.schilhabel@googlemail.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=outreachy@lists.linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).