linux-kernel - Re: [PATCH v2] docs-rst: doc-guide: Minor grammar fixes

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20190114074233.GA1973@rapoport-lnx>
Date:   Mon, 14 Jan 2019 09:42:34 +0200
From:   Mike Rapoport <rppt@...ux.ibm.com>
To:     Joel Nider <joeln@...ibm.com>
Cc:     Jonathan Corbet <corbet@....net>,
        Matthew Wilcox <willy@...radead.org>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] docs-rst: doc-guide: Minor grammar fixes

On Mon, Jan 14, 2019 at 09:14:59AM +0200, Joel Nider wrote:
> While using this guide to learn the new documentation method, I saw
> a few phrases that I felt could be improved. These small changes
> improve the grammar and choice of words to further enhance the
> installation instructions.
> 
> Signed-off-by: Joel Nider <joeln@...ibm.com>
> Acked-by: Matthew Wilcox <willy@...radead.org>

Acked-by: Mike Rapoport <rppt@...ux.ibm.com>

> ---
> v2: address Matthew's comment
> 
>  Documentation/doc-guide/sphinx.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index 02605ee..c039224 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -27,8 +27,8 @@ Sphinx Install
>  ==============
>  
>  The ReST markups currently used by the Documentation/ files are meant to be
> -built with ``Sphinx`` version 1.3 or upper. If you're desiring to build
> -PDF outputs, it is recommended to use version 1.4.6 or upper.
> +built with ``Sphinx`` version 1.3 or higher. If you desire to build
> +PDF output, it is recommended to use version 1.4.6 or higher.
>  
>  There's a script that checks for the Sphinx requirements. Please see
>  :ref:`sphinx-pre-install` for further details.
> @@ -37,15 +37,15 @@ Most distributions are shipped with Sphinx, but its toolchain is fragile,
>  and it is not uncommon that upgrading it or some other Python packages
>  on your machine would cause the documentation build to break.
>  
> -A way to get rid of that is to use a different version than the one shipped
> -on your distributions. In order to do that, it is recommended to install
> +A way to avoid that is to use a different version than the one shipped
> +with your distributions. In order to do so, it is recommended to install
>  Sphinx inside a virtual environment, using ``virtualenv-3``
>  or ``virtualenv``, depending on how your distribution packaged Python 3.
>  
>  .. note::
>  
>     #) Sphinx versions below 1.5 don't work properly with Python's
> -      docutils version 0.13.1 or upper. So, if you're willing to use
> +      docutils version 0.13.1 or higher. So, if you're willing to use
>        those versions, you should run ``pip install 'docutils==0.12'``.
>  
>     #) It is recommended to use the RTD theme for html output. Depending
> @@ -82,7 +82,7 @@ output.
>  PDF and LaTeX builds
>  --------------------
>  
> -Such builds are currently supported only with Sphinx versions 1.4 and upper.
> +Such builds are currently supported only with Sphinx versions 1.4 and higher.
>  
>  For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265.
>  
> -- 
> 2.7.4
> 

-- 
Sincerely yours,
Mike.