linux-kernel - Re: [PATCH] docs: Fix warning:Error in "code-block" directive

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: Windows password security audit tool. GUI, reports in PDF.

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

Date:   Sat, 3 Jun 2023 13:04:04 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     rdunlap@...radead.org
Cc:     bagasdotme@...il.com, ivan.orlov0322@...il.com, lenb@...nel.org,
        linux-acpi@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, madhumithabiw@...il.com,
        rafael@...nel.org, skhan@...uxfoundation.org,
        Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH] docs: Fix warning:Error in "code-block" directive

On Fri, 2 Jun 2023 18:41:46 -0700, Randy Dunlap wrote:
> 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.

Right.

In Sphinx changelog, "Features added" for 2.0.0b1 [1] lists this:

    #1851: Allow to omit an argument for code-block directive. If omitted,
    it follows highlight or highlight_language

[1]: https://www.sphinx-doc.org/en/master/changes.html#id1306

Pre-2.0 Sphinx is now deprecated.
See commit 31abfdda6527 ("docs: Deprecate use of Sphinx < 2.4.x").

        Thanks, Akira    

> 
> -- 
> ~Randy