Commit Graph

6 Commits

Author SHA1 Message Date
Elena Reshetova
b6e859f6cd docs: refcount_t documentation
Some functions from refcount_t API provide different
memory ordering guarantees that their atomic counterparts.
This adds a document outlining these differences (
Documentation/core-api/refcount-vs-atomic.rst) as well as
some other minor improvements.

Signed-off-by: Elena Reshetova <elena.reshetova@intel.com>
Signed-off-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-12-11 14:37:11 -07:00
Jonathan Corbet
b18b12ae60 docs: Do not include kerneldoc comments from kernel/sys.c
...because there are none there, and I cannot figure out what would ever
have been of interest there.  This eliminates this warning:

    ./kernel/sys.c:1: warning: no structured comments found

from the build.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-17 14:05:36 -06:00
Jonathan Corbet
127d4b3764 docs: Get module_init() docs from module.h
The docs build complains:

    ./include/linux/init.h:1: warning: no structured comments found

The problem is that the comments in question were moved to module.h in
commit 0fd972a7d9 (module: relocate module_init from init.h to
module.h).  Fix basics.rst to match.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-17 13:55:58 -06:00
Jonathan Corbet
ecebcd4da6 docs: Do not include from kernel/rcu/srcu.c
That file went away with commit bd8cc5a062 (srcu: Remove Classic SRCU)
during the 4.13 merge window, leading to errors like:

  Error: Cannot open file ./kernel/rcu/srcu.c

during the docs build.

Reported-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-04 13:16:41 -06:00
Mauro Carvalho Chehab
d76a085bc8 driver-api/basics.rst: add device table header
The structs there at device table are used by other documentation
at the Kernel. So, add it to the driver API.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-04-11 14:35:28 -06:00
Jonathan Corbet
dcec3c8c9a docs: split up the driver book
We don't need to keep it as a single large file anymore; split it up so
that it is easier to manage and the individual sections can be read
directly as plain files.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-22 14:42:08 -06:00