2016-10-28 08:14:10 +00:00
|
|
|
======================
|
2016-11-19 00:06:13 +00:00
|
|
|
Core API Documentation
|
2016-10-28 08:14:10 +00:00
|
|
|
======================
|
|
|
|
|
|
2016-11-19 00:06:13 +00:00
|
|
|
This is the beginning of a manual for core kernel APIs. The conversion
|
|
|
|
|
(and writing!) of documents for this manual is much appreciated!
|
|
|
|
|
|
|
|
|
|
Core utilities
|
|
|
|
|
==============
|
2016-10-28 08:14:10 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2017-03-30 20:11:32 +00:00
|
|
|
kernel-api
|
2016-11-28 17:30:53 +00:00
|
|
|
assoc_array
|
2016-11-28 17:30:55 +00:00
|
|
|
atomic_ops
|
2018-05-07 09:35:41 +00:00
|
|
|
cachetlb
|
2017-12-05 10:46:35 +00:00
|
|
|
refcount-vs-atomic
|
2016-12-22 16:19:34 +00:00
|
|
|
cpu_hotplug
|
2018-02-06 20:05:49 +00:00
|
|
|
idr
|
2016-11-28 17:30:54 +00:00
|
|
|
local_ops
|
2016-10-28 08:14:11 +00:00
|
|
|
workqueue
|
2017-03-30 20:11:30 +00:00
|
|
|
genericirq
|
2017-11-24 03:57:20 +00:00
|
|
|
xarray
|
2017-05-13 10:07:47 +00:00
|
|
|
librs
|
2017-08-24 20:27:05 +00:00
|
|
|
genalloc
|
2017-12-22 14:32:16 +00:00
|
|
|
errseq
|
2019-07-26 12:51:20 +00:00
|
|
|
packing
|
2017-12-19 21:17:15 +00:00
|
|
|
printk-formats
|
2018-05-07 09:35:43 +00:00
|
|
|
circular-buffers
|
2019-03-12 06:31:14 +00:00
|
|
|
generic-radix-tree
|
2018-09-14 09:27:58 +00:00
|
|
|
memory-allocation
|
2018-08-24 00:01:12 +00:00
|
|
|
mm-api
|
2018-05-29 08:26:44 +00:00
|
|
|
gfp_mask-from-fs-io
|
Documentation: document ktime_get_*() APIs
As Dave Chinner points out, we don't have a proper documentation for the
ktime_get() family of interfaces, making it rather unclear which of the
over 30 (!) interfaces one should actually use in a driver or elsewhere
in the kernel.
I wrote up an explanation from how I personally see the interfaces,
documenting what each of the functions do and hopefully making it a bit
clearer which should be used where.
This is the first time I tried writing .rst format documentation, so
in addition to any mistakes in the content, I probably also introduce
nonstandard formatting ;-)
I first tried to add an extra section to
Documentation/timers/timekeeping.txt, but this is currently not included
in the generated API, and it seems useful to have the API docs as part
of what gets generated in
https://www.kernel.org/doc/html/latest/core-api/index.html#core-utilities
instead, so I started a new file there.
I also considered adding the documentation inline in the
include/linux/timekeeping.h header, but couldn't figure out how to do
that in a way that would result both in helpful inline comments as
well as readable html output, so I settled for the latter, with
a small note pointing to it from the header.
Cc: Dave Chinner <david@fromorbit.com>
Cc: John Stultz <john.stultz@linaro.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Stephen Boyd <sboyd@kernel.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-07-10 14:46:41 +00:00
|
|
|
timekeeping
|
2018-06-30 14:55:06 +00:00
|
|
|
boot-time-mm
|
2018-10-11 04:58:16 +00:00
|
|
|
memory-hotplug
|
2019-06-07 18:54:31 +00:00
|
|
|
protection-keys
|
2019-06-27 14:35:26 +00:00
|
|
|
../RCU/index
|
2019-04-19 22:01:18 +00:00
|
|
|
gcc-plugins
|
2019-10-08 03:10:09 +00:00
|
|
|
symbol-namespaces
|
2019-12-03 19:31:14 +00:00
|
|
|
padata
|
2019-12-03 09:57:23 +00:00
|
|
|
ioctl
|
2018-10-04 22:11:01 +00:00
|
|
|
|
2016-10-28 08:14:11 +00:00
|
|
|
|
2016-11-19 00:06:13 +00:00
|
|
|
Interfaces for kernel debugging
|
|
|
|
|
===============================
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2016-11-19 00:21:32 +00:00
|
|
|
debug-objects
|
|
|
|
|
tracepoint
|
2016-11-19 00:06:13 +00:00
|
|
|
|
2019-07-26 12:51:29 +00:00
|
|
|
.. only:: subproject and html
|
2016-10-28 08:14:10 +00:00
|
|
|
|
|
|
|
|
Indices
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
