From: Randy Dunlap <rdunlap@infradead.org>
To: Ankit Khushwaha <ankitkhushwaha.linux@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Dongliang Mu <dzm91@hust.edu.cn>,
linux-kernel@vger.kernel.org,
linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [PATCH] docs: parse-headers.rst: Fix a typo
Date: Sat, 15 Nov 2025 11:49:23 -0800 [thread overview]
Message-ID: <ffb17faf-4c08-4327-bb2f-4c3b02dfbb4e@infradead.org> (raw)
In-Reply-To: <20251115114233.32239-1-ankitkhushwaha.linux@gmail.com>
On 11/15/25 3:42 AM, Ankit Khushwaha wrote:
> Replace "vantage" with "advantage" in the description of userspace API
> cross-references.
>
> Signed-off-by: Ankit Khushwaha <ankitkhushwaha.linux@gmail.com>
> ---
> Documentation/doc-guide/parse-headers.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/doc-guide/parse-headers.rst b/Documentation/doc-guide/parse-headers.rst
> index bd34a6d00ca9..a7bb01ff04eb 100644
> --- a/Documentation/doc-guide/parse-headers.rst
> +++ b/Documentation/doc-guide/parse-headers.rst
> @@ -5,7 +5,7 @@ Including uAPI header files
> Sometimes, it is useful to include header files and C example codes in
> order to describe the userspace API and to generate cross-references
> between the code and the documentation. Adding cross-references for
> -userspace API files has an additional vantage: Sphinx will generate warnings
> +userspace API files has an additional advantage: Sphinx will generate warnings
Yeah, I prefer "advantage," but the definition of "vantage" also fits
here IMO.
> if a symbol is not found at the documentation. That helps to keep the
> uAPI documentation in sync with the Kernel changes.
> The :ref:`parse_headers.py <parse_headers>` provides a way to generate such
> --
> 2.51.1
>
--
~Randy
next prev parent reply other threads:[~2025-11-15 19:49 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-15 11:42 [PATCH] docs: parse-headers.rst: Fix a typo Ankit Khushwaha
2025-11-15 19:49 ` Randy Dunlap [this message]
2025-11-18 16:13 ` 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=ffb17faf-4c08-4327-bb2f-4c3b02dfbb4e@infradead.org \
--to=rdunlap@infradead.org \
--cc=ankitkhushwaha.linux@gmail.com \
--cc=corbet@lwn.net \
--cc=dzm91@hust.edu.cn \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@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