Linux Power Management development
 help / color / mirror / Atom feed
From: Waqar Hameed <waqar.hameed@axis.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Sebastian Reichel <sre@kernel.org>, <kernel@axis.com>,
	<linux-pm@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>
Subject: Re: [PATCH 1/7] docs: ABI: power: rt9471: Fix invalid inline emphasis
Date: Tue, 27 Oct 2026 12:58:07 +0100	[thread overview]
Message-ID: <pndo6cftkxc.a.out@axis.com> (raw)
In-Reply-To: <4ab3e196-0326-48d9-bfdb-ede2f8cfac64@infradead.org>

On Mon, Oct 26, 2026 at 13:13 -0700 Randy Dunlap <rdunlap@infradead.org> wrote:

> On 10/26/26 6:26 AM, Waqar Hameed wrote:
>> On Sun, Oct 25, 2026 at 19:39 -0700 Randy Dunlap <rdunlap@infradead.org> wrote:
>>
>>> On 10/25/26 3:05 PM, Waqar Hameed wrote:
>>>> `docutils` warns:
>>>>
>>>>   Documentation/ABI/testing/sysfs-class-power-rt9471:1: (WARNING/2) Inline emphasis start-string without end-string.
>>>>   Documentation/ABI/testing/sysfs-class-power-rt9471:20: (WARNING/2) Inline
>>>> emphasis start-string without end-string.
>>>>
>>>> Fix this by escaping the `*`.
>>>
>>> I'm still seeing this issue after the patch is applied (same for patch 4/7).
>>> Maybe we are fighting a docutils your-version vs. my-version problem
>>> or just a moving target.
>>
>> Hm, that's weird. What output do you actually get? The '*' is escaped
>> now, so it shouldn't complain...
>>
>
> docutils still complains:
>
> Documentation/ABI/testing/sysfs-class-power-rt9467:1: WARNING: Inline emphasis start-string without end-string. [docutils]
> Documentation/ABI/testing/sysfs-class-power-rt9471:1: WARNING: Inline emphasis start-string without end-string. [docutils]
>
> and running the command that Mauro provided:
> $ ./tools/docs/get_abi.py -D Documentation/ABI/testing/ rest --enable-lineno|grep -A20 rt9467
>
> gives me:
> .. LINENO Documentation/ABI/testing/sysfs-class-power-rt9467#1
>
> .. _abi_sys_class_power_supply_rt9467_sysoff_enable:
>
> +------------------------------------------------------------+
> | **\/sys\/class\/power_supply\/rt9467\-\\*\/sysoff_enable** |
> +------------------------------------------------------------+
>
> Defined on file :ref:`sysfs-class-power-rt9467 <abi_file_testing_sysfs_class_pow
> er_rt9467>`
>
> This entry allows enabling the sysoff mode of rt9467 charger
> devices.
> If enabled and the input is removed, the internal battery FET
> is turned off to reduce the leakage from the BAT pin. See
> device datasheet for details. It's commonly used when the
> product enter shipping stage. After entering shipping mode,
> only 'VBUS' or 'Power key' pressed can make it leave this mode.
> 'Disable' also can help to leave it, but it's more like to
> abort the action before the device really enter shipping mode.
>
> Note: use /sys/class/power_supply/rt9467-*/load_switch instead.
> ---
>
> Aha. It's the line above that now needs to have the '*' character
> escaped. I have no warnings after that is done.

Ah, linux-next just got updated (merged) with the changes from
Sebastian's tree. I'll rebase the series and of course fix this one as
well!

  reply	other threads:[~2026-10-27 11:58 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-25 22:05 [PATCH 0/7] docs: ABI: power: Clean it up Waqar Hameed
2026-10-25 22:05 ` [PATCH 1/7] docs: ABI: power: rt9471: Fix invalid inline emphasis Waqar Hameed
2026-10-26  2:39   ` Randy Dunlap
2026-10-26 13:26     ` Waqar Hameed
2026-10-26 20:13       ` Randy Dunlap
2026-10-27 11:58         ` Waqar Hameed [this message]
2026-10-25 22:05 ` [PATCH 2/7] docs: ABI: power: rt9471: Add newline for paragraphs Waqar Hameed
2026-10-26  2:29   ` Randy Dunlap
2026-10-26 13:30     ` Waqar Hameed
2026-10-25 22:05 ` [PATCH 4/7] docs: ABI: power: rt9467: Fix invalid inline emphasis Waqar Hameed
2026-10-25 22:05 ` [PATCH 3/7] docs: ABI: power: rt9471: Fix mismatched quote Waqar Hameed
2026-10-26  2:35   ` Randy Dunlap
2026-10-25 22:05 ` [PATCH 5/7] docs: ABI: power: rt9467: Add newline for paragraphs Waqar Hameed
2026-10-25 22:05 ` [PATCH 6/7] docs: ABI: power: rt9467: Fix mismatched quote Waqar Hameed
2026-10-26  2:34   ` Randy Dunlap
2026-10-25 22:05 ` [PATCH 7/7] docs: ABI: power: rt9756: Fix invalid inline emphasis Waqar Hameed

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=pndo6cftkxc.a.out@axis.com \
    --to=waqar.hameed@axis.com \
    --cc=kernel@axis.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=sre@kernel.org \
    /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