Re: [PATCH] sphinx.rst: Add note about code snippets embedded in the text
From: Jani Nikula
Date: Wed Jun 12 2019 - 03:58:50 EST
On Tue, 11 Jun 2019, AndrÃ Almeida <andrealmeid@xxxxxxxxxxxxx> 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.
> Signed-off-by: AndrÃ Almeida <andrealmeid@xxxxxxxxxxxxx>
> 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