docs: memfd_preservation: fix rendering of ABI documentation
Subsystems (5)
Pratyush Yadav
maintainerPATCH 1/1 docs: memfd_preservation: fix rendering of ABI documentation
From: "Pratyush Yadav (Google)" <[email protected]>
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.
---
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(-)
Documentation/mm/memfd_preservation.rst +1 -1
@@ -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
Signature · 1 line
2.54.0.1032.g2f8565e1d1-goog
Quoted 9 lines · Pratyush Yadav
From: "Pratyush Yadav (Google)" <[email protected]>
The "memfd Live Update ABI" section in
include/linux/kho/abi/memfd.hcurrently 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) <[email protected]>
Thanks.
Quoted 24 lines
---
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(-)Documentation/mm/memfd_preservation.rst +1
-1@@ -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
Signature · 1 line
~Randy
Quoted 1 line · Pratyush Yadav
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.