Re: [PATCH 0/3] Generate documentation for error pointer functions

From: Jonathan Corbet
Date: Fri May 19 2023 - 11:13:45 EST


James Seo <james@xxxxxxxxxx> writes:

> The error pointer functions are collectively mentioned hundreds of times
> in existing documentation (e.g. "Return: an ERR_PTR() on failure.",
> "If IS_ERR() is true, the function failed and PTR_ERR() gives you the
> error code.")
>
> This series adds kerneldocs for them and brings them into the docs build,
> immediately turning most such mentions into automatic cross-references.
>
> James Seo (3):
> Documentation: conf.py: Add __force to c_id_attributes
> err.h: Add missing kerneldocs for error pointer functions
> Documentation: core-api: Add error pointer functions to kernel-api
>
> Documentation/conf.py | 1 +
> Documentation/core-api/kernel-api.rst | 6 ++++
> include/linux/err.h | 48 +++++++++++++++++++++++++++
> 3 files changed, 55 insertions(+)

Series applied, thanks.

jon