Add the documentation files for the Live Update Orchestrator Signed-off-by: Pasha Tatashin <pasha.tatashin@xxxxxxxxxx> --- Documentation/admin-guide/index.rst | 1 + Documentation/admin-guide/liveupdate.rst | 16 +++++++ Documentation/core-api/index.rst | 1 + Documentation/core-api/liveupdate.rst | 50 ++++++++++++++++++++++ Documentation/userspace-api/index.rst | 1 + Documentation/userspace-api/liveupdate.rst | 25 +++++++++++ 6 files changed, 94 insertions(+) create mode 100644 Documentation/admin-guide/liveupdate.rst create mode 100644 Documentation/core-api/liveupdate.rst create mode 100644 Documentation/userspace-api/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..ff05cc1dd784 --- /dev/null +++ b/Documentation/admin-guide/liveupdate.rst @@ -0,0 +1,16 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================= +Live Update sysfs +================= +:Author: Pasha Tatashin <pasha.tatashin@xxxxxxxxxx> + +LUO sysfs interface +=================== +.. kernel-doc:: kernel/liveupdate/luo_sysfs.c + :doc: LUO sysfs interface + +See Also +======== + +- :doc:`Live Update Orchestrator </core-api/liveupdate>` diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index 7a4ca18ca6e2..a79d806f2c8e 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -136,6 +136,7 @@ Documents that don't fit elsewhere or which have yet to be categorized. :maxdepth: 1 librs + liveupdate netlink .. only:: subproject and html diff --git a/Documentation/core-api/liveupdate.rst b/Documentation/core-api/liveupdate.rst new file mode 100644 index 000000000000..41c4b76cd3ec --- /dev/null +++ b/Documentation/core-api/liveupdate.rst @@ -0,0 +1,50 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================== +Live Update Orchestrator +======================== +:Author: Pasha Tatashin <pasha.tatashin@xxxxxxxxxx> + +.. kernel-doc:: kernel/liveupdate/luo_core.c + :doc: Live Update Orchestrator (LUO) + +LUO Subsystems Participation +============================ +.. kernel-doc:: kernel/liveupdate/luo_subsystems.c + :doc: LUO Subsystems support + +LUO Preserving File Descriptors +=============================== +.. kernel-doc:: kernel/liveupdate/luo_files.c + :doc: LUO file descriptors + +Public API +========== +.. kernel-doc:: include/linux/liveupdate.h + +.. kernel-doc:: kernel/liveupdate/luo_core.c + :export: + +.. kernel-doc:: kernel/liveupdate/luo_subsystems.c + :export: + +.. kernel-doc:: kernel/liveupdate/luo_files.c + :export: + +Internal API +============ +.. kernel-doc:: kernel/liveupdate/luo_core.c + :internal: + +.. kernel-doc:: kernel/liveupdate/luo_subsystems.c + :internal: + +.. kernel-doc:: kernel/liveupdate/luo_files.c + :internal: + +See Also +======== + +- :doc:`Live Update uAPI </userspace-api/liveupdate>` +- :doc:`Live Update SysFS </admin-guide/liveupdate>` +- :doc:`/core-api/kho/concepts` diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst index b8c73be4fb11..ee8326932cb0 100644 --- a/Documentation/userspace-api/index.rst +++ b/Documentation/userspace-api/index.rst @@ -62,6 +62,7 @@ Everything else ELF netlink/index + liveupdate sysfs-platform_profile vduse futex2 diff --git a/Documentation/userspace-api/liveupdate.rst b/Documentation/userspace-api/liveupdate.rst new file mode 100644 index 000000000000..70b5017c0e3c --- /dev/null +++ b/Documentation/userspace-api/liveupdate.rst @@ -0,0 +1,25 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================ +Live Update uAPI +================ +:Author: Pasha Tatashin <pasha.tatashin@xxxxxxxxxx> + +ioctl interface +=============== +.. kernel-doc:: kernel/liveupdate/luo_ioctl.c + :doc: LUO ioctl Interface + +ioctl uAPI +=========== +.. kernel-doc:: include/uapi/linux/liveupdate.h + +LUO selftests ioctl +=================== +.. kernel-doc:: kernel/liveupdate/luo_selftests.c + :doc: LUO Selftests + +See Also +======== + +- :doc:`Live Update Orchestrator </core-api/liveupdate>` -- 2.50.0.727.gbf7dc18ff4-goog