diff options
author | James Seo <james@equiv.tech> | 2023-05-09 10:55:46 -0700 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2023-05-19 08:58:11 -0600 |
commit | 4d744ce9d5d7cf0e3ab68d0cf160194da6504eb8 (patch) | |
tree | 30a6c3963d77e04b06f140eda936a963af1801c6 /Documentation/core-api | |
parent | 34d9f62e04568451682a76f1016dbb3e3b3e9bc0 (diff) |
err.h: Add missing kerneldocs for error pointer functions
Add kerneldocs for ERR_PTR(), PTR_ERR(), PTR_ERR_OR_ZERO(), IS_ERR(),
and IS_ERR_OR_NULL(). Doing so will help convert hundreds of mentions
of them in existing documentation into automatic cross-references.
Also add kerneldocs for IS_ERR_VALUE(). Doing so adds no automatic
cross-references, but this macro has a slightly different use case
than the functionally similar IS_ERR(), and documenting it may be
helpful to readers who encounter it in existing code.
ERR_CAST() already has kerneldocs and has not been touched.
Signed-off-by: James Seo <james@equiv.tech>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230509175543.2065835-3-james@equiv.tech
Diffstat (limited to 'Documentation/core-api')
0 files changed, 0 insertions, 0 deletions