[PATCH 2/6] kho/abi: memfd: make generated documentation more coherent

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

memfd preservation 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/memfd.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/kho/abi/memfd.h b/include/linux/kho/abi/memfd.h
index da7d063474a1..c211c31334a3 100644
--- a/include/linux/kho/abi/memfd.h
+++ b/include/linux/kho/abi/memfd.h
@@ -17,8 +17,8 @@
 /**
  * DOC: memfd Live Update ABI
  *
- * This header defines the ABI for preserving the state of a memfd across a
- * kexec reboot using the LUO.
+ * memfd uses the ABI defined below for preserving its state across a kexec
+ * reboot using the LUO.
  *
  * The state is serialized into a packed structure `struct memfd_luo_ser`
  * which is handed over to the next kernel via the KHO mechanism.
-- 
2.51.0
Re: [PATCH 2/6] kho/abi: memfd: 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>
>
> memfd preservation 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/memfd.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/kho/abi/memfd.h b/include/linux/kho/abi/memfd.h
> index da7d063474a1..c211c31334a3 100644
> --- a/include/linux/kho/abi/memfd.h
> +++ b/include/linux/kho/abi/memfd.h
> @@ -17,8 +17,8 @@
>  /**
>   * DOC: memfd Live Update ABI
>   *
> - * This header defines the ABI for preserving the state of a memfd across a
> - * kexec reboot using the LUO.
> + * memfd uses the ABI defined below for preserving its state across a kexec
> + * reboot using the LUO.
>   *
>   * The state is serialized into a packed structure `struct memfd_luo_ser`
>   * which is handed over to the next kernel via the KHO mechanism.
> --
> 2.51.0
>

Reviewed-by: Pasha Tatashin <pasha.tatashin@soleen.com>
Re: [PATCH 2/6] kho/abi: memfd: 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>
>
> memfd preservation 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