No description
Find a file
Randy Dunlap a6c67fee9c fs: eventpoll: fix comments & kernel-doc notation
Use the documented kernel-doc format for function Return: descriptions.
Begin constant values in kernel-doc comments with '%'.

Remove kernel-doc "/**" from 2 functions that are not documented with
kernel-doc notation.

Fix typos, punctuation, & grammar.

Also fix a few kernel-doc warnings:

../fs/eventpoll.c:1883: warning: Function parameter or member 'ep' not described in 'ep_loop_check_proc'
../fs/eventpoll.c:1883: warning: Excess function parameter 'priv' description in 'ep_loop_check_proc'
../fs/eventpoll.c:1932: warning: Function parameter or member 'ep' not described in 'ep_loop_check'
../fs/eventpoll.c:1932: warning: Excess function parameter 'from' description in 'ep_loop_check'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-03-06 17:36:53 -07:00
arch * Doc fixes 2021-03-04 11:26:17 -08:00
block
certs
crypto
Documentation Documentation: ioctl: add entry for nsfs.h 2021-03-06 17:36:52 -07:00
drivers RDMA 5.12 first rc pull request 2021-03-05 17:27:59 -08:00
fs fs: eventpoll: fix comments & kernel-doc notation 2021-03-06 17:36:53 -07:00
include block-5.12-2021-03-05 2021-03-05 12:59:37 -08:00
init
ipc
kernel io_uring-5.12-2021-03-05 2021-03-05 12:44:43 -08:00
lib
LICENSES
mm
net
samples
scripts checkpatch: add verbose mode 2021-03-06 17:36:51 -07:00
security
sound
tools Documentation: Replace more lkml.org links with lore 2021-03-06 17:36:52 -07:00
usr
virt
.clang-format
.cocciconfig
.get_maintainer.ignore
.gitattributes
.gitignore
.mailmap
COPYING
CREDITS Documentation: Replace more lkml.org links with lore 2021-03-06 17:36:52 -07:00
Kbuild
Kconfig
MAINTAINERS MAINTAINERS: clarify responsibility for checkpatch documentation 2021-03-06 17:36:51 -07:00
Makefile Linux 5.12-rc2 2021-03-05 17:33:41 -08: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.