Commit 105401b6 authored Nov 01, 2019 by Rob Herring

drm/shmem: Add docbook comments for drm_gem_shmem_object madvise fields

Add missing docbook comments to madvise fields in struct
drm_gem_shmem_object which fixes these warnings:

include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv' not described in 'drm_gem_shmem_object'
include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv_list' not described in 'drm_gem_shmem_object'

Fixes: 17acb9f3 ("drm/shmem: Add madvise state and purge helpers")
Reported-by: Sean Paul <sean@poorly.run>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Signed-off-by: Rob Herring <robh@kernel.org>
Reviewed-by: Sean Paul <sean@poorly.run>
Link: https://patchwork.freedesktop.org/patch/msgid/20191101153754.22803-1-robh@kernel.org

parent 86de88cf

include/drm/drm_gem_shmem_helper.h

+13 −0

Original line number	Diff line number	Diff line
		@@ -44,7 +44,20 @@ struct drm_gem_shmem_object {
		*/
		unsigned int pages_use_count;

		/**
		* @madv: State for madvise
		*
		* 0 is active/inuse.
		* A negative value is the object is purged.
		* Positive values are driver specific and not used by the helpers.
		*/
		int madv;

		/**
		* @madv_list: List entry for madvise tracking
		*
		* Typically used by drivers to track purgeable objects
		*/
		struct list_head madv_list;

		/**

Admin message