Re: [PATCH] docs: parse-headers.rst: Fix a typo
From: Randy Dunlap
Date: Sat Nov 15 2025 - 14:49:26 EST
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@xxxxxxxxx>
> ---
> 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