mirror of
https://github.com/torvalds/linux
synced 2024-10-07 03:42:55 +00:00
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
This commit is contained in:
parent
185ea7676e
commit
40be2369dc
|
@ -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
|
||||
|
|
|
@ -144,8 +144,8 @@ Bison
|
|||
Since Linux 4.16, the build system generates parsers
|
||||
during build. This requires bison 2.0 or later.
|
||||
|
||||
pahole:
|
||||
-------
|
||||
pahole
|
||||
------
|
||||
|
||||
Since Linux 5.2, if CONFIG_DEBUG_INFO_BTF is selected, the build system
|
||||
generates BTF (BPF Type Format) from DWARF in vmlinux, a bit later from kernel
|
||||
|
|
|
@ -351,8 +351,8 @@ Managing bug reports
|
|||
--------------------
|
||||
|
||||
One of the best ways to put into practice your hacking skills is by fixing
|
||||
bugs reported by other people. Not only you will help to make the kernel
|
||||
more stable, but you'll also learn to fix real world problems and you will
|
||||
bugs reported by other people. Not only will you help to make the kernel
|
||||
more stable, but you'll also learn to fix real-world problems and you will
|
||||
improve your skills, and other developers will be aware of your presence.
|
||||
Fixing bugs is one of the best ways to get merits among other developers,
|
||||
because not many people like wasting time fixing other people's bugs.
|
||||
|
|
Loading…
Reference in a new issue