diff options
| author | Thorsten Blum <thorsten.blum@toblux.com> | 2024-02-05 01:01:17 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2024-02-05 10:24:54 -0700 |
| commit | 40be2369dc0ee803b2bacf32471472604a948b88 (patch) | |
| tree | f3d40a10d79668be9dcb5948820848a82cf50886 /Documentation/doc-guide | |
| parent | 185ea7676ef3220de1ee90f288df3601f83afda0 (diff) | |
| download | linux-stable-40be2369dc0ee803b2bacf32471472604a948b88.tar.gz linux-stable-40be2369dc0ee803b2bacf32471472604a948b88.tar.bz2 linux-stable-40be2369dc0ee803b2bacf32471472604a948b88.zip | |
Documentation: multiple .rst files: Fix grammar and more consistent formatting
sphinx.rst:
- Remove unnecessary newline
- Fix grammar s/on/in/
- Fix grammar s/check/checks/
- Capitalize heading "The C domain"
changes.rst:
- Remove colon after "pahole" to be consistent with other entries
howto.rst:
- Fix grammar s/you will/will you/
- Hyphenate "real-world problems"
Signed-off-by: Thorsten Blum <thorsten.blum@toblux.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240205000117.3285-1-thorsten.blum@toblux.com
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/sphinx.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index 3d125fb4139d..709e19821a16 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -63,8 +63,7 @@ Image output ------------ The kernel documentation build system contains an extension that -handles images on both GraphViz and SVG formats (see -:ref:`sphinx_kfigure`). +handles images in both GraphViz and SVG formats (see :ref:`sphinx_kfigure`). For it to work, you need to install both GraphViz and ImageMagick packages. If those packages are not installed, the build system will @@ -108,7 +107,7 @@ further info. Checking for Sphinx dependencies -------------------------------- -There's a script that automatically check for Sphinx dependencies. If it can +There's a script that automatically checks for Sphinx dependencies. If it can recognize your distribution, it will also give a hint about the install command line options for your distro:: @@ -283,7 +282,7 @@ Here are some specific guidelines for the kernel documentation: from highlighting. For a short snippet of code embedded in the text, use \`\`. -the C domain +The C domain ------------ The **Sphinx C Domain** (name c) is suited for documentation of C API. E.g. a |