linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Madhumitha Prabakaran <madhumithabiw@gmail.com>,
	rafael@kernel.org, lenb@kernel.org, linux-acpi@vger.kernel.org,
	linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
	Linux Documentation <linux-doc@vger.kernel.org>
Cc: ivan.orlov0322@gmail.com
Subject: Re: [PATCH] docs: Fix warning:Error in "code-block" directive
Date: Sat, 3 Jun 2023 08:20:44 +0700	[thread overview]
Message-ID: <ZHqVbIouMkvM4OAs@debian.me> (raw)
In-Reply-To: <20230602215102.GA220958@madhu-kernel>

[-- Attachment #1: Type: text/plain, Size: 778 bytes --]

On Fri, Jun 02, 2023 at 04:51:02PM -0500, Madhumitha Prabakaran wrote:
> Fix the error in "code-block" directive by providing the
> argument as "text".
> 
> <snipped> ...
>  Result code:
>  ------------
>  
> -.. code-block::
> +.. code-block:: text

Nope.

I don't see error you mention in this patch when making htmldocs on my
computer (my setup is pretty standard: see
Documentation/doc-guide/sphinx.rst). This patch is unneccessary, though,
unless you have code snippets in some language (e.g. C, where passing
language name to code-block:: syntax-highlight it). Result code outputs,
on the other hand, are generic text with no definitive syntax, hence
you can omit language name.

Thanks.

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

       reply	other threads:[~2023-06-03  1:20 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20230602215102.GA220958@madhu-kernel>
2023-06-03  1:20 ` Bagas Sanjaya [this message]
2023-06-03  1:41   ` [PATCH] docs: Fix warning:Error in "code-block" directive Randy Dunlap
2023-06-03  4:04     ` Akira Yokosawa
     [not found]       ` <CAPNSgDiZiv6VJcX66DaQjHkLjd3ZxhkBcXzo7UU5LUD2hCx9Sw@mail.gmail.com>
2023-06-03 22:55         ` Fwd: " Madhumitha Prabakaran

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZHqVbIouMkvM4OAs@debian.me \
    --to=bagasdotme@gmail.com \
    --cc=ivan.orlov0322@gmail.com \
    --cc=lenb@kernel.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=madhumithabiw@gmail.com \
    --cc=rafael@kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).