From: James Seo <james@equiv.tech>
To: Jonathan Corbet <corbet@lwn.net>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Andrew Morton <akpm@linux-foundation.org>
Cc: James Seo <james@equiv.tech>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 3/3] Documentation: core-api: Add error pointer functions to kernel-api
Date: Tue, 9 May 2023 10:55:48 -0700 [thread overview]
Message-ID: <20230509175543.2065835-4-james@equiv.tech> (raw)
In-Reply-To: <20230509175543.2065835-1-james@equiv.tech>
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>
---
Documentation/core-api/kernel-api.rst | 6 ++++++
1 file changed, 6 insertions(+)
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
-------
--
2.34.1
next prev parent reply other threads:[~2023-05-09 17:59 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-09 17:55 [PATCH 0/3] Generate documentation for error pointer functions James Seo
2023-05-09 17:55 ` [PATCH 1/3] Documentation: conf.py: Add __force to c_id_attributes James Seo
2023-05-09 17:55 ` [PATCH 2/3] err.h: Add missing kerneldocs for error pointer functions James Seo
2023-05-09 17:55 ` James Seo [this message]
2023-05-19 15:13 ` [PATCH 0/3] Generate documentation " Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230509175543.2065835-4-james@equiv.tech \
--to=james@equiv.tech \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).