diff options
| author | James Seo <james@equiv.tech> | 2023-05-09 10:55:48 -0700 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2023-05-19 08:58:11 -0600 |
| commit | 2017e3cae0c48c4f178386538712b50549a7d9a5 (patch) | |
| tree | daf60876b0f578d083c2d98d84b46521152cdb84 | |
| parent | 4d744ce9d5d7cf0e3ab68d0cf160194da6504eb8 (diff) | |
| download | lwn-2017e3cae0c48c4f178386538712b50549a7d9a5.tar.gz lwn-2017e3cae0c48c4f178386538712b50549a7d9a5.zip | |
Documentation: core-api: Add error pointer functions to kernel-api
Bring the error pointer functions (e.g. ERR_PTR(), PTR_ERR()) into
the docs build so that they can be cross-referenced elsewhere.
List them as kernel library functions in the kernel-api document.
Nowhere else seems to fit, and they need to go *somewhere*.
Signed-off-by: James Seo <james@equiv.tech>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230509175543.2065835-4-james@equiv.tech
| -rw-r--r-- | Documentation/core-api/kernel-api.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst index 9b3f3e5f5a95..44b96e18f8f2 100644 --- a/Documentation/core-api/kernel-api.rst +++ b/Documentation/core-api/kernel-api.rst @@ -96,6 +96,12 @@ Command-line Parsing .. kernel-doc:: lib/cmdline.c :export: +Error Pointers +-------------- + +.. kernel-doc:: include/linux/err.h + :internal: + Sorting ------- |