* linux-next: build warnings after merge of the drivers-x86 tree
@ 2011-02-22 5:13 Stephen Rothwell
2011-02-22 10:36 ` Colin Ian King
0 siblings, 1 reply; 26+ messages in thread
From: Stephen Rothwell @ 2011-02-22 5:13 UTC (permalink / raw)
To: Matthew Garrett; +Cc: linux-next, linux-kernel, Colin Ian King
[-- Attachment #1: Type: text/plain, Size: 791 bytes --]
Hi Matthew,
After merging the drivers-x86 tree, today's linux-next build (x86_64
allmodconfig) produced these warning:
drivers/platform/x86/dell-wmi-aio.c:29:1: warning: "pr_fmt" redefined
In file included from include/linux/kernel.h:20,
from drivers/platform/x86/dell-wmi-aio.c:19:
include/linux/printk.h:145:1: warning: this is the location of the previous definition
drivers/platform/x86/dell-wmi-aio.c: In function 'dell_wmi_aio_find':
drivers/platform/x86/dell-wmi-aio.c:130: warning: return discards qualifiers from pointer target type
Caused by commit 2ef3d3fdc94c0ef481c60b7958785f05a0faf2ec ("Enable Dell
All-In-One volume up/down keys").
--
Cheers,
Stephen Rothwell sfr@canb.auug.org.au
http://www.canb.auug.org.au/~sfr/
[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2011-02-22 5:13 linux-next: build warnings after merge of the drivers-x86 tree Stephen Rothwell
@ 2011-02-22 10:36 ` Colin Ian King
0 siblings, 0 replies; 26+ messages in thread
From: Colin Ian King @ 2011-02-22 10:36 UTC (permalink / raw)
To: Stephen Rothwell; +Cc: Matthew Garrett, linux-next, linux-kernel
[-- Attachment #1: Type: text/plain, Size: 810 bytes --]
Apologies,
My fail. Attached is correct version.
On Tue, 2011-02-22 at 16:13 +1100, Stephen Rothwell wrote:
> Hi Matthew,
>
> After merging the drivers-x86 tree, today's linux-next build (x86_64
> allmodconfig) produced these warning:
>
> drivers/platform/x86/dell-wmi-aio.c:29:1: warning: "pr_fmt" redefined
> In file included from include/linux/kernel.h:20,
> from drivers/platform/x86/dell-wmi-aio.c:19:
> include/linux/printk.h:145:1: warning: this is the location of the previous definition
> drivers/platform/x86/dell-wmi-aio.c: In function 'dell_wmi_aio_find':
> drivers/platform/x86/dell-wmi-aio.c:130: warning: return discards qualifiers from pointer target type
>
> Caused by commit 2ef3d3fdc94c0ef481c60b7958785f05a0faf2ec ("Enable Dell
> All-In-One volume up/down keys").
>
[-- Attachment #2: 0001-Enable-Dell-All-In-One-volume-up-down-keys.patch --]
[-- Type: text/x-patch, Size: 6943 bytes --]
>From ec236d3da33c28a458bbbccb4520245d08ba23c4 Mon Sep 17 00:00:00 2001
From: Colin Ian King <colin.king@canonical.com>
Date: Tue, 22 Feb 2011 10:21:20 +0000
Subject: [PATCH] Enable Dell All-In-One volume up/down keys
Enable volume up and down hotkeys on WMI events
GUID 284A0E6B-380E-472A-921F-E52786257FB4 and
GUID 02314822-307C-4F66-bf0E-48AEAEB26CC8.
Also works around a firmware bug where the _WED method
should return an integer containing the key code and in fact
the method returns the key code in element zero of a buffer.
BugLink: http://bugs.launchpad.net/bugs/701530
BugLink: http://bugs.launchpad.net/bugs/676997
Signed-off-by: Colin Ian King <colin.king@canonical.com>
---
drivers/platform/x86/Kconfig | 13 +++
drivers/platform/x86/Makefile | 1 +
drivers/platform/x86/dell-wmi-aio.c | 171 +++++++++++++++++++++++++++++++++++
3 files changed, 185 insertions(+), 0 deletions(-)
create mode 100644 drivers/platform/x86/dell-wmi-aio.c
diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
index a59af5b..498eee5 100644
--- a/drivers/platform/x86/Kconfig
+++ b/drivers/platform/x86/Kconfig
@@ -101,6 +101,19 @@ config DELL_WMI
To compile this driver as a module, choose M here: the module will
be called dell-wmi.
+config DELL_WMI_AIO
+ tristate "WMI Hotkeys for Dell All-In-One series"
+ depends on ACPI_WMI
+ depends on INPUT
+ select INPUT_SPARSEKMAP
+ ---help---
+ Say Y here if you want to support WMI-based hotkeys on Dell
+ All-In-One machines.
+
+ To compile this driver as a module, choose M here: the module will
+ be called dell-wmi.
+
+
config FUJITSU_LAPTOP
tristate "Fujitsu Laptop Extras"
depends on ACPI
diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
index 4ec4ff8..26c6a57 100644
--- a/drivers/platform/x86/Makefile
+++ b/drivers/platform/x86/Makefile
@@ -10,6 +10,7 @@ obj-$(CONFIG_ACPI_CMPC) += classmate-laptop.o
obj-$(CONFIG_COMPAL_LAPTOP) += compal-laptop.o
obj-$(CONFIG_DELL_LAPTOP) += dell-laptop.o
obj-$(CONFIG_DELL_WMI) += dell-wmi.o
+obj-$(CONFIG_DELL_WMI_AIO) += dell-wmi-aio.o
obj-$(CONFIG_ACER_WMI) += acer-wmi.o
obj-$(CONFIG_ACERHDF) += acerhdf.o
obj-$(CONFIG_HP_WMI) += hp-wmi.o
diff --git a/drivers/platform/x86/dell-wmi-aio.c b/drivers/platform/x86/dell-wmi-aio.c
new file mode 100644
index 0000000..0ed8457
--- /dev/null
+++ b/drivers/platform/x86/dell-wmi-aio.c
@@ -0,0 +1,171 @@
+/*
+ * WMI hotkeys support for Dell All-In-One series
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/init.h>
+#include <linux/types.h>
+#include <linux/input.h>
+#include <linux/input/sparse-keymap.h>
+#include <acpi/acpi_drivers.h>
+#include <linux/acpi.h>
+#include <linux/string.h>
+
+MODULE_DESCRIPTION("WMI hotkeys driver for Dell All-In-One series");
+MODULE_LICENSE("GPL");
+
+#define EVENT_GUID1 "284A0E6B-380E-472A-921F-E52786257FB4"
+#define EVENT_GUID2 "02314822-307C-4F66-BF0E-48AEAEB26CC8"
+
+static const char *dell_wmi_aio_guids[] = {
+ EVENT_GUID1,
+ EVENT_GUID2,
+ NULL
+};
+
+MODULE_ALIAS("wmi:"EVENT_GUID1);
+MODULE_ALIAS("wmi:"EVENT_GUID2);
+
+static const struct key_entry dell_wmi_aio_keymap[] = {
+ { KE_KEY, 0xc0, { KEY_VOLUMEUP } },
+ { KE_KEY, 0xc1, { KEY_VOLUMEDOWN } },
+ { KE_END, 0 }
+};
+
+static struct input_dev *dell_wmi_aio_input_dev;
+
+static void dell_wmi_aio_notify(u32 value, void *context)
+{
+ struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
+ union acpi_object *obj;
+ acpi_status status;
+
+ status = wmi_get_event_data(value, &response);
+ if (status != AE_OK) {
+ pr_info("bad event status 0x%x\n", status);
+ return;
+ }
+
+ obj = (union acpi_object *)response.pointer;
+ if (obj) {
+ unsigned int scancode;
+
+ switch (obj->type) {
+ case ACPI_TYPE_INTEGER:
+ /* Most All-In-One correctly return integer scancode */
+ scancode = obj->integer.value;
+ sparse_keymap_report_event(dell_wmi_aio_input_dev,
+ scancode, 1, true);
+ break;
+ case ACPI_TYPE_BUFFER:
+ /* Broken machines return the scancode in a buffer */
+ if (obj->buffer.pointer && obj->buffer.length > 0) {
+ scancode = obj->buffer.pointer[0];
+ sparse_keymap_report_event(
+ dell_wmi_aio_input_dev,
+ scancode, 1, true);
+ }
+ break;
+ }
+ }
+ kfree(obj);
+}
+
+static int __init dell_wmi_aio_input_setup(void)
+{
+ int err;
+
+ dell_wmi_aio_input_dev = input_allocate_device();
+
+ if (!dell_wmi_aio_input_dev)
+ return -ENOMEM;
+
+ dell_wmi_aio_input_dev->name = "Dell AIO WMI hotkeys";
+ dell_wmi_aio_input_dev->phys = "wmi/input0";
+ dell_wmi_aio_input_dev->id.bustype = BUS_HOST;
+
+ err = sparse_keymap_setup(dell_wmi_aio_input_dev,
+ dell_wmi_aio_keymap, NULL);
+ if (err) {
+ pr_err("Unable to setup input device keymap\n");
+ goto err_free_dev;
+ }
+ err = input_register_device(dell_wmi_aio_input_dev);
+ if (err) {
+ pr_info("Unable to register input device\n");
+ goto err_free_keymap;
+ }
+ return 0;
+
+err_free_keymap:
+ sparse_keymap_free(dell_wmi_aio_input_dev);
+err_free_dev:
+ input_free_device(dell_wmi_aio_input_dev);
+ return err;
+}
+
+static const char *dell_wmi_aio_find(void)
+{
+ int i;
+
+ for (i = 0; dell_wmi_aio_guids[i] != NULL; i++)
+ if (wmi_has_guid(dell_wmi_aio_guids[i]))
+ return dell_wmi_aio_guids[i];
+
+ return NULL;
+}
+
+static int __init dell_wmi_aio_init(void)
+{
+ int err;
+ const char *guid;
+
+ guid = dell_wmi_aio_find();
+ if (!guid) {
+ pr_warning("No known WMI GUID found\n");
+ return -ENXIO;
+ }
+
+ err = dell_wmi_aio_input_setup();
+ if (err)
+ return err;
+
+ err = wmi_install_notify_handler(guid, dell_wmi_aio_notify, NULL);
+ if (err) {
+ pr_err("Unable to register notify handler - %d\n", err);
+ sparse_keymap_free(dell_wmi_aio_input_dev);
+ input_unregister_device(dell_wmi_aio_input_dev);
+ return err;
+ }
+
+ return 0;
+}
+
+static void __exit dell_wmi_aio_exit(void)
+{
+ const char *guid;
+
+ guid = dell_wmi_aio_find();
+ wmi_remove_notify_handler(guid);
+ sparse_keymap_free(dell_wmi_aio_input_dev);
+ input_unregister_device(dell_wmi_aio_input_dev);
+}
+
+module_init(dell_wmi_aio_init);
+module_exit(dell_wmi_aio_exit);
--
1.7.2.3
^ permalink raw reply related [flat|nested] 26+ messages in thread
* linux-next: build warnings after merge of the drivers-x86 tree
@ 2023-12-22 2:54 Stephen Rothwell
2023-12-22 14:10 ` Hans de Goede
0 siblings, 1 reply; 26+ messages in thread
From: Stephen Rothwell @ 2023-12-22 2:54 UTC (permalink / raw)
To: Hans de Goede, Mark Gross
Cc: Rajvi Jingar, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 1104 bytes --]
Hi all,
After merging the drivers-x86 tree, today's linux-next build (x86_64
allmodconfig) produced these warnings:
drivers/platform/x86/intel/pmc/arl.c:680:6: warning: no previous prototype for 'arl_d3_fixup' [-Wmissing-prototypes]
680 | void arl_d3_fixup(void)
| ^~~~~~~~~~~~
drivers/platform/x86/intel/pmc/arl.c:685:5: warning: no previous prototype for 'arl_resume' [-Wmissing-prototypes]
685 | int arl_resume(struct pmc_dev *pmcdev)
| ^~~~~~~~~~
drivers/platform/x86/intel/pmc/lnl.c:503:6: warning: no previous prototype for 'lnl_d3_fixup' [-Wmissing-prototypes]
503 | void lnl_d3_fixup(void)
| ^~~~~~~~~~~~
drivers/platform/x86/intel/pmc/lnl.c:509:5: warning: no previous prototype for 'lnl_resume' [-Wmissing-prototypes]
509 | int lnl_resume(struct pmc_dev *pmcdev)
| ^~~~~~~~~~
Introduced by commits
f34dcf397286 ("platform/x86/intel/pmc: Add Arrow Lake S support to intel_pmc_core driver")
119652b855e6 ("platform/x86/intel/pmc: Add Lunar Lake M support to intel_pmc_core driver")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 484 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2023-12-22 2:54 Stephen Rothwell
@ 2023-12-22 14:10 ` Hans de Goede
0 siblings, 0 replies; 26+ messages in thread
From: Hans de Goede @ 2023-12-22 14:10 UTC (permalink / raw)
To: Stephen Rothwell, Mark Gross
Cc: Rajvi Jingar, Linux Kernel Mailing List, Linux Next Mailing List
Hi All,
On 12/22/23 03:54, Stephen Rothwell wrote:
> Hi all,
>
> After merging the drivers-x86 tree, today's linux-next build (x86_64
> allmodconfig) produced these warnings:
>
> drivers/platform/x86/intel/pmc/arl.c:680:6: warning: no previous prototype for 'arl_d3_fixup' [-Wmissing-prototypes]
> 680 | void arl_d3_fixup(void)
> | ^~~~~~~~~~~~
> drivers/platform/x86/intel/pmc/arl.c:685:5: warning: no previous prototype for 'arl_resume' [-Wmissing-prototypes]
> 685 | int arl_resume(struct pmc_dev *pmcdev)
> | ^~~~~~~~~~
> drivers/platform/x86/intel/pmc/lnl.c:503:6: warning: no previous prototype for 'lnl_d3_fixup' [-Wmissing-prototypes]
> 503 | void lnl_d3_fixup(void)
> | ^~~~~~~~~~~~
> drivers/platform/x86/intel/pmc/lnl.c:509:5: warning: no previous prototype for 'lnl_resume' [-Wmissing-prototypes]
> 509 | int lnl_resume(struct pmc_dev *pmcdev)
> | ^~~~~~~~~~
>
> Introduced by commits
>
> f34dcf397286 ("platform/x86/intel/pmc: Add Arrow Lake S support to intel_pmc_core driver")
> 119652b855e6 ("platform/x86/intel/pmc: Add Lunar Lake M support to intel_pmc_core driver")
Ravji, can you please submit some fixes for these ?
Please split out the fixes into one per file, then I'll squash
them into the original commits.
Stephen, thank you for reporting these.
Regards,
Hans
^ permalink raw reply [flat|nested] 26+ messages in thread
* linux-next: build warnings after merge of the drivers-x86 tree
@ 2023-03-09 1:28 Stephen Rothwell
2023-03-09 8:48 ` Hans de Goede
0 siblings, 1 reply; 26+ messages in thread
From: Stephen Rothwell @ 2023-03-09 1:28 UTC (permalink / raw)
To: Hans de Goede, Mark Gross
Cc: Orlando Chamberlain, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 471 bytes --]
Hi all,
After merging the drivers-x86 tree, today's linux-next build
(htmldocs) produced these warning:
include/linux/apple-gmux.h:99: warning: Function parameter or member 'type_ret' not described in 'apple_gmux_detect'
include/linux/apple-gmux.h:99: warning: Excess function parameter 'indexed_ret' description in 'apple_gmux_detect'
Introduced by commit
fc83fbc80e1a ("platform/x86: apple-gmux: refactor gmux types")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2023-03-09 1:28 Stephen Rothwell
@ 2023-03-09 8:48 ` Hans de Goede
2023-03-09 10:40 ` Orlando Chamberlain
0 siblings, 1 reply; 26+ messages in thread
From: Hans de Goede @ 2023-03-09 8:48 UTC (permalink / raw)
To: Stephen Rothwell, Mark Gross
Cc: Orlando Chamberlain, Linux Kernel Mailing List, Linux Next Mailing List
Hi all,
On 3/9/23 02:28, Stephen Rothwell wrote:
> Hi all,
>
> After merging the drivers-x86 tree, today's linux-next build
> (htmldocs) produced these warning:
>
> include/linux/apple-gmux.h:99: warning: Function parameter or member 'type_ret' not described in 'apple_gmux_detect'
> include/linux/apple-gmux.h:99: warning: Excess function parameter 'indexed_ret' description in 'apple_gmux_detect'
>
> Introduced by commit
>
> fc83fbc80e1a ("platform/x86: apple-gmux: refactor gmux types")
Stephen, thank you for reporting this.
Orlando, can you do a follow-up patch on top of your
latest series fixing this ?
Regards,
Hans
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2023-03-09 8:48 ` Hans de Goede
@ 2023-03-09 10:40 ` Orlando Chamberlain
0 siblings, 0 replies; 26+ messages in thread
From: Orlando Chamberlain @ 2023-03-09 10:40 UTC (permalink / raw)
To: Hans de Goede
Cc: Stephen Rothwell, Mark Gross, Linux Kernel Mailing List,
Linux Next Mailing List
On Thu, 9 Mar 2023 09:48:58 +0100
Hans de Goede <hdegoede@redhat.com> wrote:
> Hi all,
>
> On 3/9/23 02:28, Stephen Rothwell wrote:
> > Hi all,
> >
> > After merging the drivers-x86 tree, today's linux-next build
> > (htmldocs) produced these warning:
> >
> > include/linux/apple-gmux.h:99: warning: Function parameter or
> > member 'type_ret' not described in 'apple_gmux_detect'
> > include/linux/apple-gmux.h:99: warning: Excess function parameter
> > 'indexed_ret' description in 'apple_gmux_detect'
> >
> > Introduced by commit
> >
> > fc83fbc80e1a ("platform/x86: apple-gmux: refactor gmux types")
Thanks Stephen.
>
> Stephen, thank you for reporting this.
>
> Orlando, can you do a follow-up patch on top of your
> latest series fixing this ?
Yes, I'll send one soon.
>
> Regards,
>
> Hans
>
^ permalink raw reply [flat|nested] 26+ messages in thread
* linux-next: build warnings after merge of the drivers-x86 tree
@ 2022-03-01 9:16 Stephen Rothwell
2022-03-01 13:53 ` Hans de Goede
2022-03-24 7:33 ` Stephen Rothwell
0 siblings, 2 replies; 26+ messages in thread
From: Stephen Rothwell @ 2022-03-01 9:16 UTC (permalink / raw)
To: Hans de Goede, Mark Gross
Cc: David E. Box, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 585 bytes --]
Hi all,
After merging the drivers-x86 tree, today's linux-next build (htmldocs)
produced these warnings:
Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Definition list ends without a blank line; unexpected unindent.
Introduced by commit
2546c6000430 ("platform/x86: Add Intel Software Defined Silicon driver")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2022-03-01 9:16 Stephen Rothwell
@ 2022-03-01 13:53 ` Hans de Goede
2022-03-24 7:33 ` Stephen Rothwell
1 sibling, 0 replies; 26+ messages in thread
From: Hans de Goede @ 2022-03-01 13:53 UTC (permalink / raw)
To: Stephen Rothwell, Mark Gross
Cc: David E. Box, Linux Kernel Mailing List, Linux Next Mailing List
Hi,
On 3/1/22 10:16, Stephen Rothwell wrote:
> Hi all,
>
> After merging the drivers-x86 tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation.
> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Definition list ends without a blank line; unexpected unindent.
>
> Introduced by commit
>
> 2546c6000430 ("platform/x86: Add Intel Software Defined Silicon driver")
Thank you for the report.
So I just did:
touch Documentation/ABI/testing/sysfs-driver-intel_sdsi
make htmldocs &> log
In a repo with drivers-x86/for-next checked out and checked the generated log files.
But I'm not seeing these WARNINGs.
Also 'find Documentation/output/ -name "*sdsi*"' does not output anything,
is there anything special (maybe some extra utilities?) which I need to also enable
building of htmldocs for the files in Documentation/ABI ?
Regards,
Hans
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
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
1 sibling, 1 reply; 26+ messages in thread
From: Stephen Rothwell @ 2022-03-24 7:33 UTC (permalink / raw)
To: Hans de Goede, Mark Gross
Cc: David E. Box, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 728 bytes --]
Hi all,
On Tue, 1 Mar 2022 20:16:59 +1100 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>
> After merging the drivers-x86 tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation.
> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Definition list ends without a blank line; unexpected unindent.
>
> Introduced by commit
>
> 2546c6000430 ("platform/x86: Add Intel Software Defined Silicon driver")
I am still seeing these warnings.
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2022-03-24 7:33 ` Stephen Rothwell
@ 2022-03-24 7:39 ` Hans de Goede
2022-03-24 11:22 ` Stephen Rothwell
0 siblings, 1 reply; 26+ messages in thread
From: Hans de Goede @ 2022-03-24 7:39 UTC (permalink / raw)
To: Stephen Rothwell, Mark Gross
Cc: David E. Box, Linux Kernel Mailing List, Linux Next Mailing List
Hi,
On 3/24/22 08:33, Stephen Rothwell wrote:
> Hi all,
>
> On Tue, 1 Mar 2022 20:16:59 +1100 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>>
>> After merging the drivers-x86 tree, today's linux-next build (htmldocs)
>> produced these warnings:
>>
>> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation.
>> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Block quote ends without a blank line; unexpected unindent.
>> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Definition list ends without a blank line; unexpected unindent.
>>
>> Introduced by commit
>>
>> 2546c6000430 ("platform/x86: Add Intel Software Defined Silicon driver")
>
> I am still seeing these warnings.
I replied to your original report on March 1st, but I never got a reply
to my reply:
"""
Thank you for the report.
So I just did:
touch Documentation/ABI/testing/sysfs-driver-intel_sdsi
make htmldocs &> log
In a repo with drivers-x86/for-next checked out and checked the generated log files.
But I'm not seeing these WARNINGs.
Also 'find Documentation/output/ -name "*sdsi*"' does not output anything,
is there anything special (maybe some extra utilities?) which I need to also enable
building of htmldocs for the files in Documentation/ABI ?
"""
If someone can let me know how to reproduce these warnings I would be happy
to fix them.
Regards,
Hans
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
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
0 siblings, 2 replies; 26+ messages in thread
From: Stephen Rothwell @ 2022-03-24 11:22 UTC (permalink / raw)
To: Hans de Goede
Cc: Mark Gross, David E. Box, Linux Kernel Mailing List,
Linux Next Mailing List, Jonathan Corbet, Mauro Carvalho Chehab
[-- Attachment #1: Type: text/plain, Size: 1151 bytes --]
Hi Hans,
On Thu, 24 Mar 2022 08:39:19 +0100 Hans de Goede <hdegoede@redhat.com> wrote:
>
> I replied to your original report on March 1st, but I never got a reply
> to my reply:
>
> """
> Thank you for the report.
>
> So I just did:
>
> touch Documentation/ABI/testing/sysfs-driver-intel_sdsi
> make htmldocs &> log
>
> In a repo with drivers-x86/for-next checked out and checked the generated log files.
> But I'm not seeing these WARNINGs.
>
> Also 'find Documentation/output/ -name "*sdsi*"' does not output anything,
> is there anything special (maybe some extra utilities?) which I need to also enable
> building of htmldocs for the files in Documentation/ABI ?
> """
>
> If someone can let me know how to reproduce these warnings I would be happy
> to fix them.
Sorry about that. I am just doing what you are doing but with the
whole of linux-next (which I don't think would make a difference). One
possibility is that we are using different versions of the doco
software.
I am using Sphinx version 4.3.2 (using Python 3).
[Adding those who do doco to cc for advise]
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2022-03-24 11:22 ` Stephen Rothwell
@ 2022-03-24 13:01 ` Hans de Goede
2022-03-24 13:04 ` Hans de Goede
1 sibling, 0 replies; 26+ messages in thread
From: Hans de Goede @ 2022-03-24 13:01 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Mark Gross, David E. Box, Linux Kernel Mailing List,
Linux Next Mailing List, Jonathan Corbet, Mauro Carvalho Chehab
Hi Stephen,
On 3/24/22 12:22, Stephen Rothwell wrote:
> Hi Hans,
>
> On Thu, 24 Mar 2022 08:39:19 +0100 Hans de Goede <hdegoede@redhat.com> wrote:
>>
>> I replied to your original report on March 1st, but I never got a reply
>> to my reply:
>>
>> """
>> Thank you for the report.
>>
>> So I just did:
>>
>> touch Documentation/ABI/testing/sysfs-driver-intel_sdsi
>> make htmldocs &> log
>>
>> In a repo with drivers-x86/for-next checked out and checked the generated log files.
>> But I'm not seeing these WARNINGs.
>>
>> Also 'find Documentation/output/ -name "*sdsi*"' does not output anything,
>> is there anything special (maybe some extra utilities?) which I need to also enable
>> building of htmldocs for the files in Documentation/ABI ?
>> """
>>
>> If someone can let me know how to reproduce these warnings I would be happy
>> to fix them.
>
> Sorry about that. I am just doing what you are doing but with the
> whole of linux-next (which I don't think would make a difference). One
> possibility is that we are using different versions of the doco
> software.
>
> I am using Sphinx version 4.3.2 (using Python 3).
[hans@shalem ~]$ rpm -qf /usr/bin/sphinx-apidoc
python3-sphinx-4.4.0-1.fc36.noarch
So I did some digging and the trick for reproducing any ABI
related warnings is to touch the .rst file which has the
"kernel-abi" reST directive (1) for the ABI subdir you want
to regenerate the ABI docs for
this is
t
I doubt this makes a difference though. AFAIK the build process
for the files under Documentation/ABI is a bit different,
I think there is an extra pre-process step involved and maybe
I'm missing something needed for that step ?
Looking at Documentation/Makefile I did
Regards,
Hans
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
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
1 sibling, 1 reply; 26+ messages in thread
From: Hans de Goede @ 2022-03-24 13:04 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Mark Gross, David E. Box, Linux Kernel Mailing List,
Linux Next Mailing List, Jonathan Corbet, Mauro Carvalho Chehab
<fat fingered send, sending an incomplete email, this is attempt 2>
Hi Stephen,
On 3/24/22 12:22, Stephen Rothwell wrote:
> Hi Hans,
>
> On Thu, 24 Mar 2022 08:39:19 +0100 Hans de Goede <hdegoede@redhat.com> wrote:
>>
>> I replied to your original report on March 1st, but I never got a reply
>> to my reply:
>>
>> """
>> Thank you for the report.
>>
>> So I just did:
>>
>> touch Documentation/ABI/testing/sysfs-driver-intel_sdsi
>> make htmldocs &> log
>>
>> In a repo with drivers-x86/for-next checked out and checked the generated log files.
>> But I'm not seeing these WARNINGs.
>>
>> Also 'find Documentation/output/ -name "*sdsi*"' does not output anything,
>> is there anything special (maybe some extra utilities?) which I need to also enable
>> building of htmldocs for the files in Documentation/ABI ?
>> """
>>
>> If someone can let me know how to reproduce these warnings I would be happy
>> to fix them.
>
> Sorry about that. I am just doing what you are doing but with the
> whole of linux-next (which I don't think would make a difference). One
> possibility is that we are using different versions of the doco
> software.
>
> I am using Sphinx version 4.3.2 (using Python 3).
[hans@shalem ~]$ rpm -qf /usr/bin/sphinx-apidoc
python3-sphinx-4.4.0-1.fc36.noarch
I doubt this makes a difference though.
So I did some digging and the trick for reproducing any ABI
related warnings is to touch the .rst file which has the
"kernel-abi" reST directive (1) for the ABI subdir you want
to regenerate the ABI docs for.
So in this case I did:
touch Documentation/admin-guide/abi-testing.rst
make htmldocs &> log
And now I can see the warnings. I'll prepare a fix for this.
Looking at Documentation/Makefile I also learned that you
can also do this:
scripts/get_abi.pl validate --dir Documentation/ABI
Which results in a different set of warnings...
Regards,
Hans
1) Implemented in Documentation/sphinx/kernel_abi.py
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2022-03-24 13:04 ` Hans de Goede
@ 2022-03-24 21:55 ` Stephen Rothwell
2022-03-25 5:27 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 26+ messages in thread
From: Stephen Rothwell @ 2022-03-24 21:55 UTC (permalink / raw)
To: Hans de Goede
Cc: Mark Gross, David E. Box, Linux Kernel Mailing List,
Linux Next Mailing List, Jonathan Corbet, Mauro Carvalho Chehab
[-- Attachment #1: Type: text/plain, Size: 846 bytes --]
Hi Hans,
On Thu, 24 Mar 2022 14:04:28 +0100 Hans de Goede <hdegoede@redhat.com> wrote:
>
> So I did some digging and the trick for reproducing any ABI
> related warnings is to touch the .rst file which has the
> "kernel-abi" reST directive (1) for the ABI subdir you want
> to regenerate the ABI docs for.
>
> So in this case I did:
>
> touch Documentation/admin-guide/abi-testing.rst
> make htmldocs &> log
Looks like missing dependencies :-(
Thanks for persisting ad discovering this.
> And now I can see the warnings. I'll prepare a fix for this.
Excellent, thanks.
> Looking at Documentation/Makefile I also learned that you
> can also do this:
>
> scripts/get_abi.pl validate --dir Documentation/ABI
>
> Which results in a different set of warnings...
Wonderful :-(
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2022-03-24 21:55 ` Stephen Rothwell
@ 2022-03-25 5:27 ` Mauro Carvalho Chehab
2022-03-25 6:18 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 26+ messages in thread
From: Mauro Carvalho Chehab @ 2022-03-25 5:27 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Hans de Goede, Mark Gross, David E. Box,
Linux Kernel Mailing List, Linux Next Mailing List,
Jonathan Corbet
Em Fri, 25 Mar 2022 08:55:22 +1100
Stephen Rothwell <sfr@canb.auug.org.au> escreveu:
> Hi Hans,
>
> On Thu, 24 Mar 2022 14:04:28 +0100 Hans de Goede <hdegoede@redhat.com> wrote:
> >
> > So I did some digging and the trick for reproducing any ABI
> > related warnings is to touch the .rst file which has the
> > "kernel-abi" reST directive (1) for the ABI subdir you want
> > to regenerate the ABI docs for.
> >
> > So in this case I did:
> >
> > touch Documentation/admin-guide/abi-testing.rst
> > make htmldocs &> log
>
> Looks like missing dependencies :-(
Not sure if are there a way to fix this. See, Sphinx doesn't use Makefile
dependencies, but, instead, it checks if the .rst file has changed or not.
So, those tags that include contents from non-rst files, like the ABI ones
and kernel-doc tags, are not considered by Sphinx when detecting the need
to re-parse the .rst files that contain such tags.
The safest way to ensure that Sphinx will process everything is running
is to run `make cleandocs` before building the documentation.
> Thanks for persisting ad discovering this.
>
> > And now I can see the warnings. I'll prepare a fix for this.
>
> Excellent, thanks.
>
> > Looking at Documentation/Makefile I also learned that you
> > can also do this:
> >
> > scripts/get_abi.pl validate --dir Documentation/ABI
No need to pass Documentation/ABI directory, as it assumes it per
default:
$ scripts/get_abi.pl validate
Warning: /sys/bus/iio/devices/iio:deviceX/fault_ovuv is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856:14 Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:0
Warning: /sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:12 Documentation/ABI/testing/sysfs-bus-iio:1943
Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 Documentation/ABI/testing/sysfs-bus-iio:91
Warning: /sys/devices/system/cpu/cpuX/topology/core_id is defined 2 times: Documentation/ABI/testing/sysfs-devices-system-cpu:69 Documentation/ABI/stable/sysfs-devices-system-cpu:38
Btw, while here, you can also check if the new ABI definitions
are actually correct by running:
$ ./scripts/get_abi.pl undefined
On a system where the new ABI "What:" definitions can be found.
This command converts the What: field into a regular expression,
and then check if the entries under sysfs actually match the
location specified by the "What:" fields from the ABI files.
As there are currently many ones that are missing (or wrong), you
can limit the scope of the checks by adding --search-string <regex>,
like:
$ ./scripts/get_abi.pl undefined --search-string hugepage
/sys/kernel/mm/transparent_hugepage/defrag not found.
/sys/kernel/mm/hugepages/hugepages-2048kB/free_hugepages not found.
/sys/kernel/mm/hugepages/hugepages-1048576kB/demote_size not found.
...
/sys/kernel/mm/transparent_hugepage/khugepaged/full_scans not found.
> > Which results in a different set of warnings...
Such warnings are also reported at build time, when the ABI file is
processed - e. g. if you either touch the files containing the ABI
.rst files or if you do a make cleandocs before building the
documentation.
Thanks,
Mauro
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2022-03-25 5:27 ` Mauro Carvalho Chehab
@ 2022-03-25 6:18 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 26+ messages in thread
From: Mauro Carvalho Chehab @ 2022-03-25 6:18 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Hans de Goede, Mark Gross, David E. Box,
Linux Kernel Mailing List, Linux Next Mailing List,
Jonathan Corbet
Em Fri, 25 Mar 2022 06:27:35 +0100
Mauro Carvalho Chehab <mchehab@kernel.org> escreveu:
> Em Fri, 25 Mar 2022 08:55:22 +1100
> Stephen Rothwell <sfr@canb.auug.org.au> escreveu:
>
> > Hi Hans,
> >
> > On Thu, 24 Mar 2022 14:04:28 +0100 Hans de Goede <hdegoede@redhat.com> wrote:
> > >
> > > So I did some digging and the trick for reproducing any ABI
> > > related warnings is to touch the .rst file which has the
> > > "kernel-abi" reST directive (1) for the ABI subdir you want
> > > to regenerate the ABI docs for.
> > >
> > > So in this case I did:
> > >
> > > touch Documentation/admin-guide/abi-testing.rst
> > > make htmldocs &> log
> >
> > Looks like missing dependencies :-(
>
> Not sure if are there a way to fix this. See, Sphinx doesn't use Makefile
> dependencies, but, instead, it checks if the .rst file has changed or not.
> So, those tags that include contents from non-rst files, like the ABI ones
> and kernel-doc tags, are not considered by Sphinx when detecting the need
> to re-parse the .rst files that contain such tags.
It sounds that dependencies could added inside an extension using:
env.note_dependency()
kerneldoc.py already uses it. I'll try to add it also to the other
extensions there.
Thanks,
Mauro
^ permalink raw reply [flat|nested] 26+ messages in thread
* linux-next: build warnings after merge of the drivers-x86 tree
@ 2021-10-21 7:47 Stephen Rothwell
2021-10-21 9:07 ` Vadim Pasternak
2021-10-21 9:14 ` Hans de Goede
0 siblings, 2 replies; 26+ messages in thread
From: Stephen Rothwell @ 2021-10-21 7:47 UTC (permalink / raw)
To: Hans de Goede, Mark Gross
Cc: Vadim Pasternak, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 471 bytes --]
Hi all,
After merging the drivers-x86 tree, today's linux-next build (htmldocs)
produced these warnings:
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.
Introduced by commit
527cd54d49dd ("Documentation/ABI: Add new attributes for mlxreg-io sysfs interfaces")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* RE: linux-next: build warnings after merge of the drivers-x86 tree
2021-10-21 7:47 Stephen Rothwell
@ 2021-10-21 9:07 ` Vadim Pasternak
2021-10-21 20:04 ` Stephen Rothwell
2021-10-21 9:14 ` Hans de Goede
1 sibling, 1 reply; 26+ messages in thread
From: Vadim Pasternak @ 2021-10-21 9:07 UTC (permalink / raw)
To: Stephen Rothwell, Hans de Goede, Mark Gross
Cc: Linux Kernel Mailing List, Linux Next Mailing List
> -----Original Message-----
> From: Stephen Rothwell <sfr@canb.auug.org.au>
> Sent: Thursday, October 21, 2021 10:48 AM
> To: Hans de Goede <hdegoede@redhat.com>; Mark Gross
> <markgross@kernel.org>
> Cc: Vadim Pasternak <vadimp@nvidia.com>; Linux Kernel Mailing List <linux-
> kernel@vger.kernel.org>; Linux Next Mailing List <linux-
> next@vger.kernel.org>
> Subject: linux-next: build warnings after merge of the drivers-x86 tree
>
> Hi all,
>
> After merging the drivers-x86 tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> 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.
Hi,
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
Thanks,
Vadim.
>
> Introduced by commit
>
> 527cd54d49dd ("Documentation/ABI: Add new attributes for mlxreg-io sysfs
> interfaces")
>
> --
> Cheers,
> Stephen Rothwell
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2021-10-21 9:07 ` Vadim Pasternak
@ 2021-10-21 20:04 ` Stephen Rothwell
2021-10-21 21:10 ` Jonathan Corbet
0 siblings, 1 reply; 26+ messages in thread
From: Stephen Rothwell @ 2021-10-21 20:04 UTC (permalink / raw)
To: Vadim Pasternak
Cc: Hans de Goede, Mark Gross, Linux Kernel Mailing List,
Linux Next Mailing List, Jonathan Corbet
[-- Attachment #1: Type: text/plain, Size: 1558 bytes --]
Hi Vadim,
On Thu, 21 Oct 2021 09:07:03 +0000 Vadim Pasternak <vadimp@nvidia.com> wrote:
>
> > -----Original Message-----
> > From: Stephen Rothwell <sfr@canb.auug.org.au>
> > Sent: Thursday, October 21, 2021 10:48 AM
> > To: Hans de Goede <hdegoede@redhat.com>; Mark Gross
> > <markgross@kernel.org>
> > Cc: Vadim Pasternak <vadimp@nvidia.com>; Linux Kernel Mailing List <linux-
> > kernel@vger.kernel.org>; Linux Next Mailing List <linux-
> > next@vger.kernel.org>
> > Subject: linux-next: build warnings after merge of the drivers-x86 tree
> >
> > Hi all,
> >
> > After merging the drivers-x86 tree, today's linux-next build (htmldocs)
> > produced these warnings:
> >
> > 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.
>
> Hi,
>
> 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.
> > Introduced by commit
> >
> > 527cd54d49dd ("Documentation/ABI: Add new attributes for mlxreg-io sysfs
> > interfaces")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2021-10-21 20:04 ` Stephen Rothwell
@ 2021-10-21 21:10 ` Jonathan Corbet
2021-10-22 9:02 ` Hans de Goede
0 siblings, 1 reply; 26+ messages in thread
From: Jonathan Corbet @ 2021-10-21 21:10 UTC (permalink / raw)
To: Stephen Rothwell, Vadim Pasternak
Cc: Hans de Goede, Mark Gross, Linux Kernel Mailing List,
Linux Next Mailing List, Mauro Carvalho Chehab
[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.
Thanks,
jon
-----------------------------
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.
--
2.31.1
^ permalink raw reply related [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2021-10-21 21:10 ` Jonathan Corbet
@ 2021-10-22 9:02 ` Hans de Goede
0 siblings, 0 replies; 26+ messages in thread
From: Hans de Goede @ 2021-10-22 9:02 UTC (permalink / raw)
To: Jonathan Corbet, Stephen Rothwell, Vadim Pasternak
Cc: Mark Gross, Linux Kernel Mailing List, Linux Next Mailing List,
Mauro Carvalho Chehab
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.
>
>
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2021-10-21 7:47 Stephen Rothwell
2021-10-21 9:07 ` Vadim Pasternak
@ 2021-10-21 9:14 ` Hans de Goede
2021-10-21 20:02 ` Stephen Rothwell
1 sibling, 1 reply; 26+ messages in thread
From: Hans de Goede @ 2021-10-21 9:14 UTC (permalink / raw)
To: Stephen Rothwell, Mark Gross
Cc: Vadim Pasternak, Linux Kernel Mailing List, Linux Next Mailing List
Hi Stephen,
On 10/21/21 09:47, Stephen Rothwell wrote:
> Hi all,
>
> After merging the drivers-x86 tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> 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.
>
> Introduced by commit
>
> 527cd54d49dd ("Documentation/ABI: Add new attributes for mlxreg-io sysfs interfaces")
Thank you for reporting this.
I've a bit of a noob question which tool / make target generates these warnings?
I would like to make sure they are fixed, but first I must be able to reproduce
them.
Regards,
Hans
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: linux-next: build warnings after merge of the drivers-x86 tree
2021-10-21 9:14 ` Hans de Goede
@ 2021-10-21 20:02 ` Stephen Rothwell
0 siblings, 0 replies; 26+ messages in thread
From: Stephen Rothwell @ 2021-10-21 20:02 UTC (permalink / raw)
To: Hans de Goede
Cc: Mark Gross, Vadim Pasternak, Linux Kernel Mailing List,
Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 812 bytes --]
Hi Hans,
On Thu, 21 Oct 2021 11:14:29 +0200 Hans de Goede <hdegoede@redhat.com> wrote:
>
> On 10/21/21 09:47, Stephen Rothwell wrote:
> > Hi all,
> >
> > After merging the drivers-x86 tree, today's linux-next build (htmldocs)
> > produced these warnings:
> >
> > 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.
> >
> > Introduced by commit
> >
> > 527cd54d49dd ("Documentation/ABI: Add new attributes for mlxreg-io sysfs interfaces")
>
> Thank you for reporting this.
>
> I've a bit of a noob question which tool / make target generates these warnings?
I just do "make htmldocs".
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* linux-next: build warnings after merge of the drivers-x86 tree
@ 2020-11-05 6:55 Stephen Rothwell
0 siblings, 0 replies; 26+ messages in thread
From: Stephen Rothwell @ 2020-11-05 6:55 UTC (permalink / raw)
To: Hans de Goede, Mark Gross
Cc: Divya Bharathi, Mario Limonciello, Prasanth KSR,
Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 1050 bytes --]
Hi all,
After merging the drivers-x86 tree, today's linux-next build (htmldocs)
produced these warnings:
Documentation/ABI/testing/sysfs-class-firmware-attributes:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-class-firmware-attributes:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-class-firmware-attributes:2: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-class-firmware-attributes:173: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-class-firmware-attributes:173: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-class-firmware-attributes:173: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-class-firmware-attributes:111: WARNING: Inline emphasis start-string without end-string.
Introduced by commit
e8a60aa7404b ("platform/x86: Introduce support for Systems Management Driver over WMI for Dell Systems")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* linux-next: build warnings after merge of the drivers-x86 tree
@ 2010-12-08 2:32 Stephen Rothwell
0 siblings, 0 replies; 26+ messages in thread
From: Stephen Rothwell @ 2010-12-08 2:32 UTC (permalink / raw)
To: Matthew Garrett; +Cc: linux-next, linux-kernel, Corentin Chary
[-- Attachment #1: Type: text/plain, Size: 2013 bytes --]
Hi Matthew,
After merging the scsi-post-merge tree, today's linux-next build (all
builds) produced these warnings:
drivers/platform/x86/Kconfig:422:error: recursive dependency detected!
drivers/platform/x86/Kconfig:422: symbol EEEPC_WMI depends on ACPI_WMI
drivers/platform/x86/Kconfig:438: symbol ACPI_WMI is selected by ACER_WMI
drivers/platform/x86/Kconfig:18: symbol ACER_WMI depends on LEDS_CLASS
drivers/leds/Kconfig:10: symbol LEDS_CLASS is selected by EEEPC_WMI
The x86_64 allmodconfig and i386 defconfig builds also produced this:
warning: (ADB_PMU_LED && MACINTOSH_DRIVERS && ADB_PMU || ATH5K && NETDEVICES && WLAN && ATH_COMMON && (PCI || ATHEROS_AR231X) && MAC80211 || ATH9K && NETDEVICES && WLAN && ATH_COMMON && PCI && MAC80211 || ATH9K_HTC && NETDEVICES && WLAN && ATH_COMMON && USB && MAC80211 || CARL9170_LEDS && NETDEVICES && WLAN && ATH_COMMON && CARL9170 || INPUT_WISTRON_BTNS && !S390 && INPUT && INPUT_MISC && X86 && !X86_64 || SENSORS_APPLESMC && HWMON && INPUT && X86 || SENSORS_LIS3LV02D && HWMON && ACPI && INPUT || IR_WINBOND_CIR && MEDIA_SUPPORT && X86 && PNP && RC_CORE || BACKLIGHT_ADP8860 && HAS_IOMEM && BACKLIGHT_LCD_SUPPORT && BACKLIGHT_CLASS_DEVICE && I2C || MSM_STAGING && STAGING && !STAGING_EXCLUDE_BUILD && FB && ARCH_MSM && !FB_MSM || ASUS_LAPTOP && X86 && X86_PLATFORM_DEVICES && ACPI && !ACPI_ASUS && INPUT && (RFKILL || RFKILL=n) || THINKPAD_ACPI && X86 && X86_PLATFORM_DEVICES && ACPI && INPUT && (RFKILL || RFKILL=n) || EEEPC_LAPTOP && X86 && X86_PLATFORM_DEVICES && ACPI && INPUT && EXPERIMENTAL && (RFKILL || RFKILL=n) && HOTPLUG_PCI || EEEPC_WMI && X86 && X86_PLATFORM_DEVICES && ACPI_WMI && INPUT && EXPERIMENTAL && BACKLIGHT_CLASS_DEVICE && (RFKILL || RFKILL=n)) selects LEDS_CLASS which has unmet direct dependencies (NEW_LEDS)
Introduced by commit 41eeea57adfb7d37b4a826877a8a6965cae5fb4a
("eeepc-wmi: add touchpad led support")?
--
Cheers,
Stephen Rothwell sfr@canb.auug.org.au
http://www.canb.auug.org.au/~sfr/
[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
end of thread, other threads:[~2023-12-22 14:10 UTC | newest]
Thread overview: 26+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-02-22 5:13 linux-next: build warnings after merge of the drivers-x86 tree Stephen Rothwell
2011-02-22 10:36 ` Colin Ian King
-- 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
2021-10-21 7:47 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
2021-10-21 9:14 ` Hans de Goede
2021-10-21 20:02 ` Stephen Rothwell
2020-11-05 6:55 Stephen Rothwell
2010-12-08 2:32 Stephen Rothwell
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.