diff mbox series

[14/19] drm/i915/i915_gem: Provide function names to complete the expected kerneldoc format

Message ID 20230331092607.700644-15-lee@kernel.org (mailing list archive)
State New, archived
Headers show
Series [01/19] drm/i915/i915_scatterlist: Fix kerneldoc formatting issue - missing '@' | expand

Commit Message

Lee Jones March 31, 2023, 9:26 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/gpu/drm/i915/i915_gem.c:447: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/gpu/drm/i915/i915_gem.c:536: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/gpu/drm/i915/i915_gem.c:726: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/gpu/drm/i915/i915_gem.c:811: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

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: David Airlie <airlied@gmail.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Eric Anholt <eric@anholt.net>
Cc: intel-gfx@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee@kernel.org>
---
 drivers/gpu/drm/i915/i915_gem.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

kernel test robot March 31, 2023, 5:52 p.m. UTC | #1
Hi Lee,

I love your patch! Perhaps something to improve:

[auto build test WARNING on drm-intel/for-linux-next]
[also build test WARNING on drm-misc/drm-misc-next next-20230331]
[cannot apply to drm-intel/for-linux-next-fixes lee-leds/for-leds-next linus/master v6.3-rc4]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Lee-Jones/drm-i915-i915_scatterlist-Fix-kerneldoc-formatting-issue-missing/20230331-173046
base:   git://anongit.freedesktop.org/drm-intel for-linux-next
patch link:    https://lore.kernel.org/r/20230331092607.700644-15-lee%40kernel.org
patch subject: [PATCH 14/19] drm/i915/i915_gem: Provide function names to complete the expected kerneldoc format
config: i386-defconfig (https://download.01.org/0day-ci/archive/20230401/202304010108.zHCEYcJV-lkp@intel.com/config)
compiler: gcc-11 (Debian 11.3.0-8) 11.3.0
reproduce (this is a W=1 build):
        # https://github.com/intel-lab-lkp/linux/commit/6fa884d5ec2846c7d9b54c4895c7114b363c4389
        git remote add linux-review https://github.com/intel-lab-lkp/linux
        git fetch --no-tags linux-review Lee-Jones/drm-i915-i915_scatterlist-Fix-kerneldoc-formatting-issue-missing/20230331-173046
        git checkout 6fa884d5ec2846c7d9b54c4895c7114b363c4389
        # save the config file
        mkdir build_dir && cp config build_dir/.config
        make W=1 O=build_dir ARCH=i386 olddefconfig
        make W=1 O=build_dir ARCH=i386 SHELL=/bin/bash

If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@intel.com>
| Link: https://lore.kernel.org/oe-kbuild-all/202304010108.zHCEYcJV-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/gpu/drm/i915/i915_gem.c:819: warning: expecting prototype for i915_gem_sw_finish_ioct(). Prototype was for i915_gem_sw_finish_ioctl() instead


vim +819 drivers/gpu/drm/i915/i915_gem.c

673a394b1e3b69 Eric Anholt    2008-07-30  809  
673a394b1e3b69 Eric Anholt    2008-07-30  810  /**
6fa884d5ec2846 Lee Jones      2023-03-31  811   * i915_gem_sw_finish_ioct - Called when user space has done writes to this buffer
14bb2c11796d70 Tvrtko Ursulin 2016-06-03  812   * @dev: drm device
14bb2c11796d70 Tvrtko Ursulin 2016-06-03  813   * @data: ioctl data blob
14bb2c11796d70 Tvrtko Ursulin 2016-06-03  814   * @file: drm file
673a394b1e3b69 Eric Anholt    2008-07-30  815   */
673a394b1e3b69 Eric Anholt    2008-07-30  816  int
673a394b1e3b69 Eric Anholt    2008-07-30  817  i915_gem_sw_finish_ioctl(struct drm_device *dev, void *data,
05394f3975dceb Chris Wilson   2010-11-08  818  			 struct drm_file *file)
673a394b1e3b69 Eric Anholt    2008-07-30 @819  {
673a394b1e3b69 Eric Anholt    2008-07-30  820  	struct drm_i915_gem_sw_finish *args = data;
05394f3975dceb Chris Wilson   2010-11-08  821  	struct drm_i915_gem_object *obj;
1d7cfea152cae6 Chris Wilson   2010-10-17  822  
03ac0642f67a3a Chris Wilson   2016-07-20  823  	obj = i915_gem_object_lookup(file, args->handle);
c21724cc4d3d5c Chris Wilson   2016-08-05  824  	if (!obj)
c21724cc4d3d5c Chris Wilson   2016-08-05  825  		return -ENOENT;
673a394b1e3b69 Eric Anholt    2008-07-30  826  
a03f395ad78f88 Tina Zhang     2017-11-14  827  	/*
a03f395ad78f88 Tina Zhang     2017-11-14  828  	 * Proxy objects are barred from CPU access, so there is no
a03f395ad78f88 Tina Zhang     2017-11-14  829  	 * need to ban sw_finish as it is a nop.
a03f395ad78f88 Tina Zhang     2017-11-14  830  	 */
a03f395ad78f88 Tina Zhang     2017-11-14  831  
673a394b1e3b69 Eric Anholt    2008-07-30  832  	/* Pinned buffers may be scanout, so flush the cache */
5a97bcc69cc02d Chris Wilson   2017-02-22  833  	i915_gem_object_flush_if_display(obj);
f0cd518206e1a4 Chris Wilson   2016-10-28  834  	i915_gem_object_put(obj);
5a97bcc69cc02d Chris Wilson   2017-02-22  835  
5a97bcc69cc02d Chris Wilson   2017-02-22  836  	return 0;
673a394b1e3b69 Eric Anholt    2008-07-30  837  }
673a394b1e3b69 Eric Anholt    2008-07-30  838
diff mbox series

Patch

diff --git a/drivers/gpu/drm/i915/i915_gem.c b/drivers/gpu/drm/i915/i915_gem.c
index 35950fa914068..6a00d13db2893 100644
--- a/drivers/gpu/drm/i915/i915_gem.c
+++ b/drivers/gpu/drm/i915/i915_gem.c
@@ -444,7 +444,7 @@  i915_gem_gtt_pread(struct drm_i915_gem_object *obj,
 }
 
 /**
- * Reads data from the object referenced by handle.
+ * i915_gem_pread_ioctl - Reads data from the object referenced by handle.
  * @dev: drm device pointer
  * @data: ioctl data blob
  * @file: drm file pointer
@@ -533,7 +533,7 @@  ggtt_write(struct io_mapping *mapping,
 }
 
 /**
- * This is the fast pwrite path, where we copy the data directly from the
+ * i915_gem_gtt_pwrite_fast - This is the fast pwrite path, where we copy the data directly from the
  * user into the GTT, uncached.
  * @obj: i915 GEM object
  * @args: pwrite arguments structure
@@ -723,7 +723,7 @@  i915_gem_shmem_pwrite(struct drm_i915_gem_object *obj,
 }
 
 /**
- * Writes data to the object referenced by handle.
+ * i915_gem_pwrite_ioctl - Writes data to the object referenced by handle.
  * @dev: drm device
  * @data: ioctl data blob
  * @file: drm file
@@ -808,7 +808,7 @@  i915_gem_pwrite_ioctl(struct drm_device *dev, void *data,
 }
 
 /**
- * Called when user space has done writes to this buffer
+ * i915_gem_sw_finish_ioct - Called when user space has done writes to this buffer
  * @dev: drm device
  * @data: ioctl data blob
  * @file: drm file