]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
Documentation: core-api: Add error pointer functions to kernel-api
authorJames Seo <james@equiv.tech>
Tue, 9 May 2023 17:55:48 +0000 (10:55 -0700)
committerJonathan Corbet <corbet@lwn.net>
Fri, 19 May 2023 14:58:11 +0000 (08:58 -0600)
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
Documentation/core-api/kernel-api.rst

index 9b3f3e5f5a9599bb2a8b044935adce7a0048880f..44b96e18f8f2d721be691e13f59b4d3f6e170b33 100644 (file)
@@ -96,6 +96,12 @@ Command-line Parsing
 .. kernel-doc:: lib/cmdline.c
    :export:
 
+Error Pointers
+--------------
+
+.. kernel-doc:: include/linux/err.h
+   :internal:
+
 Sorting
 -------