diff mbox series

drm/i915/perf: Fix warning in documentation

Message ID 20181024105158.4732-1-lionel.g.landwerlin@intel.com (mailing list archive)
State New, archived
Headers show
Series drm/i915/perf: Fix warning in documentation | expand

Commit Message

Lionel Landwerlin Oct. 24, 2018, 10:51 a.m. UTC
Forgot to add the description of this option in a previous commit.

Signed-off-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Fixes: cd956bfcd0f58d ("drm/i915/perf: add a parameter to control the size of OA buffer")
---
 drivers/gpu/drm/i915/i915_perf.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Chris Wilson Oct. 24, 2018, 12:49 p.m. UTC | #1
Quoting Lionel Landwerlin (2018-10-24 11:51:58)
> Forgot to add the description of this option in a previous commit.
> 
> Signed-off-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
> Fixes: cd956bfcd0f58d ("drm/i915/perf: add a parameter to control the size of OA buffer")

Reviewed-by: Chris Wilson <chris@chris-wilson.co.uk>

> ---
>  drivers/gpu/drm/i915/i915_perf.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/gpu/drm/i915/i915_perf.c b/drivers/gpu/drm/i915/i915_perf.c
> index 279432b1f0b6..fa295f05099c 100644
> --- a/drivers/gpu/drm/i915/i915_perf.c
> +++ b/drivers/gpu/drm/i915/i915_perf.c
> @@ -343,6 +343,7 @@ static const struct i915_oa_format gen8_plus_oa_formats[I915_OA_FORMAT_MAX] = {
>   * @oa_format: An OA unit HW report format
>   * @oa_periodic: Whether to enable periodic OA unit sampling
>   * @oa_period_exponent: The OA unit sampling period is derived from this
> + * @oa_buffer_size_exponent: The OA buffer size is derived from this

For future, the preference is for inline kerneldoc for the members.
Tighter coupling of doc to code/struct, and a bit more obvious when
adding.
-Chris
Chris Wilson Oct. 24, 2018, 1:34 p.m. UTC | #2
Quoting Chris Wilson (2018-10-24 13:49:32)
> Quoting Lionel Landwerlin (2018-10-24 11:51:58)
> > Forgot to add the description of this option in a previous commit.
> > 
> > Signed-off-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
> > Fixes: cd956bfcd0f58d ("drm/i915/perf: add a parameter to control the size of OA buffer")
> 
> Reviewed-by: Chris Wilson <chris@chris-wilson.co.uk>

And pushed, ta.
-Chris
diff mbox series

Patch

diff --git a/drivers/gpu/drm/i915/i915_perf.c b/drivers/gpu/drm/i915/i915_perf.c
index 279432b1f0b6..fa295f05099c 100644
--- a/drivers/gpu/drm/i915/i915_perf.c
+++ b/drivers/gpu/drm/i915/i915_perf.c
@@ -343,6 +343,7 @@  static const struct i915_oa_format gen8_plus_oa_formats[I915_OA_FORMAT_MAX] = {
  * @oa_format: An OA unit HW report format
  * @oa_periodic: Whether to enable periodic OA unit sampling
  * @oa_period_exponent: The OA unit sampling period is derived from this
+ * @oa_buffer_size_exponent: The OA buffer size is derived from this
  *
  * As read_properties_unlocked() enumerates and validates the properties given
  * to open a stream of metrics the configuration is built up in the structure