linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Amogh <amogh.linux.kernel.dev@gmail.com>
To: Matthew Wilcox <willy@infradead.org>
Cc: airlied@gmail.com, daniel@ffwll.ch,
	maarten.lankhorst@linux.intel.com,  mripard@kernel.org,
	tzimmermann@suse.de, corbet@lwn.net,
	 javier.carrasco.cruz@gmail.com, skhan@linuxfoundation.org,
	 dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org,
	 linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] Fix duplicate C declaration warnings
Date: Mon, 25 Mar 2024 13:03:10 +0530	[thread overview]
Message-ID: <287eb3f74e4c31adb065668ff49c8e1577388227.camel@gmail.com> (raw)
In-Reply-To: <Zf8--QSkEMDe9zyp@casper.infradead.org>

On Sat, 2024-03-23 at 20:43 +0000, Matthew Wilcox wrote:
> On Sat, Mar 23, 2024 at 10:01:47PM +0530, Amogh Cheluvaraj wrote:
> > Fix duplicate C declaration warnings at
> > Documentation/gpu/drm-kms.rst that was found by
> > compiling htmldocs
> 
> I'm sure this removes the warning, but it removes all kernel-doc
> which exists in drivers/gpu/drm/drm_fourcc.c.  Isn't there a more
> granular fix than this?
> 

After further introspection of the file drivers/gpu/drm/drm_fourcc.c, I
found that the warning is caused by having the same name for both the
struct and the function as in "const struct drm_format_info
*drm_format_info(u32 format)". This is an issue found using the latest
version of Sphinx as reported by Akira Yokosawa in message id
564cbd05-8788-9223-1ecc-59e7fc41b46a@gmail.com. So by changing the
function name to something like "query_drm_format_info(u32 format)" is
a possible fix. Question is what should I rename this function to, that
aligns with the coding standards? Also suggest a new function name for
"drm_modeset_lock" that causes the second warning.

  reply	other threads:[~2024-03-25  7:33 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-23 16:31 [PATCH v2] Fix duplicate C declaration warnings Amogh Cheluvaraj
2024-03-23 20:43 ` Matthew Wilcox
2024-03-25  7:33   ` Amogh [this message]
2024-03-26  4:05     ` Akira Yokosawa
2024-03-26 16:01       ` Donald Hunter

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=287eb3f74e4c31adb065668ff49c8e1577388227.camel@gmail.com \
    --to=amogh.linux.kernel.dev@gmail.com \
    --cc=airlied@gmail.com \
    --cc=corbet@lwn.net \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=javier.carrasco.cruz@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=maarten.lankhorst@linux.intel.com \
    --cc=mripard@kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=tzimmermann@suse.de \
    --cc=willy@infradead.org \
    /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 NNTP newsgroup(s).