From nobody Tue Dec 2 00:25:59 2025 Received: from mail-yw1-f176.google.com (mail-yw1-f176.google.com [209.85.128.176]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4F7E332C95A for ; Tue, 25 Nov 2025 16:59:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1764089956; cv=none; b=TyYOcimxkKfqK3MEh0B4LyEriZrn3y+wigjn2d4b+4gmfcLwawidbC4xrBFTmphPDSkvtOHbkaF0l9J8gjhGP1pk2OLDWDNIFVxNdkwvZ6S9qQaXK2N/bc6doX1l9GmpcMUypLFojfmBxTrTvEfhcwPHhhpOIIKsj2l+GMmQAys= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1764089956; c=relaxed/simple; bh=xrL/fE95vVE+j+qMFfMAEFOcWkNFadUPHDp/nSqn4jE=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=eCPyJnWRIGpLKUl1rgjLn+wi4MjSU1tWnXcMQZvobbmbxxjsSc6nrPMj8ZCKlUPR0fMrymN8euAenfXoeX3XmQl6p7gYTKRFQYxVGEymGcG++fQzoa3vxhpldK7rLiNHCP+J6XtrXygx9b/Y/atTifMvSmZWuvBIEEWPPfHs7hM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=soleen.com; spf=pass smtp.mailfrom=soleen.com; dkim=pass (2048-bit key) header.d=soleen.com header.i=@soleen.com header.b=j5aI6HAP; arc=none smtp.client-ip=209.85.128.176 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=soleen.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=soleen.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=soleen.com header.i=@soleen.com header.b="j5aI6HAP" Received: by mail-yw1-f176.google.com with SMTP id 00721157ae682-789314f0920so50509467b3.1 for ; Tue, 25 Nov 2025 08:59:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=soleen.com; s=google; t=1764089953; x=1764694753; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=04W1U9tqhM0nKxenqkng147mrDWDs9iksZrUOMH/VOs=; b=j5aI6HAPEMWqlDeC2WzvfhkPnOC620ylIFv1u/P5gaVsmnX3TbiQ3Yna+vcsuRBcxk kwwwLY4iJAT4zIoR/og7InAVosA5SVh4s3m7HkyHAQNFJ5RdbqT4ALIddOfb3umaYAEH /i9USuRFo2wWEouHtKOFy9UbOFHDgoPB3p0FvZw07pUvtjBffHYgHgyC/rBvtSNEEVmy NJ0AWEMQ+FAFz0ipC677QVWdKHNaFJIfKoZPioxhdLzJRCrNU6Uh2NgqOdHnnaiF+srn K83Vm4hrouywSZtTcbMx/zj48UwYm/lpVqvb+HXBMWsikXOb/+T3dBlPYLI8+sWQyFUk 0f1A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1764089953; x=1764694753; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-gg:x-gm-message-state:from:to :cc:subject:date:message-id:reply-to; bh=04W1U9tqhM0nKxenqkng147mrDWDs9iksZrUOMH/VOs=; b=k5rZzCrgmj//SM14yGUGONj0nV+7u6HEoUWSl39c5npSo4HEz1pcYG88n+CIBQ060Y XWkr1tfWGZfQ3gxSrXs1bPelfX2MSZyLTFnTK2ApZias5yvVs4+7acS17+/9P+FXQtXg ZnDwQHc6PiKRgImEaqhIw5xp7fi+/stFTSWxPIm8KiQ9d7zLFWPrcHhI7ew4EVv9XRfP KceQ0YII8luWNmYq51XzYTgakwlCG9gOF/7O67b56ySqrXP53+w0vAd0rZdLorxnStV8 eYLoS6h+x2EV0L6iH0F2yqqNWudVN/qGWvzNM34+C6JCdi2Cq94yhdTyojtexdAUPGU4 WydA== X-Forwarded-Encrypted: i=1; AJvYcCX1bUckC/mWTjOGIznukOPAYavndlfZoslw/C3klnRyurerJv2MtHCJN82uLxFEqLq8TgbpETzqTqKX5NE=@vger.kernel.org X-Gm-Message-State: AOJu0YxYmzPIGyVZfg8ASIw4/mMYs972QqaBFpYufCXVrVN+Hc9urH+w GOrsEkM1YR/hJo6yfCK1TV+xqJFW88PaNdlQKfDhvFFfmnULwbewwSOVx9O8ET/x/tc= X-Gm-Gg: ASbGncu7ACfaP1dAV8uf/OkylktzGMVw71MixZLZBbK5KUhUQsNVUeH11+gSpk/DsPZ u2vDndBLspTWigumo361XOpmPi8wSuaDkbD6gpIWJv+o4VTE4K2QdROL7JNMqyTY1dCGXdswWqk A6b27Cbww8ZLPHe2uU78uTyK+iJQNbnccvFDWEDqI0hnaney/PifsUvf4/zyYxEKRunsTIa0vkt Uc1CzINPfCvce09L6zhHyZ6SKj1yz9zpt92xsrVZJM51JCyKe9taDjjTrr3WfGXJFFmRknyKdPX HL3W3qUsUc5RZ9whHrQKZjNruRIkLEj49IklE1BVXVP7Qh0dxfB2aV0Bi+lR0JYNxwRvtu3DcLP A5a7DdtqujjglRZZJCHdBRZXtM6U1UDmxSMZqmfUTQ3Sc4a1fE5712Dpp3EVL3XUGkkmRajyc0k EBg+J99YdBc1pHPaMJt1o0ZtMeCUo72EBRTJtwydelI04H9GHrlEmNohNkV0CnpcgX X-Google-Smtp-Source: AGHT+IG/VheigjnnqLhidQQho4WaPxQMBWl1KDbGTnAN7GCTM0241MCFueP/x+zM5U+5JuAeLMQRDQ== X-Received: by 2002:a05:690c:84:b0:786:8a95:1e00 with SMTP id 00721157ae682-78ab6dacefamr27675197b3.10.1764089952872; Tue, 25 Nov 2025 08:59:12 -0800 (PST) Received: from soleen.c.googlers.com.com (182.221.85.34.bc.googleusercontent.com. [34.85.221.182]) by smtp.gmail.com with ESMTPSA id 00721157ae682-78a798a5518sm57284357b3.14.2025.11.25.08.59.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Nov 2025 08:59:12 -0800 (PST) From: Pasha Tatashin To: pratyush@kernel.org, jasonmiu@google.com, graf@amazon.com, pasha.tatashin@soleen.com, rppt@kernel.org, dmatlack@google.com, rientjes@google.com, corbet@lwn.net, rdunlap@infradead.org, ilpo.jarvinen@linux.intel.com, kanie@linux.alibaba.com, ojeda@kernel.org, aliceryhl@google.com, masahiroy@kernel.org, akpm@linux-foundation.org, tj@kernel.org, yoann.congal@smile.fr, mmaurer@google.com, roman.gushchin@linux.dev, chenridong@huawei.com, axboe@kernel.dk, mark.rutland@arm.com, jannh@google.com, vincent.guittot@linaro.org, hannes@cmpxchg.org, dan.j.williams@intel.com, david@redhat.com, joel.granados@kernel.org, rostedt@goodmis.org, anna.schumaker@oracle.com, song@kernel.org, linux@weissschuh.net, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, linux-mm@kvack.org, gregkh@linuxfoundation.org, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de, dave.hansen@linux.intel.com, x86@kernel.org, hpa@zytor.com, rafael@kernel.org, dakr@kernel.org, bartosz.golaszewski@linaro.org, cw00.choi@samsung.com, myungjoo.ham@samsung.com, yesanishhere@gmail.com, Jonathan.Cameron@huawei.com, quic_zijuhu@quicinc.com, aleksander.lobakin@intel.com, ira.weiny@intel.com, andriy.shevchenko@linux.intel.com, leon@kernel.org, lukas@wunner.de, bhelgaas@google.com, wagi@kernel.org, djeffery@redhat.com, stuart.w.hayes@gmail.com, ptyadav@amazon.de, lennart@poettering.net, brauner@kernel.org, linux-api@vger.kernel.org, linux-fsdevel@vger.kernel.org, saeedm@nvidia.com, ajayachandra@nvidia.com, jgg@nvidia.com, parav@nvidia.com, leonro@nvidia.com, witu@nvidia.com, hughd@google.com, skhawaja@google.com, chrisl@kernel.org Subject: [PATCH v8 08/18] docs: add luo documentation Date: Tue, 25 Nov 2025 11:58:38 -0500 Message-ID: <20251125165850.3389713-9-pasha.tatashin@soleen.com> X-Mailer: git-send-email 2.52.0.460.gd25c4c69ec-goog In-Reply-To: <20251125165850.3389713-1-pasha.tatashin@soleen.com> References: <20251125165850.3389713-1-pasha.tatashin@soleen.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add the documentation files for the Live Update Orchestrator Signed-off-by: Pasha Tatashin Reviewed-by: Mike Rapoport (Microsoft) Reviewed-by: Pratyush Yadav --- Documentation/core-api/index.rst | 1 + Documentation/core-api/liveupdate.rst | 54 ++++++++++++++++++++++ Documentation/userspace-api/index.rst | 1 + Documentation/userspace-api/liveupdate.rst | 20 ++++++++ 4 files changed, 76 insertions(+) create mode 100644 Documentation/core-api/liveupdate.rst create mode 100644 Documentation/userspace-api/liveupdate.rst diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/inde= x.rst index 6cbdcbfa79c3..5eb0fbbbc323 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -138,6 +138,7 @@ Documents that don't fit elsewhere or which have yet to= be categorized. :maxdepth: 1 =20 librs + liveupdate netlink =20 .. only:: subproject and html diff --git a/Documentation/core-api/liveupdate.rst b/Documentation/core-api= /liveupdate.rst new file mode 100644 index 000000000000..cca1993008d8 --- /dev/null +++ b/Documentation/core-api/liveupdate.rst @@ -0,0 +1,54 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Live Update Orchestrator +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +:Author: Pasha Tatashin + +.. kernel-doc:: kernel/liveupdate/luo_core.c + :doc: Live Update Orchestrator (LUO) + +LUO Sessions +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +.. kernel-doc:: kernel/liveupdate/luo_session.c + :doc: LUO Sessions + +LUO Preserving File Descriptors +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D +.. kernel-doc:: kernel/liveupdate/luo_file.c + :doc: LUO File Descriptors + +Live Update Orchestrator ABI +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D +.. kernel-doc:: include/linux/kho/abi/luo.h + :doc: Live Update Orchestrator ABI + +Public API +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +.. kernel-doc:: include/linux/liveupdate.h + +.. kernel-doc:: include/linux/kho/abi/luo.h + :functions: + +.. kernel-doc:: kernel/liveupdate/luo_core.c + :export: + +.. kernel-doc:: kernel/liveupdate/luo_file.c + :export: + +Internal API +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +.. kernel-doc:: kernel/liveupdate/luo_core.c + :internal: + +.. kernel-doc:: kernel/liveupdate/luo_session.c + :internal: + +.. kernel-doc:: kernel/liveupdate/luo_file.c + :internal: + +See Also +=3D=3D=3D=3D=3D=3D=3D=3D + +- :doc:`Live Update uAPI ` +- :doc:`/core-api/kho/concepts` diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspac= e-api/index.rst index b8c73be4fb11..8a61ac4c1bf1 100644 --- a/Documentation/userspace-api/index.rst +++ b/Documentation/userspace-api/index.rst @@ -61,6 +61,7 @@ Everything else :maxdepth: 1 =20 ELF + liveupdate netlink/index sysfs-platform_profile vduse diff --git a/Documentation/userspace-api/liveupdate.rst b/Documentation/use= rspace-api/liveupdate.rst new file mode 100644 index 000000000000..41c0473e4f16 --- /dev/null +++ b/Documentation/userspace-api/liveupdate.rst @@ -0,0 +1,20 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Live Update uAPI +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +:Author: Pasha Tatashin + +ioctl interface +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +.. kernel-doc:: kernel/liveupdate/luo_core.c + :doc: LUO ioctl Interface + +ioctl uAPI +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +.. kernel-doc:: include/uapi/linux/liveupdate.h + +See Also +=3D=3D=3D=3D=3D=3D=3D=3D + +- :doc:`Live Update Orchestrator ` --=20 2.52.0.460.gd25c4c69ec-goog