[PATCH 1/6] kho/abi: luo: make generated documentation more coherent

Mike Rapoport posted 6 patches 1 month ago
[PATCH 1/6] kho/abi: luo: make generated documentation more coherent
Posted by Mike Rapoport 1 month ago
From: "Mike Rapoport (Microsoft)" <rppt@kernel.org>

LUO ABI description starts with "This header defines" which is fine in
the header but reads weird in the generated html documentation.

Update it to make the generated documentation coherent.

Signed-off-by: Mike Rapoport (Microsoft) <rppt@kernel.org>
---
 include/linux/kho/abi/luo.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/kho/abi/luo.h b/include/linux/kho/abi/luo.h
index bb099c92e469..beb86847b544 100644
--- a/include/linux/kho/abi/luo.h
+++ b/include/linux/kho/abi/luo.h
@@ -8,10 +8,10 @@
 /**
  * DOC: Live Update Orchestrator ABI
  *
- * This header defines the stable Application Binary Interface used by the
- * Live Update Orchestrator to pass state from a pre-update kernel to a
- * post-update kernel. The ABI is built upon the Kexec HandOver framework
- * and uses a Flattened Device Tree to describe the preserved data.
+ * Live Update Orchestrator uses the stable Application Binary Interface
+ * defined below to pass state from a pre-update kernel to a post-update
+ * kernel. The ABI is built upon the Kexec HandOver framework and uses a
+ * Flattened Device Tree to describe the preserved data.
  *
  * This interface is a contract. Any modification to the FDT structure, node
  * properties, compatible strings, or the layout of the `__packed` serialization
-- 
2.51.0
Re: [PATCH 1/6] kho/abi: luo: make generated documentation more coherent
Posted by Pasha Tatashin 2 weeks, 1 day ago
On Mon, Jan 5, 2026 at 11:58 AM Mike Rapoport <rppt@kernel.org> wrote:
>
> From: "Mike Rapoport (Microsoft)" <rppt@kernel.org>
>
> LUO ABI description starts with "This header defines" which is fine in
> the header but reads weird in the generated html documentation.
>
> Update it to make the generated documentation coherent.
>
> Signed-off-by: Mike Rapoport (Microsoft) <rppt@kernel.org>
> ---
>  include/linux/kho/abi/luo.h | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/include/linux/kho/abi/luo.h b/include/linux/kho/abi/luo.h
> index bb099c92e469..beb86847b544 100644
> --- a/include/linux/kho/abi/luo.h
> +++ b/include/linux/kho/abi/luo.h
> @@ -8,10 +8,10 @@
>  /**
>   * DOC: Live Update Orchestrator ABI
>   *
> - * This header defines the stable Application Binary Interface used by the
> - * Live Update Orchestrator to pass state from a pre-update kernel to a
> - * post-update kernel. The ABI is built upon the Kexec HandOver framework
> - * and uses a Flattened Device Tree to describe the preserved data.
> + * Live Update Orchestrator uses the stable Application Binary Interface
> + * defined below to pass state from a pre-update kernel to a post-update
> + * kernel. The ABI is built upon the Kexec HandOver framework and uses a
> + * Flattened Device Tree to describe the preserved data.
>   *
>   * This interface is a contract. Any modification to the FDT structure, node
>   * properties, compatible strings, or the layout of the `__packed` serialization
> --
> 2.51.0
>
Reviewed-by: Pasha Tatashin <pasha.tatashin@soleen.com>
Re: [PATCH 1/6] kho/abi: luo: make generated documentation more coherent
Posted by Pratyush Yadav 2 weeks, 3 days ago
On Mon, Jan 05 2026, Mike Rapoport wrote:

> From: "Mike Rapoport (Microsoft)" <rppt@kernel.org>
>
> LUO ABI description starts with "This header defines" which is fine in
> the header but reads weird in the generated html documentation.
>
> Update it to make the generated documentation coherent.
>
> Signed-off-by: Mike Rapoport (Microsoft) <rppt@kernel.org>

Reviewed-by: Pratyush Yadav <pratyush@kernel.org>

[...]

-- 
Regards,
Pratyush Yadav