diff options
author | Maki Hatano <maki.y.hatano@gmail.com> | 2024-03-23 09:21:12 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2024-04-02 19:07:51 +0300 |
commit | 23bfb947eb0ae29aaf2882b19208f5af6033a429 (patch) | |
tree | 8e7d68e9d0ab05520c99ebe012eaf7471a65f8ba /Documentation | |
parent | 1cbd16e3c125f34bef481ea048ec59bf24f1cbf4 (diff) | |
download | linux-23bfb947eb0ae29aaf2882b19208f5af6033a429.tar.xz |
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')
-rw-r--r-- | Documentation/doc-guide/parse-headers.rst | 2 | ||||
-rw-r--r-- | Documentation/index.rst | 2 | ||||
-rw-r--r-- | Documentation/translations/it_IT/index.rst | 2 |
3 files changed, 3 insertions, 3 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 diff --git a/Documentation/index.rst b/Documentation/index.rst index 5298611e00ee..f9f525f4c0dd 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -107,7 +107,7 @@ Other documentation There are several unsorted documents that don't seem to fit on other parts of the documentation body, or may require some adjustments and/or conversion -to ReStructured Text format, or are simply too old. +to reStructuredText format, or are simply too old. .. toctree:: :maxdepth: 1 diff --git a/Documentation/translations/it_IT/index.rst b/Documentation/translations/it_IT/index.rst index 70ccd23b2cde..9220f65e30d1 100644 --- a/Documentation/translations/it_IT/index.rst +++ b/Documentation/translations/it_IT/index.rst @@ -132,4 +132,4 @@ Documentazione varia Ci sono documenti che sono difficili da inserire nell'attuale organizzazione della documentazione; altri hanno bisogno di essere migliorati e/o convertiti -nel formato *ReStructured Text*; altri sono semplicamente troppo vecchi. +nel formato *reStructuredText*; altri sono semplicamente troppo vecchi. |