2023-12-28 23:49:57

by Randy Dunlap

Subject: [PATCH v2.1 2/4] drm/i915/gt: reconcile Excess struct member kernel-doc warnings

Document nested struct members with full names as described in
Documentation/doc-guide/kernel-doc.rst.

intel_gsc.h:34: warning: Excess struct member 'gem_obj' description in 'intel_gsc'

Also add missing field member descriptions.

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Jani Nikula <[email protected]>
Cc: Joonas Lahtinen <[email protected]>
Cc: Rodrigo Vivi <[email protected]>
Cc: Tvrtko Ursulin <[email protected]>
Cc: [email protected]
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Reviewed-by: Rodrigo Vivi <[email protected]>
Cc: Andi Shyti <[email protected]>
---
v2: add Reviewed-by: Rodrigo
rebase and resend due to (i915) patchwork being down
v2.1: reformat to be consistent with kernel-doc in other files (Andi)

Please let me know if I should resend all 4 patches as v3.

drivers/gpu/drm/i915/gt/intel_gsc.h | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)

diff -- a/drivers/gpu/drm/i915/gt/intel_gsc.h b/drivers/gpu/drm/i915/gt/intel_gsc.h
--- a/drivers/gpu/drm/i915/gt/intel_gsc.h
+++ b/drivers/gpu/drm/i915/gt/intel_gsc.h
@@ -21,8 +21,11 @@ struct mei_aux_device;
/**
* struct intel_gsc - graphics security controller
*
- * @gem_obj: scratch memory GSC operations
- * @intf : gsc interface
+ * @intf: gsc interface
+ * @intf.adev: MEI aux. device for this @intf
+ * @intf.gem_obj: scratch memory GSC operations
+ * @intf.irq: IRQ for this device (%-1 for no IRQ)
+ * @intf.id: this interface's id number/index
*/
struct intel_gsc {
struct intel_gsc_intf {

2023-12-29 11:42:52

by Andi Shyti

Subject: Re: [PATCH v2.1 2/4] drm/i915/gt: reconcile Excess struct member kernel-doc warnings

Hi Randy,

On Thu, Dec 28, 2023 at 03:49:46PM -0800, Randy Dunlap wrote:
> Document nested struct members with full names as described in
> Documentation/doc-guide/kernel-doc.rst.
>
> intel_gsc.h:34: warning: Excess struct member 'gem_obj' description in 'intel_gsc'
>
> Also add missing field member descriptions.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Jani Nikula <[email protected]>
> Cc: Joonas Lahtinen <[email protected]>
> Cc: Rodrigo Vivi <[email protected]>
> Cc: Tvrtko Ursulin <[email protected]>
> Cc: [email protected]
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Reviewed-by: Rodrigo Vivi <[email protected]>
> Cc: Andi Shyti <[email protected]>

Reviewed and applied.

Thanks,
Andi