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

[Jani Nikula]

On Sat, 01 Apr 2023, Masahiro Yamada <masahiroy at kernel.org> wrote:
> On Fri, Mar 31, 2023 at 7:15 PM Jani Nikula <jani.nikula at intel.com> wrote:
>>
>> Increase awareness of kernel-doc issues by enabling doc check locally
>> when W= is *not* specified on the make command-line, but
>> 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.
>>
>> Cc: Masahiro Yamada <masahiroy at kernel.org>
>> Signed-off-by: Jani Nikula <jani.nikula at intel.com>
>>
>> ---
>>
>> Masahiro, is this an awful hack to do in our local Makefile?
>>
>> Note that we do try to avoid anyone outside of i915 developers enabling
>> CONFIG_DRM_I915_WERROR=y.
>>
>> Any other and cleaner ways of achieving this, without using W= on the
>> entire kernel?
>>
>> On that note, it would be nice to be able to enable W= on a subdir
>> alone.
>> ---
>>  drivers/gpu/drm/i915/Makefile | 8 ++++++++
>>  1 file changed, 8 insertions(+)
>>
>> diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile
>> index 057ef22fa9c6..13d7040801bf 100644
>> --- a/drivers/gpu/drm/i915/Makefile
>> +++ b/drivers/gpu/drm/i915/Makefile
>> @@ -369,6 +369,14 @@ 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 if not already enabled.
>> +# See scripts/Makefile.build
>> +ifeq ($(KBUILD_EXTRA_WARN)$(CONFIG_DRM_I915_WERROR),y)
>> +    cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $<
>> +endif
>>
>
>
> I do not mind this, but I do not think you need to
> check $(KBUILD_EXTRA_WARN).

Mmh, what if we later add -Werror here? Is the cmd_checkdoc local or
global? Does that impact other places?

BR,
Jani.


>
>
>
> ifdef CONFIG_DRM_I915_WERROR
>     cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $<
> endif

-- 
Jani Nikula, Intel Open Source Graphics Center