[Intel-gfx] [PATCH v2] drm/i915: enable kernel-doc warnings for CONFIG_DRM_I915_WERROR=y

[Jani Nikula]

On Mon, 03 Apr 2023, Rodrigo Vivi <rodrigo.vivi at intel.com> wrote:
> On Mon, Apr 03, 2023 at 03:57:10PM +0300, Jani Nikula wrote:
>> Increase awareness of kernel-doc issues by enabling doc check locally
>> when CONFIG_DRM_I915_WERROR=y is enabled.
>> 
>> Once the warnings have been fixed, we can pass -Werror to kernel-doc
>> locally, and fail the build when there are kernel-doc warnings in i915.
>> 
>> v2: Don't check for KBUILD_EXTRA_WARN (Masahiro)
>> 
>> Cc: Masahiro Yamada <masahiroy at kernel.org>
>> Signed-off-by: Jani Nikula <jani.nikula at intel.com>
>
> Acked-by: Rodrigo Vivi <rodrigo.vivi at intel.com>

Thanks, pushed to drm-intel-next. Let's see if this helps us keep our
kernel-doc in order.

BR,
Jani.

>
>> ---
>>  drivers/gpu/drm/i915/Makefile | 7 +++++++
>>  1 file changed, 7 insertions(+)
>> 
>> diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile
>> index 057ef22fa9c6..831e42175165 100644
>> --- a/drivers/gpu/drm/i915/Makefile
>> +++ b/drivers/gpu/drm/i915/Makefile
>> @@ -369,6 +369,13 @@ include $(src)/gvt/Makefile
>>  obj-$(CONFIG_DRM_I915) += i915.o
>>  obj-$(CONFIG_DRM_I915_GVT_KVMGT) += kvmgt.o
>>  
>> +# kernel-doc test
>> +#
>> +# Enable locally for CONFIG_DRM_I915_WERROR=y. See also scripts/Makefile.build
>> +ifdef CONFIG_DRM_I915_WERROR
>> +    cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $<
>> +endif
>> +
>>  # header test
>>  
>>  # exclude some broken headers from the test coverage
>> -- 
>> 2.39.2
>> 

-- 
Jani Nikula, Intel Open Source Graphics Center