[PATCH v4 11/11] docs: core-api: Document the seq_buf API
sashiko-bot at kernel.org
sashiko-bot at kernel.org
Sat Oct 3 04:03:03 UTC 2026
> The kernel-doc in include/linux/seq_buf.h and lib/seq_buf.c documents
> the seq_buf interface, but no .rst file pulls either of them in, so none
> of it reaches the generated documentation.
>
> Add the missing kernel-doc for seq_buf_clear() and seq_buf_init(), and a
> Sequence Buffers section to the kernel API documentation. The static
> internal helper seq_buf_can_fit() is left out. Additionally fix
> seq_buf_hex_dump() indentation to avoid the reported Sphinx error:
>
> ERROR: Unexpected indentation.
> WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Verified with "make SPHINXDIRS=core-api htmldocs", which rendered
> happily into core-api/kernel-api.html.
>
> Assisted-by: LLM
> Co-developed-by: Bill Wendling <morbo at google.com>
> Signed-off-by: Bill Wendling <morbo at google.com>
> Tested-by: Randy Dunlap <rdunlap at infradead.org>
> Reviewed-by: Randy Dunlap <rdunlap at infradead.org>
> Signed-off-by: Kees Cook <kees at kernel.org>
Sashiko has reviewed this patch and found no issues. It looks great!
--
Sashiko AI review · https://sashiko.dev/#/patchset/20261003035906.too.263-kees@kernel.org?part=11
More information about the Linux-security-module-archive
mailing list