2024-02-04 13:39:07

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: [PATCH] Documentation: multiple .rst files: Fix grammar and more consistent formatting

On Sat, Feb 03, 2024 at 10:53:45PM +0100, Thorsten Blum wrote:
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index 3d125fb4139d..2526811489bf 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 on 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
> diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> index 50b3d1cb1115..4c1552160321 100644
> --- a/Documentation/process/changes.rst
> +++ b/Documentation/process/changes.rst
> @@ -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
> diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst
> index 6c73889c98fc..eebda4910a88 100644
> --- a/Documentation/process/howto.rst
> +++ b/Documentation/process/howto.rst
> @@ -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.

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <[email protected]>

--
An old man doll... just what I always wanted! - Clara


Attachments:
(No filename) (2.98 kB)
signature.asc (235.00 B)
Download all attachments