xref: /linux/Documentation/core-api/liveupdate.rst (revision 509d3f45847627f4c5cdce004c3ec79262b5239c)
1.. SPDX-License-Identifier: GPL-2.0
2
3========================
4Live Update Orchestrator
5========================
6:Author: Pasha Tatashin <pasha.tatashin@soleen.com>
7
8.. kernel-doc:: kernel/liveupdate/luo_core.c
9   :doc: Live Update Orchestrator (LUO)
10
11LUO Sessions
12============
13.. kernel-doc:: kernel/liveupdate/luo_session.c
14   :doc: LUO Sessions
15
16LUO Preserving File Descriptors
17===============================
18.. kernel-doc:: kernel/liveupdate/luo_file.c
19   :doc: LUO File Descriptors
20
21Live Update Orchestrator ABI
22============================
23.. kernel-doc:: include/linux/kho/abi/luo.h
24   :doc: Live Update Orchestrator ABI
25
26The following types of file descriptors can be preserved
27
28.. toctree::
29   :maxdepth: 1
30
31   ../mm/memfd_preservation
32
33Public API
34==========
35.. kernel-doc:: include/linux/liveupdate.h
36
37.. kernel-doc:: include/linux/kho/abi/luo.h
38   :functions:
39
40.. kernel-doc:: kernel/liveupdate/luo_core.c
41   :export:
42
43.. kernel-doc:: kernel/liveupdate/luo_file.c
44   :export:
45
46Internal API
47============
48.. kernel-doc:: kernel/liveupdate/luo_core.c
49   :internal:
50
51.. kernel-doc:: kernel/liveupdate/luo_session.c
52   :internal:
53
54.. kernel-doc:: kernel/liveupdate/luo_file.c
55   :internal:
56
57See Also
58========
59
60- :doc:`Live Update uAPI </userspace-api/liveupdate>`
61- :doc:`/core-api/kho/concepts`
62