linux-toradex.git/Documentation/driver-api/basics.rst, branch v5.0

docs: Introduce deprecated APIs list

2018-10-18T18:22:43+00:00

As discussed in the "API replacement/deprecation" thread[1], this makes
an effort to document what things shouldn't get (re)added to the kernel,
by introducing Documentation/process/deprecated.rst.

[1] https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2018-September/005282.html

Signed-off-by: Kees Cook 
Signed-off-by: Jonathan Corbet

docs: refcount_t documentation

2017-12-11T21:37:11+00:00

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 
Signed-off-by: Kees Cook 
Signed-off-by: Jonathan Corbet

docs: Do not include kerneldoc comments from kernel/sys.c

2017-07-17T20:05:36+00:00

...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

docs: Get module_init() docs from module.h

2017-07-17T19:55:58+00:00

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 0fd972a7d91d (module: relocate module_init from init.h to
module.h).  Fix basics.rst to match.

Signed-off-by: Jonathan Corbet

docs: Do not include from kernel/rcu/srcu.c

2017-07-04T19:16:41+00:00

That file went away with commit bd8cc5a062f4 (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 
Signed-off-by: Jonathan Corbet

driver-api/basics.rst: add device table header

2017-04-11T20:35:28+00:00

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 
Signed-off-by: Jonathan Corbet

docs: split up the driver book

2016-08-22T20:42:08+00:00

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