diff mbox series

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

Message ID 20211123050928.20434-1-rdunlap@infradead.org (mailing list archive)
State New, archived
Headers show
Series drm/i915/gem: placate scripts/kernel-doc | expand

Commit Message

Randy Dunlap Nov. 23, 2021, 5:09 a.m. UTC 
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: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel 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
---
 drivers/gpu/drm/i915/gem/i915_gem_object.c |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Matthew Auld Nov. 23, 2021, 9:29 a.m. UTC | #1 
On 23/11/2021 05:09, Randy Dunlap wrote:
> 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: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel 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: Matthew Auld <matthew.auld@intel.com>
Matthew Auld Nov. 23, 2021, 9:44 a.m. UTC | #2 
On Tue, 23 Nov 2021 at 05:56, Patchwork <patchwork@emeril.freedesktop.org>
wrote:

> *Patch Details*
> *Series:* drm/i915/gem: placate scripts/kernel-doc
> *URL:* https://patchwork.freedesktop.org/series/97190/
> *State:* failure
> *Details:*
> https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/index.html CI
> Bug Log - changes from CI_DRM_10917 -> Patchwork_21664 Summary
>
> *FAILURE*
>
> Serious unknown changes coming with Patchwork_21664 absolutely need to be
> verified manually.
>
> If you think the reported changes have nothing to do with the changes
> introduced in Patchwork_21664, please notify your bug team to allow them
> to document this new failure mode, which will reduce false positives in CI.
>
> External URL:
> https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/index.html
> Participating hosts (40 -> 34)
>
> Additional (1): fi-kbl-soraka
> Missing (7): bat-dg1-6 fi-tgl-u2 fi-bsw-cyan bat-adlp-6 bat-adlp-4
> bat-jsl-2 bat-jsl-1
> Possible new issues
>
> Here are the unknown changes that may have been introduced in
> Patchwork_21664:
> IGT changes Possible regressions
>
>    - igt@gem_exec_suspend@basic-s3:
>       - fi-skl-6600u: PASS
>       <https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-skl-6600u/igt@gem_exec_suspend@basic-s3.html>
>       -> FAIL
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-skl-6600u/igt@gem_exec_suspend@basic-s3.html>
>
>
Lakshmi, another false positive it seems. The patch in question is only
fixing kernel-doc. Pushed to drm-intel-gt-next. Thanks.


