linux-kernel - Re: [PATCH] docs: parse-headers.rst: Fix a typo

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <ffb17faf-4c08-4327-bb2f-4c3b02dfbb4e@infradead.org>
Date: Sat, 15 Nov 2025 11:49:23 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Ankit Khushwaha <ankitkhushwaha.linux@...il.com>,
 Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
 Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Dongliang Mu <dzm91@...t.edu.cn>, linux-kernel@...r.kernel.org,
 linux-kernel-mentees@...ts.linuxfoundation.org
Subject: Re: [PATCH] docs: parse-headers.rst: Fix a typo



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@...il.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