From: Louis Chauvet <louis.chauvet@bootlin.com>
To: Aryan Sinha <sinha.aryan03@gmail.com>
Cc: Haneen Mohammed <hamohammed.sa@gmail.com>,
Simona Vetter <simona@ffwll.ch>,
Melissa Wen <melissa.srw@gmail.com>,
Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
Maxime Ripard <mripard@kernel.org>,
Thomas Zimmermann <tzimmermann@suse.de>,
David Airlie <airlied@gmail.com>,
dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] drm/vkms: Fix kernel-doc parameter and member names
Date: Thu, 19 Nov 2026 15:33:06 +0100 [thread overview]
Message-ID: <16a151dd-de63-48ff-8e2a-2d60d71caebd@bootlin.com> (raw)
In-Reply-To: <20261012154449.42015-1-sinha.aryan03@gmail.com>
On 10/12/26 17:44, Aryan Sinha wrote:
> A handful of kernel-doc entries name things that do not exist. struct
> vkms_output documents encoder and connector and misspells wb_connector,
> struct vkms_connector calls its base member drm, vkms_crtc_init() lists a
> crtc argument it does not take, the CRTC plane helpers say crtc_config
> instead of crtc_cfg, and vkms_config_plane_get_type() is written without
> the get.
>
> struct vkms_device used a dash instead of a colon, so its entries were
> being ignored rather than warned about. Switch it over and drop output,
> which is not a member either.
>
> Signed-off-by: Aryan Sinha <sinha.aryan03@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
> ---
> @vblank_hrtimer and @period_ns in struct vkms_output are stale too, but
> they are already removed by Thomas Zimmermann's pending patch, so this
> one leaves them alone:
> https://lore.kernel.org/all/20260420131831.242882-1-tzimmermann@suse.de/
> drivers/gpu/drm/vkms/vkms_config.h | 6 +++---
> drivers/gpu/drm/vkms/vkms_connector.h | 2 +-
> drivers/gpu/drm/vkms/vkms_drv.h | 11 ++++-------
> 3 files changed, 8 insertions(+), 11 deletions(-)
>
> diff --git a/drivers/gpu/drm/vkms/vkms_config.h b/drivers/gpu/drm/vkms/vkms_config.h
> index 8f7f286a4..56805b0c9 100644
> --- a/drivers/gpu/drm/vkms/vkms_config.h
> +++ b/drivers/gpu/drm/vkms/vkms_config.h
> @@ -269,7 +269,7 @@ struct vkms_config_plane *vkms_config_create_plane(struct vkms_config *config);
> void vkms_config_destroy_plane(struct vkms_config_plane *plane_cfg);
>
> /**
> - * vkms_config_plane_type() - Return the plane type
> + * vkms_config_plane_get_type() - Return the plane type
> * @plane_cfg: Plane to get the type from
> */
> static inline enum drm_plane_type
> @@ -373,7 +373,7 @@ vkms_config_crtc_set_writeback(struct vkms_config_crtc *crtc_cfg,
> /**
> * vkms_config_crtc_primary_plane() - Return the primary plane for a CRTC
> * @config: Configuration containing the CRTC
> - * @crtc_config: Target CRTC
> + * @crtc_cfg: Target CRTC
> *
> * Note that, if multiple primary planes are found, the first one is returned.
> * In this case, the configuration will be invalid. See vkms_config_is_valid().
> @@ -387,7 +387,7 @@ struct vkms_config_plane *vkms_config_crtc_primary_plane(const struct vkms_confi
> /**
> * vkms_config_crtc_cursor_plane() - Return the cursor plane for a CRTC
> * @config: Configuration containing the CRTC
> - * @crtc_config: Target CRTC
> + * @crtc_cfg: Target CRTC
> *
> * Note that, if multiple cursor planes are found, the first one is returned.
> * In this case, the configuration will be invalid. See vkms_config_is_valid().
> diff --git a/drivers/gpu/drm/vkms/vkms_connector.h b/drivers/gpu/drm/vkms/vkms_connector.h
> index ed312f4ef..52ae97af2 100644
> --- a/drivers/gpu/drm/vkms/vkms_connector.h
> +++ b/drivers/gpu/drm/vkms/vkms_connector.h
> @@ -11,7 +11,7 @@
> /**
> * struct vkms_connector - VKMS custom type wrapping around the DRM connector
> *
> - * @drm: Base DRM connector
> + * @base: Base DRM connector
> */
> struct vkms_connector {
> struct drm_connector base;
> diff --git a/drivers/gpu/drm/vkms/vkms_drv.h b/drivers/gpu/drm/vkms/vkms_drv.h
> index 0933e4ce0..1c94a2dea 100644
> --- a/drivers/gpu/drm/vkms/vkms_drv.h
> +++ b/drivers/gpu/drm/vkms/vkms_drv.h
> @@ -202,9 +202,8 @@ struct vkms_crtc_state {
> * struct vkms_output - Internal representation of all output components in VKMS
> *
> * @crtc: Base CRTC in DRM
> - * @encoder: DRM encoder used for this output
> - * @connector: DRM connector used for this output
> - * @wb_connecter: DRM writeback connector used for this output
> + * @wb_connector: DRM writeback connector used for this output
> + * @wb_encoder: DRM encoder used for this output
> * @vblank_hrtimer: Timer used to trigger the vblank
> * @period_ns: vblank period, in nanoseconds, used to configure @vblank_hrtimer and to compute
> * vblank timestamps
> @@ -234,9 +233,8 @@ struct vkms_config_plane;
> /**
> * struct vkms_device - Description of a VKMS device
> *
> - * @drm - Base device in DRM
> - * @faux_dev - Associated faux device
> - * @output - Configuration and sub-components of the VKMS device
> + * @drm: Base device in DRM
> + * @faux_dev: Associated faux device
> * @config: Configuration used in this VKMS device
> */
> struct vkms_device {
> @@ -284,7 +282,6 @@ void vkms_destroy(struct vkms_config *config);
> /**
> * vkms_crtc_init() - Initialize a CRTC for VKMS
> * @dev: DRM device associated with the VKMS buffer
> - * @crtc: uninitialized CRTC device
> * @primary: primary plane to attach to the CRTC
> * @cursor: plane to attach to the CRTC
> */
next prev parent reply other threads:[~2026-11-19 14:33 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-12 15:44 [PATCH] drm/vkms: Fix kernel-doc parameter and member names Aryan Sinha
2026-11-19 14:33 ` Louis Chauvet [this message]
2026-11-19 15:06 ` Louis Chauvet
-- strict thread matches above, loose matches on Subject: below --
2026-10-16 10:15 Aryan Sinha
2026-10-16 13:49 ` Aryan Sinha
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=16a151dd-de63-48ff-8e2a-2d60d71caebd@bootlin.com \
--to=louis.chauvet@bootlin.com \
--cc=airlied@gmail.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=hamohammed.sa@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=melissa.srw@gmail.com \
--cc=mripard@kernel.org \
--cc=simona@ffwll.ch \
--cc=sinha.aryan03@gmail.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