From: Randy Dunlap <rdunlap@infradead.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>,
Pavel Pisa <pisa@fel.cvut.cz>,
Luis Felipe Hernandez <luis.hernandez093@gmail.com>
Cc: corbet@lwn.net, alexandre.belloni@bootlin.com,
ondrej.ille@gmail.com, mkl@pengutronix.de,
James.Bottomley@hansenpartnership.com,
martin.petersen@oracle.com, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
"Martin Jeřábek" <martin.jerabek01@gmail.com>,
"Jiří Novák" <jnovak@fel.cvut.cz>
Subject: Re: [PATCH] docs: Fix kernel-doc indentation errors in multiple drivers
Date: Sun, 6 Jul 2025 17:47:25 -0700 [thread overview]
Message-ID: <ebc84c4b-4238-4e56-a23c-2d5de535b3b0@infradead.org> (raw)
In-Reply-To: <aGsW36iFMyp4ojdf@archie.me>
On 7/6/25 5:37 PM, Bagas Sanjaya wrote:
> On Sat, Jul 05, 2025 at 02:36:45PM -0700, Randy Dunlap wrote:
>> It needs something to turn True and False into a bullet list
>> (non-numbered), as documented in Documentation/doc-guide/kernel-doc.rst:
>>
>> So, in order to produce the desired line breaks, you need to use a
>> ReST list, e. g.::
>>
>> * Return:
>> * * %0 - OK to runtime suspend the device
>> * * %-EBUSY - Device should not be runtime suspended
>>
>>
>>
>> I don't see any of these kernel-doc warnings. I would guess that
>> either Pavel or I am using some older/newer version of whatever
>> software is causing this.
>>
>
> I think Sphinx reported these warnings on docs-next tree.
>
> Thanks.
>
I would hope and think that the docs-next tree is in linux-next and I
tested on linux-next.
But I probably don't know what is going on...
--
~Randy
next prev parent reply other threads:[~2025-07-07 0:47 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-03 2:35 Luis Felipe Hernandez
2025-07-05 19:23 ` Pavel Pisa
2025-07-05 21:36 ` Randy Dunlap
2025-07-05 21:45 ` Randy Dunlap
2025-07-15 0:20 ` Bagas Sanjaya
2025-07-07 0:37 ` Bagas Sanjaya
2025-07-07 0:47 ` Randy Dunlap [this message]
2025-07-07 13:43 ` Felipe Hernandez
2025-07-20 0:14 ` 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=ebc84c4b-4238-4e56-a23c-2d5de535b3b0@infradead.org \
--to=rdunlap@infradead.org \
--cc=James.Bottomley@hansenpartnership.com \
--cc=alexandre.belloni@bootlin.com \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=jnovak@fel.cvut.cz \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luis.hernandez093@gmail.com \
--cc=martin.jerabek01@gmail.com \
--cc=martin.petersen@oracle.com \
--cc=mkl@pengutronix.de \
--cc=ondrej.ille@gmail.com \
--cc=pisa@fel.cvut.cz \
/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
all inboxes | Powered by JetHome®