diff mbox

[3/3] drm/i915: add DOC: headline to RC6 kernel-doc

Message ID 1453101588-18008-3-git-send-email-jani.nikula@intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Jani Nikula Jan. 18, 2016, 7:19 a.m. UTC
Without the DOC:, kernel-doc confuses the documentation block for
something else.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 drivers/gpu/drm/i915/intel_pm.c | 2 ++
 1 file changed, 2 insertions(+)

Comments

Daniel Vetter Jan. 19, 2016, 8:09 p.m. UTC | #1
On Mon, Jan 18, 2016 at 09:19:48AM +0200, Jani Nikula wrote:
> Without the DOC:, kernel-doc confuses the documentation block for
> something else.
> 
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>

Hm, we don't pull intel_pm.c into the gpu.tmpl at all, which means
kernel-CI won't test this for us. Care to throw a generic "PM stuff"
section in there for this? Otherwise the DOC: section here is a bit
pointless. Anyway for the series:

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  drivers/gpu/drm/i915/intel_pm.c | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/drivers/gpu/drm/i915/intel_pm.c b/drivers/gpu/drm/i915/intel_pm.c
> index 7e6e70054d6a..180555553fa2 100644
> --- a/drivers/gpu/drm/i915/intel_pm.c
> +++ b/drivers/gpu/drm/i915/intel_pm.c
> @@ -32,6 +32,8 @@
>  #include <linux/module.h>
>  
>  /**
> + * DOC: RC6
> + *
>   * RC6 is a special power stage which allows the GPU to enter an very
>   * low-voltage mode when idle, using down to 0V while at this stage.  This
>   * stage is entered automatically when the GPU is idle when RC6 support is
> -- 
> 2.1.4
> 
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/intel-gfx
Jani Nikula Jan. 20, 2016, 9:38 a.m. UTC | #2
On Tue, 19 Jan 2016, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Mon, Jan 18, 2016 at 09:19:48AM +0200, Jani Nikula wrote:
>> Without the DOC:, kernel-doc confuses the documentation block for
>> something else.
>> 
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>
> Hm, we don't pull intel_pm.c into the gpu.tmpl at all, which means
> kernel-CI won't test this for us. Care to throw a generic "PM stuff"
> section in there for this? Otherwise the DOC: section here is a bit
> pointless.

Will do.

> Anyway for the series:
>
> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

Thanks, pushed the lot.

BR,
Jani.


>
>> ---
>>  drivers/gpu/drm/i915/intel_pm.c | 2 ++
>>  1 file changed, 2 insertions(+)
>> 
>> diff --git a/drivers/gpu/drm/i915/intel_pm.c b/drivers/gpu/drm/i915/intel_pm.c
>> index 7e6e70054d6a..180555553fa2 100644
>> --- a/drivers/gpu/drm/i915/intel_pm.c
>> +++ b/drivers/gpu/drm/i915/intel_pm.c
>> @@ -32,6 +32,8 @@
>>  #include <linux/module.h>
>>  
>>  /**
>> + * DOC: RC6
>> + *
>>   * RC6 is a special power stage which allows the GPU to enter an very
>>   * low-voltage mode when idle, using down to 0V while at this stage.  This
>>   * stage is entered automatically when the GPU is idle when RC6 support is
>> -- 
>> 2.1.4
>> 
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx@lists.freedesktop.org
>> http://lists.freedesktop.org/mailman/listinfo/intel-gfx
diff mbox

Patch

diff --git a/drivers/gpu/drm/i915/intel_pm.c b/drivers/gpu/drm/i915/intel_pm.c
index 7e6e70054d6a..180555553fa2 100644
--- a/drivers/gpu/drm/i915/intel_pm.c
+++ b/drivers/gpu/drm/i915/intel_pm.c
@@ -32,6 +32,8 @@ 
 #include <linux/module.h>
 
 /**
+ * DOC: RC6
+ *
  * RC6 is a special power stage which allows the GPU to enter an very
  * low-voltage mode when idle, using down to 0V while at this stage.  This
  * stage is entered automatically when the GPU is idle when RC6 support is