linux-kernel - Re: [PATCH 2/2] drm/debugfs: add descriptions to struct parameters

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

Message-ID: <2593d606-f8f6-5fb4-f82c-f1183b11aa3f@igalia.com>
Date:   Tue, 10 Jan 2023 11:06:35 -0300
From:   Maíra Canal <mcanal@...lia.com>
To:     Stephen Rothwell <sfr@...b.auug.org.au>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        Maxime Ripard <mripard@...nel.org>,
        Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
        Thomas Zimmermann <tzimmermann@...e.de>,
        David Airlie <airlied@...il.com>,
        Daniel Vetter <daniel@...ll.ch>
Cc:     Melissa Wen <mwen@...lia.com>,
        André Almeida <andrealmeid@...lia.com>,
        linux-kernel@...r.kernel.org, dri-devel@...ts.freedesktop.org
Subject: Re: [PATCH 2/2] drm/debugfs: add descriptions to struct parameters

On 1/5/23 16:30, Maíra Canal wrote:
> The structs drm_debugfs_info and drm_debugfs_entry don't have
> descriptions for their parameters, which is causing the following warnings:
> 
> include/drm/drm_debugfs.h:93: warning: Function parameter or member
> 'name' not described in 'drm_debugfs_info'
> include/drm/drm_debugfs.h:93: warning: Function parameter or member
> 'show' not described in 'drm_debugfs_info'
> include/drm/drm_debugfs.h:93: warning: Function parameter or member
> 'driver_features' not described in 'drm_debugfs_info'
> include/drm/drm_debugfs.h:93: warning: Function parameter or member
> 'data' not described in 'drm_debugfs_info'
> include/drm/drm_debugfs.h:105: warning: Function parameter or member
> 'dev' not described in 'drm_debugfs_entry'
> include/drm/drm_debugfs.h:105: warning: Function parameter or member
> 'file' not described in 'drm_debugfs_entry'
> include/drm/drm_debugfs.h:105: warning: Function parameter or member
> 'list' not described in 'drm_debugfs_entry'
> 
> Therefore, fix the warnings by adding descriptions to all struct
> parameters.
> 
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Signed-off-by: Maíra Canal <mcanal@...lia.com>

Applied series to drm-misc-next.

Best Regards,
- Maíra Canal

> ---
>   include/drm/drm_debugfs.h | 18 ++++++++++++++++++
>   1 file changed, 18 insertions(+)
> 
> diff --git a/include/drm/drm_debugfs.h b/include/drm/drm_debugfs.h
> index 53b7297260a5..7616f457ce70 100644
> --- a/include/drm/drm_debugfs.h
> +++ b/include/drm/drm_debugfs.h
> @@ -86,9 +86,22 @@ struct drm_info_node {
>    * core.
>    */
>   struct drm_debugfs_info {
> +	/** @name: File name */
>   	const char *name;
> +
> +	/**
> +	 * @show:
> +	 *
> +	 * Show callback. &seq_file->private will be set to the &struct
> +	 * drm_debugfs_entry corresponding to the instance of this info
> +	 * on a given &struct drm_device.
> +	 */
>   	int (*show)(struct seq_file*, void*);
> +
> +	/** @driver_features: Required driver features for this entry. */
>   	u32 driver_features;
> +
> +	/** @data: Driver-private data, should not be device-specific. */
>   	void *data;
>   };
>   
> @@ -99,8 +112,13 @@ struct drm_debugfs_info {
>    * drm_debugfs_info on a &struct drm_device.
>    */
>   struct drm_debugfs_entry {
> +	/** @dev: &struct drm_device for this node. */
>   	struct drm_device *dev;
> +
> +	/** @file: Template for this node. */
>   	struct drm_debugfs_info file;
> +
> +	/** @list: Linked list of all device nodes. */
>   	struct list_head list;
>   };
>