Commit 62ae4568 authored by Jani Nikula's avatar Jani Nikula
Browse files

drm: ensure drm headers are self-contained and pass kernel-doc 



Ensure drm headers build, are self-contained, have header guards, and
have no kernel-doc warnings, when CONFIG_DRM_HEADER_TEST=y.

The mechanism follows similar patters used in i915, xe, and usr/include.

To cover include/drm, we need to recurse there using the top level
Kbuild and the new include/Kbuild files.

v4: check for CONFIG_WERROR in addition to CONFIG_DRM_WERROR

v3: adapt to upstream build changes

v2: make DRM_HEADER_TEST depend on DRM

Suggested-by: default avatarDaniel Vetter <daniel@ffwll.ch>
Cc: David Airlie <airlied@gmail.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Masahiro Yamada <masahiroy@kernel.org>
Acked-by: default avatarThomas Zimmermann <tzimmermann@suse.de>
Acked-by: default avatarSimona Vetter <simona.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/d8ad1c6d707f38a55987f616cb9650aef30b84e1.1737556766.git.jani.nikula@intel.com


Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
parent 48ca4a1f

Kbuild

+1 −0
Original line number Diff line number Diff line
@@ -97,3 +97,4 @@ obj-$(CONFIG_SAMPLES) += samples/ 
obj-$(CONFIG_NET)	+= net/

obj-y			+= virt/

obj-y			+= $(ARCH_DRIVERS)

obj-$(CONFIG_DRM_HEADER_TEST)	+= include/

drivers/gpu/drm/Kconfig

+11 −0
Original line number Diff line number Diff line
@@ -494,6 +494,17 @@ config DRM_WERROR 


	  If in doubt, say N.



config DRM_HEADER_TEST

	bool "Ensure DRM headers are self-contained and pass kernel-doc"

	depends on DRM && EXPERT

	default n

	help

	  Ensure the DRM subsystem headers both under drivers/gpu/drm and

	  include/drm compile, are self-contained, have header guards, and have

	  no kernel-doc warnings.



	  If in doubt, say N.



endif



# Separate option because drm_panel_orientation_quirks.c is shared with fbdev

drivers/gpu/drm/Makefile

+18 −0
Original line number Diff line number Diff line
@@ -222,3 +222,21 @@ obj-y += solomon/ 
obj-$(CONFIG_DRM_SPRD) += sprd/

obj-$(CONFIG_DRM_LOONGSON) += loongson/

obj-$(CONFIG_DRM_POWERVR) += imagination/



# Ensure drm headers are self-contained and pass kernel-doc

hdrtest-files := \

	$(shell cd $(src) && find . -maxdepth 1 -name 'drm_*.h') \

	$(shell cd $(src) && find display lib -name '*.h')



always-$(CONFIG_DRM_HEADER_TEST) += \

	$(patsubst %.h,%.hdrtest, $(hdrtest-files))



# Include the header twice to detect missing include guard.

quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)

      cmd_hdrtest = \

		$(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \

		$(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \

		touch $@



$(obj)/%.hdrtest: $(src)/%.h FORCE

	$(call if_changed_dep,hdrtest)

include/Kbuild

0 → 100644
+1 −0
Original line number Diff line number Diff line 
obj-$(CONFIG_DRM_HEADER_TEST)	+= drm/

include/drm/Makefile

0 → 100644
+18 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0



# Ensure drm headers are self-contained and pass kernel-doc

hdrtest-files := \

	$(shell cd $(src) && find * -name '*.h' 2>/dev/null)



always-$(CONFIG_DRM_HEADER_TEST) += \

	$(patsubst %.h,%.hdrtest, $(hdrtest-files))



# Include the header twice to detect missing include guard.

quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)

      cmd_hdrtest = \

		$(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \

		$(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \

		touch $@



$(obj)/%.hdrtest: $(src)/%.h FORCE

	$(call if_changed_dep,hdrtest)