Commit 0af4cbfa authored by Randy Dunlap's avatar Randy Dunlap Committed by Matthew Auld
Browse files

drm/i915/gem: placate scripts/kernel-doc 



Correct kernel-doc warnings in i915_drm_object.c:

i915_gem_object.c:103: warning: expecting prototype for i915_gem_object_fini(). Prototype was for __i915_gem_object_fini() instead
i915_gem_object.c:110: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Mark up the object's coherency levels for a given cache_level
i915_gem_object.c:110: warning: missing initial short description on line:
 * Mark up the object's coherency levels for a given cache_level
i915_gem_object.c:457: warning: No description found for return value of 'i915_gem_object_read_from_page'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Cc: Matthew Auld <matthew.auld@intel.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>
Cc: intel-gfx@lists.freedesktop.org
Reviewed-by: default avatarMatthew Auld <matthew.auld@intel.com>
Signed-off-by: default avatarMatthew Auld <matthew.auld@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20211123050928.20434-1-rdunlap@infradead.org
parent 6164807d

drivers/gpu/drm/i915/gem/i915_gem_object.c

+4 −3
Original line number Diff line number Diff line
@@ -91,7 +91,7 @@ void i915_gem_object_init(struct drm_i915_gem_object *obj, 
}



/**

 * i915_gem_object_fini - Clean up a GEM object initialization

 * __i915_gem_object_fini - Clean up a GEM object initialization

 * @obj: The gem object to cleanup

 *

 * This function cleans up gem object fields that are set up by
@@ -107,7 +107,8 @@ void __i915_gem_object_fini(struct drm_i915_gem_object *obj) 
}



/**

 * Mark up the object's coherency levels for a given cache_level

 * i915_gem_object_set_cache_coherency - Mark up the object's coherency levels

 * for a given cache_level

 * @obj: #drm_i915_gem_object

 * @cache_level: cache level

 */
@@ -450,7 +451,7 @@ i915_gem_object_read_from_page_iomap(struct drm_i915_gem_object *obj, u64 offset 
 * from can't cross a page boundary. The caller must ensure that @obj pages

 * are pinned and that @obj is synced wrt. any related writes.

 *

 * Returns 0 on success or -ENODEV if the type of @obj's backing store is

 * Return: %0 on success or -ENODEV if the type of @obj's backing store is

 * unsupported.

 */

int i915_gem_object_read_from_page(struct drm_i915_gem_object *obj, u64 offset, void *dst, int size)