Vegard Nossum 251ba4583f drm/nouveau: uapi: fix kerneldoc warnings ... As of commit b77fdd6a48 ("scripts/kernel-doc: restore warning for Excess struct/union"), we see the following warnings when running 'make htmldocs': ./include/uapi/drm/nouveau_drm.h:292: warning: Excess struct member 'DRM_NOUVEAU_VM_BIND_OP_MAP' description in 'drm_nouveau_vm_bind_op' ./include/uapi/drm/nouveau_drm.h:292: warning: Excess struct member 'DRM_NOUVEAU_VM_BIND_OP_UNMAP' description in 'drm_nouveau_vm_bind_op' ./include/uapi/drm/nouveau_drm.h:292: warning: Excess struct member 'DRM_NOUVEAU_VM_BIND_SPARSE' description in 'drm_nouveau_vm_bind_op' ./include/uapi/drm/nouveau_drm.h:336: warning: Excess struct member 'DRM_NOUVEAU_VM_BIND_RUN_ASYNC' description in 'drm_nouveau_vm_bind' The problem is that these values are #define constants, but had kerneldoc comments attached to them as if they were actual struct members. There are a number of ways we could fix this, but I chose to draw inspiration from include/uapi/drm/i915_drm.h, which pulls them into the corresponding kerneldoc comment for the struct member that they are intended to be used with. To keep the diff readable, there are a number of things I _didn't_ do in this patch, but which we should also consider: - This is pretty good documentation, but it ends up in gpu/driver-uapi, which is part of subsystem-apis/ when it really ought to display under userspace-api/ (the "Linux kernel user-space API guide" book of the documentation). - More generally, we might want a warning if include/uapi/ files are kerneldoc'd outside userspace-api/. - I'd consider it cleaner if the #defines appeared between the kerneldoc for the member and the member itself (which is something other DRM- related UAPI docs do). - The %IDENTIFIER kerneldoc syntax is intended for "constants", and is more appropriate in this context than ``IDENTIFIER`` or &IDENTIFIER. The DRM docs aren't very consistent on this. Cc: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Danilo Krummrich <dakr@redhat.com> Link: https://patchwork.freedesktop.org/patch/msgid/20231225065145.3060754-1-vegard.nossum@oracle.com		2024-01-08 18:54:33 +01:00
..
acpi	ACPI: PM: Add acpi_device_fix_up_power_children() function	2023-11-20 17:31:49 +01:00
asm-generic	asm-generic: qspinlock: fix queued_spin_value_unlocked() implementation	2023-11-22 09:32:49 -08:00
clocksource
crypto	crypto: FIPS 202 SHA-3 register in hash info for IMA	2023-10-27 18:04:30 +08:00
drm	drm/probe-helper: remove unused drm_connector_helper_get_modes_from_ddc()	2024-01-08 12:37:52 +02:00
dt-bindings	dt-bindings: rockchip,vop2: Add more endpoint definition	2023-12-13 15:37:27 +01:00
keys
kunit
kvm	KVM/arm64 updates for 6.7	2023-10-31 16:37:07 -04:00
linux	dma-buf: Correct the documentation of name and exp_name symbols	2023-11-30 14:24:54 +01:00
math-emu
media
memory
misc
net	bpf, netkit: Add indirect call wrapper for fetching peer dev	2023-11-20 10:15:16 -08:00
pcmcia
ras
rdma
rv
scsi	SCSI misc on 20231102	2023-11-02 15:13:50 -10:00
soc	IOMMU Updates for Linux v6.7	2023-11-09 13:37:28 -08:00
sound	ASoC: Updates for v6.7	2023-10-31 09:01:25 +01:00
target
trace	rxrpc: Fix RTT determination to use any ACK as a source	2023-11-17 02:50:33 +00:00
uapi	drm/nouveau: uapi: fix kerneldoc warnings	2024-01-08 18:54:33 +01:00
ufs
vdso
video	fbdev: stifb: Make the STI next font pointer a 32-bit signed offset	2023-10-30 14:54:41 +01:00
xen	xen/events: reduce externally visible helper functions	2023-11-14 09:29:28 +01:00