summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/basics.rst
AgeCommit message (Collapse)AuthorFilesLines
2018-10-18docs: Introduce deprecated APIs listKees Cook1-0/+3
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 <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-12-11docs: refcount_t documentationElena Reshetova1-6/+15
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-07-17docs: Do not include kerneldoc comments from kernel/sys.cJonathan Corbet1-3/+0
...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-17docs: Get module_init() docs from module.hJonathan Corbet1-1/+1
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 <corbet@lwn.net>
2017-07-04docs: Do not include from kernel/rcu/srcu.cJonathan Corbet1-3/+0
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 <torvalds@linux-foundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-04-11driver-api/basics.rst: add device table headerMauro Carvalho Chehab1-0/+6
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>
2016-08-22docs: split up the driver bookJonathan Corbet1-0/+120
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>