* [PATCH] docs: memfd_preservation: fix rendering of ABI documentation
@ 2026-06-05 16:06 Pratyush Yadav
2026-06-06 19:36 ` Randy Dunlap
2026-06-07 5:40 ` Mike Rapoport
0 siblings, 2 replies; 3+ messages in thread
From: Pratyush Yadav @ 2026-06-05 16:06 UTC (permalink / raw)
To: Pasha Tatashin, Mike Rapoport, Pratyush Yadav, Andrew Morton,
David Hildenbrand, Jonathan Corbet, Shuah Khan
Cc: kexec, linux-kernel, linux-mm, linux-doc
From: "Pratyush Yadav (Google)" <pratyush@kernel.org>
The "memfd Live Update ABI" section in include/linux/kho/abi/memfd.h
currently does not render in the exported documentation. This is because
it should not include the "DOC:" in its reference. Drop it to ensure
correct rendering. Tested by running make htmldocs.
Fixes: 15fc11bb2cb6 ("docs: add documentation for memfd preservation via LUO")
Signed-off-by: Pratyush Yadav (Google) <pratyush@kernel.org>
---
Notes:
Mike/Pasha, I reckon this can still go in liveupdate/next. But if you
think it is too late, we can probably take it via -rc1 fixes as well.
Documentation/mm/memfd_preservation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/mm/memfd_preservation.rst b/Documentation/mm/memfd_preservation.rst
index a8a5b476afd3..c908a12dffa7 100644
--- a/Documentation/mm/memfd_preservation.rst
+++ b/Documentation/mm/memfd_preservation.rst
@@ -11,7 +11,7 @@ Memfd Preservation ABI
======================
.. kernel-doc:: include/linux/kho/abi/memfd.h
- :doc: DOC: memfd Live Update ABI
+ :doc: memfd Live Update ABI
.. kernel-doc:: include/linux/kho/abi/memfd.h
:internal:
base-commit: 2935777b418d2bfcbfe96705bb2c0fa6c0d94e18
--
2.54.0.1032.g2f8565e1d1-goog
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] docs: memfd_preservation: fix rendering of ABI documentation
2026-06-05 16:06 [PATCH] docs: memfd_preservation: fix rendering of ABI documentation Pratyush Yadav
@ 2026-06-06 19:36 ` Randy Dunlap
2026-06-07 5:40 ` Mike Rapoport
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2026-06-06 19:36 UTC (permalink / raw)
To: Pratyush Yadav, Pasha Tatashin, Mike Rapoport, Andrew Morton,
David Hildenbrand, Jonathan Corbet, Shuah Khan
Cc: kexec, linux-kernel, linux-mm, linux-doc
On 6/5/26 9:06 AM, Pratyush Yadav wrote:
> From: "Pratyush Yadav (Google)" <pratyush@kernel.org>
>
> The "memfd Live Update ABI" section in include/linux/kho/abi/memfd.h
> currently does not render in the exported documentation. This is because
> it should not include the "DOC:" in its reference. Drop it to ensure
> correct rendering. Tested by running make htmldocs.
>
> Fixes: 15fc11bb2cb6 ("docs: add documentation for memfd preservation via LUO")
> Signed-off-by: Pratyush Yadav (Google) <pratyush@kernel.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
>
> Notes:
> Mike/Pasha, I reckon this can still go in liveupdate/next. But if you
> think it is too late, we can probably take it via -rc1 fixes as well.
>
> Documentation/mm/memfd_preservation.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/mm/memfd_preservation.rst b/Documentation/mm/memfd_preservation.rst
> index a8a5b476afd3..c908a12dffa7 100644
> --- a/Documentation/mm/memfd_preservation.rst
> +++ b/Documentation/mm/memfd_preservation.rst
> @@ -11,7 +11,7 @@ Memfd Preservation ABI
> ======================
>
> .. kernel-doc:: include/linux/kho/abi/memfd.h
> - :doc: DOC: memfd Live Update ABI
> + :doc: memfd Live Update ABI
>
> .. kernel-doc:: include/linux/kho/abi/memfd.h
> :internal:
>
> base-commit: 2935777b418d2bfcbfe96705bb2c0fa6c0d94e18
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] docs: memfd_preservation: fix rendering of ABI documentation
2026-06-05 16:06 [PATCH] docs: memfd_preservation: fix rendering of ABI documentation Pratyush Yadav
2026-06-06 19:36 ` Randy Dunlap
@ 2026-06-07 5:40 ` Mike Rapoport
1 sibling, 0 replies; 3+ messages in thread
From: Mike Rapoport @ 2026-06-07 5:40 UTC (permalink / raw)
To: Pasha Tatashin, Andrew Morton, David Hildenbrand, Jonathan Corbet,
Shuah Khan, Pratyush Yadav
Cc: kexec, linux-kernel, linux-mm, linux-doc
On Fri, 05 Jun 2026 18:06:44 +0200, Pratyush Yadav wrote:
> docs: memfd_preservation: fix rendering of ABI documentation
Applied to next branch of liveupdate/linux.git tree, thanks!
[1/1] docs: memfd_preservation: fix rendering of ABI documentation
commit: 3a358c78093f98a70d84c934b7054f636bc846f2
tree: https://git.kernel.org/pub/scm/linux/kernel/git/liveupdate/linux
branch: next
--
Sincerely yours,
Mike.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2026-06-07 5:40 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-06-05 16:06 [PATCH] docs: memfd_preservation: fix rendering of ABI documentation Pratyush Yadav
2026-06-06 19:36 ` Randy Dunlap
2026-06-07 5:40 ` Mike Rapoport
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox