15 Oct, 2020
3 commits
-
pci_device_id is already documented at pci.rst:
./Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'PCI/pci'.
Declaration is 'pci_device_id'.The kstrtol and kstrtoul are already at kernel-api:
./Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'kstrtoul'.
./Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'kstrtol'.And the printk is already defined at printk-basics:
./Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/printk-basics'.
Declaration is 'printk'.So, exclude those identifiers from basirs.rst.
Signed-off-by: Mauro Carvalho Chehab
-
Those are already defined at kernel-api.rst, as part of the
synchronization primitives chapter.This solves several Sphinx 3 warnings, like:
.../Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'rcu_idle_enter'.
.../Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'rcu_idle_exit'.
.../Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'rcu_is_watching'.
.../Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'call_rcu'.
.../Documentation/driver-api/basics.rst: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'synchronize_rcu'.
...Signed-off-by: Mauro Carvalho Chehab
-
As there's already a rst file with workqueue markups, containing
part of them, move the other definitions, in order to avoid
warnings with Sphinx.Signed-off-by: Mauro Carvalho Chehab
25 May, 2019
1 commit
-
There are no kerneldoc comments in this file, so do not attempt to
include them in the docs build.Signed-off-by: Jonathan Corbet
19 Oct, 2018
1 commit
-
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
12 Dec, 2017
1 commit
-
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
18 Jul, 2017
2 commits
-
...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
-
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
05 Jul, 2017
1 commit
-
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
12 Apr, 2017
1 commit
-
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
23 Aug, 2016
1 commit
-
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