[<prev] [next>] [day] [month] [year] [list]
Message-ID: <20251115114233.32239-1-ankitkhushwaha.linux@gmail.com>
Date: Sat, 15 Nov 2025 17:12:33 +0530
From: Ankit Khushwaha <ankitkhushwaha.linux@...il.com>
To: Jonathan Corbet <corbet@....net>,
linux-doc@...r.kernel.org,
Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Randy Dunlap <rdunlap@...radead.org>,
Dongliang Mu <dzm91@...t.edu.cn>,
linux-kernel@...r.kernel.org,
linux-kernel-mentees@...ts.linuxfoundation.org,
Ankit Khushwaha <ankitkhushwaha.linux@...il.com>
Subject: [PATCH] docs: parse-headers.rst: Fix a typo
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
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
Powered by blists - more mailing lists