Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <e69410c1-8632-354e-e6e0-ac16631f0566@infradead.org>
Date:   Fri, 2 Jun 2023 18:41:46 -0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.11.0
Subject: Re: [PATCH] docs: Fix warning:Error in "code-block" directive
Content-Language: en-US
To:     Bagas Sanjaya <bagasdotme@gmail.com>,
        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
References: <20230602215102.GA220958@madhu-kernel>
 <ZHqVbIouMkvM4OAs@debian.me>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <ZHqVbIouMkvM4OAs@debian.me>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk


On 6/2/23 18:20, Bagas Sanjaya wrote:
> 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.


I also don't see any such warnings so I don't see a need for this patch.
My wild guess is that some older version of Sphinx was being used.

-- 
~Randy