[Intel-gfx] [PATCH] drm/i915: run kernel-doc on headers as part of HDRTEST

[Das, Nirmoy]

On 4/4/2023 11:05 AM, Jani Nikula wrote:
> Enabling kernel-doc warnings in commit aaee4bbe8a1a ("drm/i915: enable
> kernel-doc warnings for CONFIG_DRM_I915_WERROR=y") actually only covers
> the .c files. And it's good for avoiding warnings in W= builds. However,
> we need something more to check for kernel-doc issues in headers. Add it
> as part of the existing HDRTEST.
>
> We have tons of issues, and this unleashes warnings galore on
> CONFIG_DRM_I915_WERROR=y. It doesn't fail the build because (at least
> for now) we don't pass -Werror to kernel-doc.
>
> Cc: Rodrigo Vivi <rodrigo.vivi at intel.com>
> Signed-off-by: Jani Nikula <jani.nikula at intel.com>


This will be really helpful.

Acked-by: Nirmoy Das <nirmoy.das at intel.com>

Thanks,

Nirmoy

> ---
>   drivers/gpu/drm/i915/Makefile | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile
> index 831e42175165..b739300267c2 100644
> --- a/drivers/gpu/drm/i915/Makefile
> +++ b/drivers/gpu/drm/i915/Makefile
> @@ -387,7 +387,8 @@ always-$(CONFIG_DRM_I915_WERROR) += \
>   		$(shell cd $(srctree)/$(src) && find * -name '*.h')))
>   
>   quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)
> -      cmd_hdrtest = $(CC) $(filter-out $(CFLAGS_GCOV), $(c_flags)) -S -o /dev/null -x c /dev/null -include $<; touch $@
> +      cmd_hdrtest = $(CC) $(filter-out $(CFLAGS_GCOV), $(c_flags)) -S -o /dev/null -x c /dev/null -include $<; \
> +		$(srctree)/scripts/kernel-doc -none $<; touch $@
>   
>   $(obj)/%.hdrtest: $(src)/%.h FORCE
>   	$(call if_changed_dep,hdrtest)