All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: James Seo <james@equiv.tech>,
	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: Re: [PATCH 0/3] Generate documentation for error pointer functions
Date: Fri, 19 May 2023 09:13:35 -0600	[thread overview]
Message-ID: <877ct4nylc.fsf@meer.lwn.net> (raw)
In-Reply-To: <20230509175543.2065835-1-james@equiv.tech>

James Seo <james@equiv.tech> 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

      parent reply	other threads:[~2023-05-19 15:13 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 ` [PATCH 3/3] Documentation: core-api: Add error pointer functions to kernel-api James Seo
2023-05-19 15:13 ` Jonathan Corbet [this message]

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=877ct4nylc.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=akpm@linux-foundation.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=james@equiv.tech \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.