public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
From: Matt Coster <Matt.Coster@imgtec.com>
To: Ankan Biswas <spyjetfayed@gmail.com>
Cc: "bbrezillon@kernel.org" <bbrezillon@kernel.org>,
	"himal.prasad.ghimiray@intel.com"
	<himal.prasad.ghimiray@intel.com>,
	"dakr@kernel.org" <dakr@kernel.org>,
	"robin.clark@oss.qualcomm.com" <robin.clark@oss.qualcomm.com>,
	"matthew.brost@intel.com" <matthew.brost@intel.com>,
	"aliceryhl@google.com" <aliceryhl@google.com>,
	"thomas.hellstrom@linux.intel.com"
	<thomas.hellstrom@linux.intel.com>,
	"maarten.lankhorst@linux.intel.com"
	<maarten.lankhorst@linux.intel.com>,
	"mripard@kernel.org" <mripard@kernel.org>,
	"tzimmermann@suse.de" <tzimmermann@suse.de>,
	"simona@ffwll.ch" <simona@ffwll.ch>,
	"skhan@linuxfoundation.org" <skhan@linuxfoundation.org>,
	"khalid@kernel.org" <khalid@kernel.org>,
	"david.hunter.linux@gmail.com" <david.hunter.linux@gmail.com>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"linux-kernel-mentees@lists.linux.dev"
	<linux-kernel-mentees@lists.linux.dev>,
	"dri-devel@lists.freedesktop.org"
	<dri-devel@lists.freedesktop.org>,
	Stephen Rothwell <sfr@canb.auug.org.au>,
	Alessio Belle <Alessio.Belle@imgtec.com>,
	Alexandru Dadu <Alexandru.Dadu@imgtec.com>,
	Frank Binns <Frank.Binns@imgtec.com>
Subject: Re: [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
Date: Wed, 15 Oct 2025 13:26:16 +0000	[thread overview]
Message-ID: <d01460fe-527e-49bd-a420-289ecbc17999@imgtec.com> (raw)
In-Reply-To: <20251015113656.21447-1-spyjetfayed@gmail.com>


[-- Attachment #1.1: Type: text/plain, Size: 1466 bytes --]

On 15/10/2025 12:31, Ankan Biswas wrote:
> The kernel-doc for struct drm_gpuvm_map_req.map was added as '@op_map'
> instead of '@map', leading to this warning during htmldocs build:
> 
> WARNING: include/drm/drm_gpuvm.h:1083 struct member 'map' not described in 'drm_gpuvm_map_req'
> 
> Fixes: 000a45dce7ad ("drm/gpuvm: Pass map arguments through a struct")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Ankan Biswas <spyjetfayed@gmail.com>

Hi Ankan,

Thanks for the fix! Is there a public report from Stephen that you can
link to with a Closes: tag after the Reported-by: tag (see [1])?

Otherwise, this looks good to me and I'll be happy to R-b and take it
via drm-misc-fixes.

Cheers,
Matt

[1]: https://www.kernel.org/doc/html/latest/process/5.Posting.html#patch-formatting-and-changelogs

> ---
> Changes in v2:
> - typos fixed 'map_ops' -> '@op_map', 'map' -> '@map'
> 
>  include/drm/drm_gpuvm.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/drm/drm_gpuvm.h b/include/drm/drm_gpuvm.h
> index 8890ded1d907..476990e761f8 100644
> --- a/include/drm/drm_gpuvm.h
> +++ b/include/drm/drm_gpuvm.h
> @@ -1078,7 +1078,7 @@ struct drm_gpuva_ops {
>   */
>  struct drm_gpuvm_map_req {
>  	/**
> -	 * @op_map: struct drm_gpuva_op_map
> +	 * @map: struct drm_gpuva_op_map
>  	 */
>  	struct drm_gpuva_op_map map;
>  };

-- 
Matt Coster
E: matt.coster@imgtec.com

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

  reply	other threads:[~2025-10-15 13:27 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-15 11:31 [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map Ankan Biswas
2025-10-15 13:26 ` Matt Coster [this message]
2025-10-15 13:39 ` Danilo Krummrich
2025-10-15 15:36 ` Ankan Biswas

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=d01460fe-527e-49bd-a420-289ecbc17999@imgtec.com \
    --to=matt.coster@imgtec.com \
    --cc=Alessio.Belle@imgtec.com \
    --cc=Alexandru.Dadu@imgtec.com \
    --cc=Frank.Binns@imgtec.com \
    --cc=aliceryhl@google.com \
    --cc=bbrezillon@kernel.org \
    --cc=dakr@kernel.org \
    --cc=david.hunter.linux@gmail.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=himal.prasad.ghimiray@intel.com \
    --cc=khalid@kernel.org \
    --cc=linux-kernel-mentees@lists.linux.dev \
    --cc=linux-kernel@vger.kernel.org \
    --cc=maarten.lankhorst@linux.intel.com \
    --cc=matthew.brost@intel.com \
    --cc=mripard@kernel.org \
    --cc=robin.clark@oss.qualcomm.com \
    --cc=sfr@canb.auug.org.au \
    --cc=simona@ffwll.ch \
    --cc=skhan@linuxfoundation.org \
    --cc=spyjetfayed@gmail.com \
    --cc=thomas.hellstrom@linux.intel.com \
    --cc=tzimmermann@suse.de \
    /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