Add the main documentation file for the Live Update Orchestrator subsystem at Documentation/admin-guide/liveupdate.rst. The new file is included in the main Documentation/admin-guide/index.rst table of contents. Signed-off-by: Pasha Tatashin <pasha.tatashin@xxxxxxxxxx> --- Documentation/admin-guide/index.rst | 1 + Documentation/admin-guide/liveupdate.rst | 62 ++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 Documentation/admin-guide/liveupdate.rst diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index 259d79fbeb94..3f59ccf32760 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -95,6 +95,7 @@ likely to be of interest on almost any system. cgroup-v2 cgroup-v1/index cpu-load + liveupdate mm/index module-signing namespaces/index diff --git a/Documentation/admin-guide/liveupdate.rst b/Documentation/admin-guide/liveupdate.rst new file mode 100644 index 000000000000..bff9475d2518 --- /dev/null +++ b/Documentation/admin-guide/liveupdate.rst @@ -0,0 +1,62 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================== +Live Update Orchestrator (LUO) +============================== +:Author: Pasha Tatashin <pasha.tatashin@xxxxxxxxxx> + +.. kernel-doc:: drivers/misc/liveupdate/luo_core.c + :doc: Live Update Orchestrator (LUO) + +LUO Subsystems Participation +============================ +.. kernel-doc:: drivers/misc/liveupdate/luo_subsystems.c + :doc: LUO Subsystems support + +LUO Preserving File Descriptors +=============================== +.. kernel-doc:: drivers/misc/liveupdate/luo_files.c + :doc: LUO file descriptors + +LUO ioctl interface +=================== +.. kernel-doc:: drivers/misc/liveupdate/luo_ioctl.c + :doc: LUO ioctl Interface + +LUO sysfs interface +=================== +.. kernel-doc:: drivers/misc/liveupdate/luo_sysfs.c + :doc: LUO sysfs interface + +LUO selftests ioctl +=================== +.. kernel-doc:: drivers/misc/liveupdate/luo_selftests.c + :doc: LUO Selftests + +ioctl uAPI +=========== +.. kernel-doc:: include/uapi/linux/liveupdate.h + +Public API +========== +.. kernel-doc:: include/linux/liveupdate.h + +.. kernel-doc:: drivers/misc/liveupdate/luo_core.c + :export: + +.. kernel-doc:: drivers/misc/liveupdate/luo_subsystems.c + :export: + +.. kernel-doc:: drivers/misc/liveupdate/luo_files.c + :export: + +Internal API +============ +.. kernel-doc:: drivers/misc/liveupdate/luo_core.c + :internal: + +.. kernel-doc:: drivers/misc/liveupdate/luo_subsystems.c + :internal: + +.. kernel-doc:: drivers/misc/liveupdate/luo_files.c + :internal: -- 2.49.0.1101.gccaa498523-goog