From: Hans de Goede <hdegoede@redhat.com>
To: Jonathan Corbet <corbet@lwn.net>,
Stephen Rothwell <sfr@canb.auug.org.au>,
Vadim Pasternak <vadimp@nvidia.com>
Cc: Mark Gross <markgross@kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Next Mailing List <linux-next@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: linux-next: build warnings after merge of the drivers-x86 tree
Date: Fri, 22 Oct 2021 11:02:50 +0200 [thread overview]
Message-ID: <17e828ee-7338-e34e-db10-8af10d705a88@redhat.com> (raw)
In-Reply-To: <87lf2mjd8b.fsf@meer.lwn.net>
Hi,
On 10/21/21 23:10, Jonathan Corbet wrote:
> [CC += Mauro]
>
> Stephen Rothwell <sfr@canb.auug.org.au> writes:
>
>> On Thu, 21 Oct 2021 09:07:03 +0000 Vadim Pasternak <vadimp@nvidia.com> wrote:
>>>
>>> What is wrong with the syntax at line 230 and where blank line is expected?
>>>
>>> What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/bios_active_image
>>> What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/bios_auth_fail
>>> What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/bios_upgrade_fail
>>> Date: October 2021 <--- this is line 230
>>> KernelVersion: 5.16
>>
>> I am sorry, I don't know. Added Jon to cc for advice.
>
> The problem isn't that line at all, it's the use of a bulleted list a
> few lines further down; that doesn't work in ABI files.
>
> Mauro, this ABI stuff is fragile, and this kind of problem occurs fairly
> often. How hard would it be to (1) make it a bit more robust, (2) make
> it issue useful warnings where it can't be robust, and (3) properly
> document the restrictions for ABI files?
>
> Meanwhile, the attached patch fixes it; feel free to use it or to just
> fold the change into your work.
Thank you. I've added the fix (as is) to my platform-drivers-x86/review-hans
branch. Once the lkp kernel test robot has done a successful build of that
branch (it also contains some other new patches) I'll push this to for-next
resolving these warnings.
Regards,
Hans
> -----------------------------
> From 97371e6afda75eef71b7d5d1794645e5cfaf1811 Mon Sep 17 00:00:00 2001
> From: Jonathan Corbet <corbet@lwn.net>
> Date: Thu, 21 Oct 2021 15:02:43 -0600
> Subject: [PATCH] docs: ABI: fix documentation warning in sysfs-driver-mlxreg-io
>
> The use of a Sphinx list within this ABI file caused the following warning:
>
> Documentation/ABI/stable/sysfs-driver-mlxreg-io:230: WARNING: Unexpected indentation.
> Documentation/ABI/stable/sysfs-driver-mlxreg-io:230: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Remove the bullets to make the warning go away and get proper formatting.
>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
> .../ABI/stable/sysfs-driver-mlxreg-io | 23 +++++++++++--------
> 1 file changed, 13 insertions(+), 10 deletions(-)
>
> diff --git a/Documentation/ABI/stable/sysfs-driver-mlxreg-io b/Documentation/ABI/stable/sysfs-driver-mlxreg-io
> index c84795ccecad..12c3f895cd2f 100644
> --- a/Documentation/ABI/stable/sysfs-driver-mlxreg-io
> +++ b/Documentation/ABI/stable/sysfs-driver-mlxreg-io
> @@ -231,16 +231,19 @@ Date: October 2021
> KernelVersion: 5.16
> Contact: Vadim Pasternak <vadimp@nvidia.com>
> Description: The files represent BIOS statuses:
> - - bios_active_image: location of current active BIOS image:
> - 0: Top, 1: Bottom.
> - The reported value should correspond to value expected by OS
> - in case of BIOS safe mode is 0. This bit is related to Intel
> - top-swap feature of DualBios on the same flash.
> - - bios_auth_fail: BIOS upgrade is failed because provided BIOS
> - image is not signed correctly.
> - - bios_upgrade_fail: BIOS upgrade is failed by some other
> - reason not because authentication. For example due to
> - physical SPI flash problem.
> +
> + bios_active_image: location of current active BIOS image:
> + 0: Top, 1: Bottom.
> + The reported value should correspond to value expected by OS
> + in case of BIOS safe mode is 0. This bit is related to Intel
> + top-swap feature of DualBios on the same flash.
> +
> + bios_auth_fail: BIOS upgrade is failed because provided BIOS
> + image is not signed correctly.
> +
> + bios_upgrade_fail: BIOS upgrade is failed by some other
> + reason not because authentication. For example due to
> + physical SPI flash problem.
>
> The files are read only.
>
>
next prev parent reply other threads:[~2021-10-22 9:02 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-21 7:47 linux-next: build warnings after merge of the drivers-x86 tree Stephen Rothwell
2021-10-21 9:07 ` Vadim Pasternak
2021-10-21 20:04 ` Stephen Rothwell
2021-10-21 21:10 ` Jonathan Corbet
2021-10-22 9:02 ` Hans de Goede [this message]
2021-10-21 9:14 ` Hans de Goede
2021-10-21 20:02 ` Stephen Rothwell
-- strict thread matches above, loose matches on Subject: below --
2023-12-22 2:54 Stephen Rothwell
2023-12-22 14:10 ` Hans de Goede
2023-03-09 1:28 Stephen Rothwell
2023-03-09 8:48 ` Hans de Goede
2023-03-09 10:40 ` Orlando Chamberlain
2022-03-01 9:16 Stephen Rothwell
2022-03-01 13:53 ` Hans de Goede
2022-03-24 7:33 ` Stephen Rothwell
2022-03-24 7:39 ` Hans de Goede
2022-03-24 11:22 ` Stephen Rothwell
2022-03-24 13:01 ` Hans de Goede
2022-03-24 13:04 ` Hans de Goede
2022-03-24 21:55 ` Stephen Rothwell
2022-03-25 5:27 ` Mauro Carvalho Chehab
2022-03-25 6:18 ` Mauro Carvalho Chehab
2020-11-05 6:55 Stephen Rothwell
2011-02-22 5:13 Stephen Rothwell
2011-02-22 10:36 ` Colin Ian King
2010-12-08 2:32 Stephen Rothwell
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=17e828ee-7338-e34e-db10-8af10d705a88@redhat.com \
--to=hdegoede@redhat.com \
--cc=corbet@lwn.net \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=markgross@kernel.org \
--cc=mchehab@kernel.org \
--cc=sfr@canb.auug.org.au \
--cc=vadimp@nvidia.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).