linux

korg/linux

mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-11 12:28:41 +08:00

Go to file

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
arch	parisc architecture fixes for kernel v6.7-rc3:	2023-11-26 09:59:39 -08:00
block	vfs-6.7-rc3.fixes	2023-11-24 09:45:40 -08:00
certs	This update includes the following changes:	2023-11-02 16:15:30 -10:00
crypto	This push fixes a regression in ahash and hides the Kconfig sub-options for the jitter RNG.	2023-11-09 17:04:58 -08:00
Documentation	dt-bindings: display: Add SSD133x OLED controllers	2024-01-01 13:03:03 +01:00
drivers	drm/nouveau/volt/gk20a: don't misuse kernel-doc comments	2024-01-08 18:37:52 +01:00
fs	eventfs fixes:	2023-11-26 19:48:20 -08:00
include	drm/nouveau: uapi: fix kerneldoc warnings	2024-01-08 18:54:33 +01:00
init	As usual, lots of singleton and doubleton patches all over the tree and	2023-11-02 20:53:31 -10:00
io_uring	io_uring: fix off-by one bvec index	2023-11-20 15:21:38 -07:00
ipc	Many singleton patches against the MM code. The patch series which are	2023-11-02 19:38:47 -10:00
kernel	Fix lockdep block chain corruption resulting in KASAN warnings.	2023-11-26 08:30:11 -08:00
lib	parisc architecture fixes for kernel v6.7-rc3:	2023-11-26 09:59:39 -08:00
LICENSES	LICENSES: Add the copyleft-next-0.3.1 license	2022-11-08 15:44:01 +01:00
mm	vfs-6.7-rc3.fixes	2023-11-24 09:45:40 -08:00
net	tls: fix NULL deref on tls_sw_splice_eof() with empty record	2023-11-23 08:51:45 -08:00
rust	Kbuild updates for v6.7	2023-11-04 08:07:19 -10:00
samples	Landlock updates for v6.7-rc1	2023-11-03 09:28:53 -10:00
scripts	scripts/checkstack.pl: match all stack sizes for s390	2023-11-22 15:06:23 +01:00
security	+ Features	2023-11-03 09:48:17 -10:00
sound	drm-misc-next for 6.8:	2023-11-20 09:50:09 +01:00
tools	parisc architecture fixes for kernel v6.7-rc3:	2023-11-26 09:59:39 -08:00
usr	arch: Remove Itanium (IA-64) architecture	2023-09-11 08:13:17 +00:00
virt	ARM:	2023-09-07 13:52:20 -07:00
.clang-format	iommu: Add for_each_group_device()	2023-05-23 08:15:51 +02:00
.cocciconfig
.get_maintainer.ignore	get_maintainer: add Alan to .get_maintainer.ignore	2022-08-20 15:17:44 -07:00
.gitattributes	.gitattributes: set diff driver for Rust source code files	2023-05-31 17:48:25 +02:00
.gitignore	kbuild: rpm-pkg: generate kernel.spec in rpmbuild/SPECS/	2023-10-03 20:49:09 +09:00
.mailmap	As usual, lots of singleton and doubleton patches all over the tree and	2023-11-02 20:53:31 -10:00
.rustfmt.toml	rust: add `.rustfmt.toml`	2022-09-28 09:02:20 +02:00
COPYING	COPYING: state that all contributions really are covered by this file	2020-02-10 13:32:20 -08:00
CREDITS	USB: Remove Wireless USB and UWB documentation	2023-08-09 14:17:32 +02:00
Kbuild	Kbuild updates for v6.1	2022-10-10 12:00:45 -07:00
Kconfig	kbuild: ensure full rebuild when the compiler is updated	2020-05-12 13:28:33 +09:00
MAINTAINERS	MAINTAINERS: Remove Donald Robson from powervr driver maintainers	2023-12-14 13:28:17 +01:00
Makefile	Linux 6.7-rc3	2023-11-26 19:59:33 -08:00
README	Drop all 00-INDEX files from Documentation/	2018-09-09 15:08:58 -06:00

README

Linux kernel
============

There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.  The formatted documentation can also be read online at:

    https://www.kernel.org/doc/html/latest/

There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.