>    -
>
> Known issues
>
> Here are the changes found in Patchwork_21664 that come from known issues:
> IGT changes Issues hit
>
>    -
>
>    igt@amdgpu/amd_basic@semaphore:
>    - fi-bdw-5557u: NOTRUN -> SKIP
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-bdw-5557u/igt@amdgpu/amd_basic@semaphore.html>
>       (fdo#109271 <https://bugs.freedesktop.org/show_bug.cgi?id=109271>)
>       +31 similar issues
>    -
>
>    igt@gem_exec_fence@basic-busy@bcs0:
>    - fi-kbl-soraka: NOTRUN -> SKIP
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-soraka/igt@gem_exec_fence@basic-busy@bcs0.html>
>       (fdo#109271 <https://bugs.freedesktop.org/show_bug.cgi?id=109271>)
>       +2 similar issues
>    -
>
>    igt@gem_exec_suspend@basic-s0:
>    - fi-kbl-soraka: NOTRUN -> INCOMPLETE
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-soraka/igt@gem_exec_suspend@basic-s0.html>
>       (i915#4221 <https://gitlab.freedesktop.org/drm/intel/issues/4221>)
>    -
>
>    igt@gem_huc_copy@huc-copy:
>    - fi-kbl-8809g: NOTRUN -> SKIP
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@gem_huc_copy@huc-copy.html>
>       (fdo#109271 <https://bugs.freedesktop.org/show_bug.cgi?id=109271> /
>       i915#2190 <https://gitlab.freedesktop.org/drm/intel/issues/2190>)
>    -
>
>    igt@i915_selftest@live@hangcheck:
>    - fi-snb-2600: PASS
>       <https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-snb-2600/igt@i915_selftest@live@hangcheck.html>
>       -> INCOMPLETE
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-snb-2600/igt@i915_selftest@live@hangcheck.html>
>       (i915#3921 <https://gitlab.freedesktop.org/drm/intel/issues/3921>)
>    -
>
>    igt@kms_chamelium@dp-crc-fast:
>    - fi-bdw-5557u: NOTRUN -> SKIP
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-bdw-5557u/igt@kms_chamelium@dp-crc-fast.html>
>       (fdo#109271 <https://bugs.freedesktop.org/show_bug.cgi?id=109271> /
>       fdo#111827 <https://bugs.freedesktop.org/show_bug.cgi?id=111827>)
>       +8 similar issues
>    -
>
>    igt@kms_chamelium@hdmi-edid-read:
>    - fi-kbl-8809g: NOTRUN -> SKIP
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@kms_chamelium@hdmi-edid-read.html>
>       (fdo#109271 <https://bugs.freedesktop.org/show_bug.cgi?id=109271> /
>       fdo#111827 <https://bugs.freedesktop.org/show_bug.cgi?id=111827>)
>       +8 similar issues
>    -
>
>    igt@kms_pipe_crc_basic@compare-crc-sanitycheck-pipe-d:
>    - fi-kbl-8809g: NOTRUN -> SKIP
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@kms_pipe_crc_basic@compare-crc-sanitycheck-pipe-d.html>
>       (fdo#109271 <https://bugs.freedesktop.org/show_bug.cgi?id=109271> /
>       i915#533 <https://gitlab.freedesktop.org/drm/intel/issues/533>)
>    -
>
>    igt@kms_psr@cursor_plane_move:
>    - fi-kbl-8809g: NOTRUN -> SKIP
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@kms_psr@cursor_plane_move.html>
>       (fdo#109271 <https://bugs.freedesktop.org/show_bug.cgi?id=109271>)
>       +41 similar issues
>
> Possible fixes
>
>    - igt@core_auth@basic-auth:
>       - fi-kbl-8809g: FAIL
>       <https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-kbl-8809g/igt@core_auth@basic-auth.html>
>       -> PASS
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@core_auth@basic-auth.html>
>
> Warnings
>
>    - igt@runner@aborted:
>       - fi-skl-6600u: FAIL
>       <https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-skl-6600u/igt@runner@aborted.html>
>       (i915#2722 <https://gitlab.freedesktop.org/drm/intel/issues/2722> /
>       i915#3363 <https://gitlab.freedesktop.org/drm/intel/issues/3363> /
>       i915#4312 <https://gitlab.freedesktop.org/drm/intel/issues/4312>)
>       -> FAIL
>       <https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-skl-6600u/igt@runner@aborted.html>
>       (i915#3363 <https://gitlab.freedesktop.org/drm/intel/issues/3363> /
>       i915#4312 <https://gitlab.freedesktop.org/drm/intel/issues/4312>)
>
> Build changes
>
>    - Linux: CI_DRM_10917 -> Patchwork_21664
>
> CI-20190529: 20190529
> CI_DRM_10917: de9a03c2007f3c69c5fa86ef007841a4a9194aac @ git://
> anongit.freedesktop.org/gfx-ci/linux
> IGT_6286: cdcbf81f734fdb1d102e84490e49e9fec23760cd @
> https://gitlab.freedesktop.org/drm/igt-gpu-tools.git
> Patchwork_21664: 960cb066fb2369728d369f58fd4601e250486664 @ git://
> anongit.freedesktop.org/gfx-ci/linux
>
> == Linux commits ==
>
> 960cb066fb23 drm/i915/gem: placate scripts/kernel-doc
>
Vudum, Lakshminarayana Nov. 23, 2021, 5:26 p.m. UTC | #3 
This failure is related to https://gitlab.freedesktop.org/drm/intel/-/issues/4547
Few tests - fail - This test was killed due to a kernel taint, INFO: task kworker/.* blocked for more than 30 seconds.

Re-reproted.

Thanks,
Lakshmi.
From: Matthew Auld <matthew.william.auld@gmail.com>
Sent: Tuesday, November 23, 2021 1:45 AM
To: Intel Graphics Development <intel-gfx@lists.freedesktop.org>; Vudum, Lakshminarayana <lakshminarayana.vudum@intel.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Subject: Re: [Intel-gfx] ✗ Fi.CI.BAT: failure for drm/i915/gem: placate scripts/kernel-doc

On Tue, 23 Nov 2021 at 05:56, Patchwork <patchwork@emeril.freedesktop.org<mailto:patchwork@emeril.freedesktop.org>> wrote:
Patch Details
Series:

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

URL:

https://patchwork.freedesktop.org/series/97190/

State:

failure

Details:

https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/index.html

CI Bug Log - changes from CI_DRM_10917 -> Patchwork_21664
Summary

FAILURE

Serious unknown changes coming with Patchwork_21664 absolutely need to be
verified manually.

If you think the reported changes have nothing to do with the changes
introduced in Patchwork_21664, please notify your bug team to allow them
to document this new failure mode, which will reduce false positives in CI.

External URL: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/index.html

Participating hosts (40 -> 34)

Additional (1): fi-kbl-soraka
Missing (7): bat-dg1-6 fi-tgl-u2 fi-bsw-cyan bat-adlp-6 bat-adlp-4 bat-jsl-2 bat-jsl-1

Possible new issues

Here are the unknown changes that may have been introduced in Patchwork_21664:

IGT changes
Possible regressions

  *   igt@gem_exec_suspend@basic-s3:

     *   fi-skl-6600u: PASS<https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-skl-6600u/igt@gem_exec_suspend@basic-s3.html> -> FAIL<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-skl-6600u/igt@gem_exec_suspend@basic-s3.html>

Lakshmi, another false positive it seems. The patch in question is only fixing kernel-doc. Pushed to drm-intel-gt-next. Thanks.


  *

Known issues

Here are the changes found in Patchwork_21664 that come from known issues:

IGT changes
Issues hit

  *   igt@amdgpu/amd_basic@semaphore:

     *   fi-bdw-5557u: NOTRUN -> SKIP<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-bdw-5557u/igt@amdgpu/amd_basic@semaphore.html> (fdo#109271<https://bugs.freedesktop.org/show_bug.cgi?id=109271>) +31 similar issues

  *   igt@gem_exec_fence@basic-busy@bcs0:

     *   fi-kbl-soraka: NOTRUN -> SKIP<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-soraka/igt@gem_exec_fence@basic-busy@bcs0.html> (fdo#109271<https://bugs.freedesktop.org/show_bug.cgi?id=109271>) +2 similar issues

  *   igt@gem_exec_suspend@basic-s0:

     *   fi-kbl-soraka: NOTRUN -> INCOMPLETE<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-soraka/igt@gem_exec_suspend@basic-s0.html> (i915#4221<https://gitlab.freedesktop.org/drm/intel/issues/4221>)

  *   igt@gem_huc_copy@huc-copy:

     *   fi-kbl-8809g: NOTRUN -> SKIP<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@gem_huc_copy@huc-copy.html> (fdo#109271<https://bugs.freedesktop.org/show_bug.cgi?id=109271> / i915#2190<https://gitlab.freedesktop.org/drm/intel/issues/2190>)

  *   igt@i915_selftest@live@hangcheck:

     *   fi-snb-2600: PASS<https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-snb-2600/igt@i915_selftest@live@hangcheck.html> -> INCOMPLETE<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-snb-2600/igt@i915_selftest@live@hangcheck.html> (i915#3921<https://gitlab.freedesktop.org/drm/intel/issues/3921>)

  *   igt@kms_chamelium@dp-crc-fast:

     *   fi-bdw-5557u: NOTRUN -> SKIP<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-bdw-5557u/igt@kms_chamelium@dp-crc-fast.html> (fdo#109271<https://bugs.freedesktop.org/show_bug.cgi?id=109271> / fdo#111827<https://bugs.freedesktop.org/show_bug.cgi?id=111827>) +8 similar issues

  *   igt@kms_chamelium@hdmi-edid-read:

     *   fi-kbl-8809g: NOTRUN -> SKIP<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@kms_chamelium@hdmi-edid-read.html> (fdo#109271<https://bugs.freedesktop.org/show_bug.cgi?id=109271> / fdo#111827<https://bugs.freedesktop.org/show_bug.cgi?id=111827>) +8 similar issues

  *   igt@kms_pipe_crc_basic@compare-crc-sanitycheck-pipe-d:

     *   fi-kbl-8809g: NOTRUN -> SKIP<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@kms_pipe_crc_basic@compare-crc-sanitycheck-pipe-d.html> (fdo#109271<https://bugs.freedesktop.org/show_bug.cgi?id=109271> / i915#533<https://gitlab.freedesktop.org/drm/intel/issues/533>)

  *   igt@kms_psr@cursor_plane_move:

     *   fi-kbl-8809g: NOTRUN -> SKIP<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@kms_psr@cursor_plane_move.html> (fdo#109271<https://bugs.freedesktop.org/show_bug.cgi?id=109271>) +41 similar issues

Possible fixes

  *   igt@core_auth@basic-auth:

     *   fi-kbl-8809g: FAIL<https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-kbl-8809g/igt@core_auth@basic-auth.html> -> PASS<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-kbl-8809g/igt@core_auth@basic-auth.html>

Warnings

  *   igt@runner@aborted:

     *   fi-skl-6600u: FAIL<https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10917/fi-skl-6600u/igt@runner@aborted.html> (i915#2722<https://gitlab.freedesktop.org/drm/intel/issues/2722> / i915#3363<https://gitlab.freedesktop.org/drm/intel/issues/3363> / i915#4312<https://gitlab.freedesktop.org/drm/intel/issues/4312>) -> FAIL<https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21664/fi-skl-6600u/igt@runner@aborted.html> (i915#3363<https://gitlab.freedesktop.org/drm/intel/issues/3363> / i915#4312<https://gitlab.freedesktop.org/drm/intel/issues/4312>)

Build changes

  *   Linux: CI_DRM_10917 -> Patchwork_21664

CI-20190529: 20190529
CI_DRM_10917: de9a03c2007f3c69c5fa86ef007841a4a9194aac @ git://anongit.freedesktop.org/gfx-ci/linux<http://anongit.freedesktop.org/gfx-ci/linux>
IGT_6286: cdcbf81f734fdb1d102e84490e49e9fec23760cd @ https://gitlab.freedesktop.org/drm/igt-gpu-tools.git
Patchwork_21664: 960cb066fb2369728d369f58fd4601e250486664 @ git://anongit.freedesktop.org/gfx-ci/linux<http://anongit.freedesktop.org/gfx-ci/linux>

== Linux commits ==

960cb066fb23 drm/i915/gem: placate scripts/kernel-doc
diff mbox series

Patch

--- linux-next-20211118.orig/drivers/gpu/drm/i915/gem/i915_gem_object.c
+++ linux-next-20211118/drivers/gpu/drm/i915/gem/i915_gem_object.c
@@ -91,7 +91,7 @@  void i915_gem_object_init(struct drm_i91
 }
 
 /**
- * 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_i
 }
 
 /**
- * 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(str
  * 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)