linux-kernel - Re: [PATCH] sphinx.rst: Add note about code snippets embedded in the text

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: <87ftofxmlj.fsf@intel.com>
Date:   Wed, 12 Jun 2019 10:57:12 +0300
From:   Jani Nikula <jani.nikula@...ux.intel.com>
To:     André Almeida <andrealmeid@...labora.com>,
        linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, corbet@....net, kernel@...labora.com,
        André Almeida <andrealmeid@...labora.com>
Subject: Re: [PATCH] sphinx.rst: Add note about code snippets embedded in the text

On Tue, 11 Jun 2019, André Almeida <andrealmeid@...labora.com> wrote:
> There's a paragraph that explains how to create fixed width text block,
> but it doesn't explains how to create fixed width text inline, although
> this feature is really used through the documentation. Fix that adding a
> quick note about it.

I don't mind this addition, it's simple enough, but in general I think
we should reference the Sphinx and reStructuredText documentation,
whichever is more applicable, instead of duplicating the
documentation. The idea is that this document describes how to use them
in kernel. Contrast with coding style and language reference.

BR,
Jani.


>
> Signed-off-by: André Almeida <andrealmeid@...labora.com>
> ---
>  Documentation/doc-guide/sphinx.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index c039224b404e..f48abc07f4c5 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -218,7 +218,7 @@ Here are some specific guidelines for the kernel documentation:
>    examples, etc.), use ``::`` for anything that doesn't really benefit
>    from syntax highlighting, especially short snippets. Use
>    ``.. code-block:: <language>`` for longer code blocks that benefit
> -  from highlighting.
> +  from highlighting. For a short snippet of code embedded in the text, use \`\`.
>  
>  
>  the C domain

-- 
Jani Nikula, Intel Open Source Graphics Center