diff options
| author | Ankit Khushwaha <ankitkhushwaha.linux@gmail.com> | 2025-11-15 17:12:33 +0530 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-11-18 09:13:40 -0700 |
| commit | 6ae0f2072768fb3db7846cee08b611a96310930d (patch) | |
| tree | 7e4a90677b00c7b2911ae9706b1d460df274c8da | |
| parent | 46a47693e109f49483391bc66ad5f0ed53a1857a (diff) | |
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@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251115114233.32239-1-ankitkhushwaha.linux@gmail.com>
| -rw-r--r-- | Documentation/doc-guide/parse-headers.rst | 2 |
1 files changed, 1 insertions, 1 deletions
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 |