Unverified Commit 5855366f authored by Maíra Canal's avatar Maíra Canal Committed by Maíra Canal
Browse files

drm/debugfs: add descriptions to struct parameters 



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: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarMaíra Canal <mcanal@igalia.com>
Reviewed-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: default avatarMaíra Canal <mairacanal@riseup.net>
Link: https://patchwork.freedesktop.org/patch/msgid/20230105193039.287677-2-mcanal@igalia.com
parent c9ba134e

include/drm/drm_debugfs.h

+18 −0
Original line number Diff line number Diff line
@@ -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;

};