All of lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Jonathan Corbet <corbet@lwn.net>, linux-kernel@vger.kernel.org
Cc: Brendan Higgins <brendanhiggins@google.com>,
	linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com,
	linux-doc@vger.kernel.org, Harinder Singh <sharinder@google.com>,
	Tim Bird <tim.bird@sony.com>
Subject: Re: [PATCH] Documentation: kunit: eliminate code-block warnings
Date: Sat, 25 Jun 2022 08:12:00 -0700	[thread overview]
Message-ID: <4c403239-3c71-4ab9-2168-f7e9d77008b2@infradead.org> (raw)
In-Reply-To: <87fsjt50c8.fsf@meer.lwn.net>



On 6/24/22 12:27, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.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

  reply	other threads:[~2022-06-25 15:12 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-01  2:47 [PATCH] Documentation: kunit: eliminate code-block warnings Randy Dunlap
2022-04-01  6:26 ` David Gow
2022-04-02  6:24   ` Randy Dunlap
2022-06-19 23:56 ` Randy Dunlap
2022-06-24 19:27 ` Jonathan Corbet
2022-06-25 15:12   ` Randy Dunlap [this message]
2022-06-28  7:17     ` Mauro Carvalho Chehab
2022-06-28 14:20       ` Randy Dunlap

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=4c403239-3c71-4ab9-2168-f7e9d77008b2@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=brendanhiggins@google.com \
    --cc=corbet@lwn.net \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=sharinder@google.com \
    --cc=tim.bird@sony.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.