diff options
| author | Maki Hatano <maki.y.hatano@gmail.com> | 2024-03-23 07:21:12 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2024-04-02 18:07:51 +0200 |
| commit | 23bfb947eb0ae29aaf2882b19208f5af6033a429 (patch) | |
| tree | 8e7d68e9d0ab05520c99ebe012eaf7471a65f8ba /Documentation/doc-guide | |
| parent | scripts: sphinx-pre-install: Add pyyaml hint to other distros (diff) | |
| download | linux-23bfb947eb0ae29aaf2882b19208f5af6033a429.tar.xz linux-23bfb947eb0ae29aaf2882b19208f5af6033a429.zip | |
doc: fix spelling about ReStructured Text
- ReStructured Text should be exactly reStructuredText
- "reStructuredText" is ONE word, not two! according to https://docutils.sourceforge.io/rst.html
Signed-off-by: Maki Hatano <Maki.Y.Hatano@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240323062141.14863-1-Maki.Y.Hatano@gmail.com
Diffstat (limited to 'Documentation/doc-guide')
| -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 5da0046f7059..204b025f1349 100644 --- a/Documentation/doc-guide/parse-headers.rst +++ b/Documentation/doc-guide/parse-headers.rst @@ -61,7 +61,7 @@ DESCRIPTION *********** -Convert a C header or source file (C_FILE), into a ReStructured Text +Convert a C header or source file (C_FILE), into a reStructuredText included via ..parsed-literal block with cross-references for the documentation files that describe the API. It accepts an optional EXCEPTIONS_FILE with describes what elements will be either ignored or |