Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: add luo documentation

Add the documentation files for the Live Update Orchestrator

Link: https://lkml.kernel.org/r/20251125165850.3389713-9-pasha.tatashin@soleen.com
Signed-off-by: Pasha Tatashin <pasha.tatashin@soleen.com>
Reviewed-by: Mike Rapoport (Microsoft) <rppt@kernel.org>
Reviewed-by: Pratyush Yadav <pratyush@kernel.org>
Tested-by: David Matlack <dmatlack@google.com>
Cc: Aleksander Lobakin <aleksander.lobakin@intel.com>
Cc: Alexander Graf <graf@amazon.com>
Cc: Alice Ryhl <aliceryhl@google.com>
Cc: Andriy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: anish kumar <yesanishhere@gmail.com>
Cc: Anna Schumaker <anna.schumaker@oracle.com>
Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Cc: Bjorn Helgaas <bhelgaas@google.com>
Cc: Borislav Betkov <bp@alien8.de>
Cc: Chanwoo Choi <cw00.choi@samsung.com>
Cc: Chen Ridong <chenridong@huawei.com>
Cc: Chris Li <chrisl@kernel.org>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Daniel Wagner <wagi@kernel.org>
Cc: Danilo Krummrich <dakr@kernel.org>
Cc: Dan Williams <dan.j.williams@intel.com>
Cc: David Hildenbrand <david@redhat.com>
Cc: David Jeffery <djeffery@redhat.com>
Cc: David Rientjes <rientjes@google.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Guixin Liu <kanie@linux.alibaba.com>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: Hugh Dickins <hughd@google.com>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Ira Weiny <ira.weiny@intel.com>
Cc: Jann Horn <jannh@google.com>
Cc: Jason Gunthorpe <jgg@nvidia.com>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: Joanthan Cameron <Jonathan.Cameron@huawei.com>
Cc: Joel Granados <joel.granados@kernel.org>
Cc: Johannes Weiner <hannes@cmpxchg.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Lennart Poettering <lennart@poettering.net>
Cc: Leon Romanovsky <leon@kernel.org>
Cc: Leon Romanovsky <leonro@nvidia.com>
Cc: Lukas Wunner <lukas@wunner.de>
Cc: Marc Rutland <mark.rutland@arm.com>
Cc: Masahiro Yamada <masahiroy@kernel.org>
Cc: Matthew Maurer <mmaurer@google.com>
Cc: Miguel Ojeda <ojeda@kernel.org>
Cc: Myugnjoo Ham <myungjoo.ham@samsung.com>
Cc: Parav Pandit <parav@nvidia.com>
Cc: Pratyush Yadav <ptyadav@amazon.de>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Roman Gushchin <roman.gushchin@linux.dev>
Cc: Saeed Mahameed <saeedm@nvidia.com>
Cc: Samiullah Khawaja <skhawaja@google.com>
Cc: Song Liu <song@kernel.org>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Stuart Hayes <stuart.w.hayes@gmail.com>
Cc: Tejun Heo <tj@kernel.org>
Cc: Thomas Gleinxer <tglx@linutronix.de>
Cc: Thomas Weißschuh <linux@weissschuh.net>
Cc: Vincent Guittot <vincent.guittot@linaro.org>
Cc: William Tu <witu@nvidia.com>
Cc: Yoann Congal <yoann.congal@smile.fr>
Cc: Zhu Yanjun <yanjun.zhu@linux.dev>
Cc: Zijun Hu <quic_zijuhu@quicinc.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Pasha Tatashin and committed by
Andrew Morton
906a3306 16cec0d2

+76
+1
Documentation/core-api/index.rst
··· 138 138 :maxdepth: 1 139 139 140 140 librs 141 + liveupdate 141 142 netlink 142 143 143 144 .. only:: subproject and html
+54
Documentation/core-api/liveupdate.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ======================== 4 + Live 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 + 11 + LUO Sessions 12 + ============ 13 + .. kernel-doc:: kernel/liveupdate/luo_session.c 14 + :doc: LUO Sessions 15 + 16 + LUO Preserving File Descriptors 17 + =============================== 18 + .. kernel-doc:: kernel/liveupdate/luo_file.c 19 + :doc: LUO File Descriptors 20 + 21 + Live Update Orchestrator ABI 22 + ============================ 23 + .. kernel-doc:: include/linux/kho/abi/luo.h 24 + :doc: Live Update Orchestrator ABI 25 + 26 + Public API 27 + ========== 28 + .. kernel-doc:: include/linux/liveupdate.h 29 + 30 + .. kernel-doc:: include/linux/kho/abi/luo.h 31 + :functions: 32 + 33 + .. kernel-doc:: kernel/liveupdate/luo_core.c 34 + :export: 35 + 36 + .. kernel-doc:: kernel/liveupdate/luo_file.c 37 + :export: 38 + 39 + Internal API 40 + ============ 41 + .. kernel-doc:: kernel/liveupdate/luo_core.c 42 + :internal: 43 + 44 + .. kernel-doc:: kernel/liveupdate/luo_session.c 45 + :internal: 46 + 47 + .. kernel-doc:: kernel/liveupdate/luo_file.c 48 + :internal: 49 + 50 + See Also 51 + ======== 52 + 53 + - :doc:`Live Update uAPI </userspace-api/liveupdate>` 54 + - :doc:`/core-api/kho/concepts`
+1
Documentation/userspace-api/index.rst
··· 61 61 :maxdepth: 1 62 62 63 63 ELF 64 + liveupdate 64 65 netlink/index 65 66 sysfs-platform_profile 66 67 vduse
+20
Documentation/userspace-api/liveupdate.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ================ 4 + Live Update uAPI 5 + ================ 6 + :Author: Pasha Tatashin <pasha.tatashin@soleen.com> 7 + 8 + ioctl interface 9 + =============== 10 + .. kernel-doc:: kernel/liveupdate/luo_core.c 11 + :doc: LUO ioctl Interface 12 + 13 + ioctl uAPI 14 + =========== 15 + .. kernel-doc:: include/uapi/linux/liveupdate.h 16 + 17 + See Also 18 + ======== 19 + 20 + - :doc:`Live Update Orchestrator </core-api/liveupdate>`