linux-kernel - Re: [PATCH] Documentation: kunit: eliminate code-block warnings

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: <4c403239-3c71-4ab9-2168-f7e9d77008b2@infradead.org>
Date:   Sat, 25 Jun 2022 08:12:00 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org
Cc:     Brendan Higgins <brendanhiggins@...gle.com>,
        linux-kselftest@...r.kernel.org, kunit-dev@...glegroups.com,
        linux-doc@...r.kernel.org, Harinder Singh <sharinder@...gle.com>,
        Tim Bird <tim.bird@...y.com>
Subject: Re: [PATCH] Documentation: kunit: eliminate code-block warnings



On 6/24/22 12:27, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@...radead.org> writes:
> 
>> Fix Sphinx complaints about code-block directive missing an argument.
>> For start.rst, add "none" since that is already heavily used in that
>> file. For run_wrapper.rst, use the simpler "::" literal block instead.
> 
> [Sorry that this fell through the cracks; I'm never quite sure who is
> going to handle kunit patches]
> 
>> dev-tools/kunit/start.rst:83: WARNING: Error in "code-block" directive:
>> 1 argument(s) required, 0 supplied.
>>
>> dev-tools/kunit/run_wrapper.rst:17: WARNING: Error in "code-block" directive:
>> 1 argument(s) required, 0 supplied.
> 
> So which version of Sphinx are you using?  The language argument became
> optional in 2.0, so you'd need to be running something pretty ancient to
> see this.
> 
> Ah, I see 1.8.5 in your later message...how wedded are you to that
> version?

It's what ships with OpenSuse Leap 15.3, which I have been using for quite
a long time.

I see that there is now OpenSuse Leap 15.4, so I could upgrade to that,
but I don't know what version on Sphinx it uses.

> Ostensibly we support back to 1.7, so I guess we should stick by its
> rules.  But the better solution, I think, is to raise our minimum
> version; I think I'll look into that shortly.
> 

>>  
>>  Run command:
>>  
>> -.. code-block::
>> +::
> 
> A much nicer fix for these would have been just:
> 
>   Run command::

Yeah, that is nicer.

> 
> Oh well, I've applied it.

thanks.

-- 
~Randy