Re: [PATCH 6/6] drm/i915/params: document I915_PARAMS_FOR_EACH()

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




On 31/12/2018 13:24, Jani Nikula wrote:
On Mon, 31 Dec 2018, Tvrtko Ursulin <tvrtko.ursulin@xxxxxxxxxxxxxxx> wrote:
On 27/12/2018 14:33, Jani Nikula wrote:
Macros with this much magic in them deserve some explanatory text.

Signed-off-by: Jani Nikula <jani.nikula@xxxxxxxxx>
---
   drivers/gpu/drm/i915/i915_params.h | 9 +++++++++
   1 file changed, 9 insertions(+)

diff --git a/drivers/gpu/drm/i915/i915_params.h b/drivers/gpu/drm/i915/i915_params.h
index 85a9007c0ed6..98eba6728095 100644
--- a/drivers/gpu/drm/i915/i915_params.h
+++ b/drivers/gpu/drm/i915/i915_params.h
@@ -33,6 +33,15 @@ struct drm_printer;
   #define ENABLE_GUC_SUBMISSION		BIT(0)
   #define ENABLE_GUC_LOAD_HUC		BIT(1)
+/*
+ * Invoke param, a function-like macro, for each i915 param, with arguments:
+ *
+ * param(type, name, value)
+ *
+ * type: parameter type, one of {bool, int, unsigned int, char *}
+ * name: name of the parameter
+ * value: initial/default value of the parameter

Deliberately not in kerneldoc format, or kerneldoc doesn't work for
macros, or I am missing something else?

The comment describes the parameters passed to the macro passed in as
param, so it's too many levels of abstraction for poor kernel-doc. ;)

Ha! :)

Reviewed-by: Tvrtko Ursulin <tvrtko.ursulin@xxxxxxxxx>

Regards,

Tvrtko

_______________________________________________
Intel-gfx mailing list
Intel-gfx@xxxxxxxxxxxxxxxxxxxxx
https://lists.freedesktop.org/mailman/listinfo/intel-gfx




[Index of Archives]     [AMD Graphics]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux