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]>
---
v2: add Reviewed-by: Rodrigo
rebase and resend due to (i915) patchwork being down
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 {
Hi Randy,
...
> /**
> * 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
> */
I don't really like the tabs here and the space before the ':',
which makes it a bit harder to read. Besides it doesn't look
consistent with the rest of the documentation.
Otherwise, looks good.
Andi
Hi Andi,
On 12/28/23 08:25, Andi Shyti wrote:
> Hi Randy,
>
> ...
>
>> /**
>> * 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
>> */
>
> I don't really like the tabs here and the space before the ':',
> which makes it a bit harder to read. Besides it doesn't look
> consistent with the rest of the documentation.
>
> Otherwise, looks good.
Yes, one existing line had " : " and somehow I managed to use that on
all of the new lines. Not good. I'll redo patch 2/4.
Thanks.
--
#Randy