This series fixes the documentation warnings found at next-20210114.
Most of the changes here are trivial.
While those patches could be merged via the docs tree during
the next merge window, It sounds better to have those patches
merged directly via each maintainer's tree, where the new
warnings were introduced.
Regards,
Mauro
Mauro Carvalho Chehab (10):
doc/zh_CN: fix Sphinx errors
ABI: sysfs-fs-f2fs: fix a table identation
KVM: x86: hyper-v: add a blank line to remove building warnings
ABI: sysfs-firmware-sgi_uv
docs: fpga: dfl.rst: Fix a couple building issues
drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup
dwc3: document gadget_max_speed
doc: zh_CN/mips: fix doc cross-references
media: v4l2-subdev.rst: fix a missing whitespace
seqlock: kernel-doc: fix a prototype
Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 +
Documentation/ABI/testing/sysfs-fs-f2fs | 3 ++-
Documentation/driver-api/media/v4l2-subdev.rst | 2 +-
Documentation/fpga/dfl.rst | 4 ++--
Documentation/translations/zh_CN/mips/booting.rst | 2 +-
Documentation/translations/zh_CN/mips/features.rst | 2 +-
Documentation/translations/zh_CN/mips/index.rst | 2 +-
Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 6 +++---
Documentation/virt/kvm/api.rst | 1 +
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
drivers/usb/dwc3/core.h | 1 +
include/linux/seqlock.h | 2 +-
12 files changed, 16 insertions(+), 12 deletions(-)
--
2.29.2
There's a missing colon, causing the markup to be ignored,
solving those warnings:
../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
index f084e2fc9569..5ee1b766884e 100644
--- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
+++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
@@ -337,7 +337,7 @@ struct amdgpu_display_manager {
const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
/**
- * @active_vblank_irq_count
+ * @active_vblank_irq_count:
*
* number of currently active vblank irqs
*/
--
2.29.2
Right now, kernel-doc produces a warning:
./include/linux/seqlock.h:829: warning: wrong kernel-doc identifier on line:
* DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
The issue is that Kernel-doc valid syntaxes for function/define
declarations are either:
function_foo - description
or:
function_foo() - description
The function parameters should be declared only afterwards.
So, replace it to:
DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
include/linux/seqlock.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h
index 2f7bb92b4c9e..209454cedf61 100644
--- a/include/linux/seqlock.h
+++ b/include/linux/seqlock.h
@@ -826,7 +826,7 @@ typedef struct {
} while (0)
/**
- * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
+ * DEFINE_SEQLOCK() - Define a statically allocated seqlock_t
* @sl: Name of the seqlock_t instance
*/
#define DEFINE_SEQLOCK(sl) \
--
2.29.2
A title markup length is smaller than required;
A literal block is not marked as such.
This fixes the warnings below:
.../Documentation/fpga/dfl.rst:505: WARNING: Title underline too short.
Location of DFLs on a PCI Device
===========================
.../Documentation/fpga/dfl.rst:523: WARNING: Unexpected indentation.
.../Documentation/fpga/dfl.rst:523: WARNING: Blank line required after table.
.../Documentation/fpga/dfl.rst:524: WARNING: Block quote ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/fpga/dfl.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/fpga/dfl.rst b/Documentation/fpga/dfl.rst
index ea8cefc18bdb..716a3d705046 100644
--- a/Documentation/fpga/dfl.rst
+++ b/Documentation/fpga/dfl.rst
@@ -502,7 +502,7 @@ FME Partial Reconfiguration Sub Feature driver (see drivers/fpga/dfl-fme-pr.c)
could be a reference.
Location of DFLs on a PCI Device
-===========================
+================================
The original method for finding a DFL on a PCI device assumed the start of the
first DFL to offset 0 of bar 0. If the first node of the DFL is an FME,
then further DFLs in the port(s) are specified in FME header registers.
@@ -513,7 +513,7 @@ VSEC ID of 0x43 for this purpose. The vendor specific
data begins with a 4 byte vendor specific register for the number of DFLs followed 4 byte
Offset/BIR vendor specific registers for each DFL. Bits 2:0 of Offset/BIR register
indicates the BAR, and bits 31:3 form the 8 byte aligned offset where bits 2:0 are
-zero.
+zero::
+----------------------------+
|31 Number of DFLS 0|
--
2.29.2
Add a missing blank line required to identify a literal block,
fixing this warning:
.../Documentation/ABI/testing/sysfs-firmware-sgi_uv:2: WARNING: Unexpected indentation.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/ABI/testing/sysfs-firmware-sgi_uv b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
index 637c668cbe45..b0f79a1d14b3 100644
--- a/Documentation/ABI/testing/sysfs-firmware-sgi_uv
+++ b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
@@ -39,6 +39,7 @@ Description:
The uv_type entry contains the hub revision number.
This value can be used to identify the UV system version::
+
"0.*" = Hubless UV ('*' is subtype)
"3.0" = UV2
--
2.29.2
Solves this warning:
.../Documentation/driver-api/media/v4l2-subdev.rst:125: WARNING: Inline interpreted text or phrase reference start-string without end-string.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/driver-api/media/v4l2-subdev.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
index 6d5c799c49fe..0e82c77cf3e2 100644
--- a/Documentation/driver-api/media/v4l2-subdev.rst
+++ b/Documentation/driver-api/media/v4l2-subdev.rst
@@ -123,7 +123,7 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
media_entity_cleanup(&sd->entity);
If a sub-device driver implements sink pads, the subdev driver may set the
-link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its own link
+link_validate field in :c:type:`v4l2_subdev_pad_ops` to provide its own link
validation function. For every link in the pipeline, the link_validate pad
operation of the sink end of the link is called. In both cases the driver is
still responsible for validating the correctness of the format configuration
--
2.29.2
Solves this doc build error:
.../Documentation/ABI/testing/sysfs-fs-f2fs:382: WARNING: Malformed table.
Text in column margin in table line 15.
===== ===================== =================================
value sb status macro description
0x1 SBI_IS_DIRTY dirty flag for checkpoint
0x2 SBI_IS_CLOSE specify unmounting
0x4 SBI_NEED_FSCK need fsck.f2fs to fix
0x8 SBI_POR_DOING recovery is doing or not
0x10 SBI_NEED_SB_WRITE need to recover superblock
0x20 SBI_NEED_CP need to checkpoint
0x40 SBI_IS_SHUTDOWN shutdown by ioctl
0x80 SBI_IS_RECOVERED recovered orphan/data
0x100 SBI_CP_DISABLED CP was disabled last mount
0x200 SBI_CP_DISABLED_QUICK CP was disabled quickly
0x400 SBI_QUOTA_NEED_FLUSH need to flush quota info in CP
0x800 SBI_QUOTA_SKIP_FLUSH skip flushing quota in current CP
0x1000 SBI_QUOTA_NEED_REPAIR quota file may be corrupted
0x2000 SBI_IS_RESIZEFS resizefs is in process
====== ===================== =================================
Fixes: 969945899a35 ("f2fs: introduce sb_status sysfs node")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/ABI/testing/sysfs-fs-f2fs | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/ABI/testing/sysfs-fs-f2fs b/Documentation/ABI/testing/sysfs-fs-f2fs
index e5918c93f3bf..1ba8d533437a 100644
--- a/Documentation/ABI/testing/sysfs-fs-f2fs
+++ b/Documentation/ABI/testing/sysfs-fs-f2fs
@@ -383,8 +383,9 @@ Date: December 2020
Contact: "Chao Yu" <[email protected]>
Description: Show status of f2fs superblock in real time.
- ===== ===================== =================================
+ ====== ===================== =================================
value sb status macro description
+ ====== ===================== =================================
0x1 SBI_IS_DIRTY dirty flag for checkpoint
0x2 SBI_IS_CLOSE specify unmounting
0x4 SBI_NEED_FSCK need fsck.f2fs to fix
--
2.29.2
There are several wrong references there:
.../Documentation/translations/zh_CN/mips/booting.rst:5: WARNING: undefined label: booting (if the link has no caption the label must precede a section header)
.../Documentation/translations/zh_CN/mips/features.rst:5: WARNING: undefined label: features (if the link has no caption the label must precede a section header)
.../Documentation/translations/zh_CN/mips/index.rst:5: WARNING: undefined label: index (if the link has no caption the label must precede a section header)
.../Documentation/translations/zh_CN/mips/ingenic-tcu.rst:5: WARNING: undefined label: ingenic-tcu (if the link has no caption the label must precede a section header)
Replace them by :doc: markup, which won't require to add anything
extra at the existing documents.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/translations/zh_CN/mips/booting.rst | 2 +-
Documentation/translations/zh_CN/mips/features.rst | 2 +-
Documentation/translations/zh_CN/mips/index.rst | 2 +-
Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/translations/zh_CN/mips/booting.rst b/Documentation/translations/zh_CN/mips/booting.rst
index 3099d0fff7a6..00bebf7681f9 100644
--- a/Documentation/translations/zh_CN/mips/booting.rst
+++ b/Documentation/translations/zh_CN/mips/booting.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/booting.rst <booting>`
+:Original: :doc:`/mips/booting`
:Translator: Yanteng Si <[email protected]>
.. _cn_booting:
diff --git a/Documentation/translations/zh_CN/mips/features.rst b/Documentation/translations/zh_CN/mips/features.rst
index 7e67f81a0982..72adcd9b360f 100644
--- a/Documentation/translations/zh_CN/mips/features.rst
+++ b/Documentation/translations/zh_CN/mips/features.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/features.rst <features>`
+:Original: :doc:`/mips/features`
:Translator: Yanteng Si <[email protected]>
.. _cn_features:
diff --git a/Documentation/translations/zh_CN/mips/index.rst b/Documentation/translations/zh_CN/mips/index.rst
index 2c7b836a3da5..c2ab89890979 100644
--- a/Documentation/translations/zh_CN/mips/index.rst
+++ b/Documentation/translations/zh_CN/mips/index.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/index.rst <index>`
+:Original: :doc:`/mips/index`
:Translator: Yanteng Si <[email protected]>
.. _cn_index:
diff --git a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
index 919ae1d4734e..cb570d7eca24 100644
--- a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
+++ b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/ingenic-tcu.rst <ingenic-tcu>`
+:Original: :doc:`/mips/ingenic-tcu`
:Translator: Yanteng Si <[email protected]>
.. _cn_ingenic-tcu:
--
2.29.2
.../Documentation/virt/kvm/api.rst:4536: WARNING: Unexpected indentation.
.../Documentation/virt/kvm/api.rst:4538: WARNING: Block quote ends without a blank line; unexpected unindent.
Fixes: c21d54f0307f ("KVM: x86: hyper-v: allow KVM_GET_SUPPORTED_HV_CPUID as a system ioctl")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/virt/kvm/api.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index c136e254b496..c95572a66a7b 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -4532,6 +4532,7 @@ userspace should not expect to get any particular value there.
Note, vcpu version of KVM_GET_SUPPORTED_HV_CPUID is currently deprecated. Unlike
system ioctl which exposes all supported feature bits unconditionally, vcpu
version has the following quirks:
+
- HYPERV_CPUID_NESTED_FEATURES leaf and HV_X64_ENLIGHTENED_VMCS_RECOMMENDED
feature bit are only exposed when Enlightened VMCS was previously enabled
on the corresponding vCPU (KVM_CAP_HYPERV_ENLIGHTENED_VMCS).
--
2.29.2
The whitespacing with some translations are weird,
which causes errors like this one:
devel/v4l/docs/Documentation/translations/zh_CN/mips/ingenic-tcu.rst:61: WARNING: Malformed table.
Text in column margin in table line 6.
=========== =====
时钟 drivers/clk/ingenic/tcu.c
中断 drivers/irqchip/irq-ingenic-tcu.c
定时器 drivers/clocksource/ingenic-timer.c
OST drivers/clocksource/ingenic-ost.c
脉冲宽度调制器 drivers/pwm/pwm-jz4740.c
看门狗 drivers/watchdog/jz4740_wdt.c
=========== =====
Fix it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
index 72b5d409ed89..919ae1d4734e 100644
--- a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
+++ b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
@@ -53,14 +53,14 @@
TCU硬件的功能分布在多个驱动程序：
-=========== =====
+================== ===================================
时钟 drivers/clk/ingenic/tcu.c
中断 drivers/irqchip/irq-ingenic-tcu.c
定时器 drivers/clocksource/ingenic-timer.c
OST drivers/clocksource/ingenic-ost.c
脉冲宽度调制器 drivers/pwm/pwm-jz4740.c
看门狗 drivers/watchdog/jz4740_wdt.c
-=========== =====
+================== ===================================
因为可以从相同的寄存器控制属于不同驱动程序和框架的TCU的各种功能，所以
所有这些驱动程序都通过相同的控制总线通用接口访问它们的寄存器。
--
2.29.2
Am 14.01.21 um 08:53 schrieb Mauro Carvalho Chehab:
> There's a missing colon, causing the markup to be ignored,
> solving those warnings:
>
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Reviewed-by: Christian König <[email protected]>
> ---
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index f084e2fc9569..5ee1b766884e 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -337,7 +337,7 @@ struct amdgpu_display_manager {
> const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
>
> /**
> - * @active_vblank_irq_count
> + * @active_vblank_irq_count:
> *
> * number of currently active vblank irqs
> */
On Thu, 14 Jan 2021 08:53:36 +0100
Mauro Carvalho Chehab <[email protected]> wrote:
> The whitespacing with some translations are weird,
> which causes errors like this one:
>
> devel/v4l/docs/Documentation/translations/zh_CN/mips/ingenic-tcu.rst:61: WARNING: Malformed table.
> Text in column margin in table line 6.
>
> =========== =====
> 时钟 drivers/clk/ingenic/tcu.c
> 中断 drivers/irqchip/irq-ingenic-tcu.c
> 定时器 drivers/clocksource/ingenic-timer.c
> OST drivers/clocksource/ingenic-ost.c
> 脉冲宽度调制器 drivers/pwm/pwm-jz4740.c
> 看门狗 drivers/watchdog/jz4740_wdt.c
> =========== =====
>
> Fix it.
This one has already been taken care of.
Thanks,
jon
On 1/13/21 11:53 PM, Mauro Carvalho Chehab wrote:
> A title markup length is smaller than required;
> A literal block is not marked as such.
>
> This fixes the warnings below:
>
> .../Documentation/fpga/dfl.rst:505: WARNING: Title underline too short.
>
> Location of DFLs on a PCI Device
> ===========================
> .../Documentation/fpga/dfl.rst:523: WARNING: Unexpected indentation.
> .../Documentation/fpga/dfl.rst:523: WARNING: Blank line required after table.
> .../Documentation/fpga/dfl.rst:524: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Lukas made an earlier change here
https://lore.kernel.org/linux-fpga/alpine.DEB.2.22.394.2101111016480.2457315@rhweight-WRK1/
Tom
> From: Mauro Carvalho Chehab [mailto:[email protected]] On Behalf Of Mauro Carvalho Chehab
> Sent: Thursday, January 14, 2021 1:54 AM
> Subject: [PATCH 04/10] ABI: sysfs-firmware-sgi_uv
>
> Add a missing blank line required to identify a literal block,
> fixing this warning:
>
> .../Documentation/ABI/testing/sysfs-firmware-sgi_uv:2: WARNING: Unexpected indentation.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Thanks for finding and fixing this. I was able to replicate the warning and confirm the fix.
Reviewed-by: Justin Ernst <[email protected]>
> ---
> Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-sgi_uv b/Documentation/ABI/testing/sysfs-
> firmware-sgi_uv
> index 637c668cbe45..b0f79a1d14b3 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-sgi_uv
> +++ b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
> @@ -39,6 +39,7 @@ Description:
>
> The uv_type entry contains the hub revision number.
> This value can be used to identify the UV system version::
> +
> "0.*" = Hubless UV ('*' is subtype)
>
> "3.0" = UV2
> --
> 2.29.2
On Thu, Jan 14, 2021 at 2:53 AM Mauro Carvalho Chehab
<[email protected]> wrote:
>
> There's a missing colon, causing the markup to be ignored,
> solving those warnings:
>
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Thanks, actually applied the same patch from Lukas Bulwahn a couple of days ago.
Alex
> ---
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index f084e2fc9569..5ee1b766884e 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -337,7 +337,7 @@ struct amdgpu_display_manager {
> const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
>
> /**
> - * @active_vblank_irq_count
> + * @active_vblank_irq_count:
> *
> * number of currently active vblank irqs
> */
> --
> 2.29.2
>
> _______________________________________________
> amd-gfx mailing list
> [email protected]
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx
[reduced the recipient list to the main responsible ones and list]
Hi Mauro, hi Jonathan,
We both, Mauro and I, have been submitting patches to address the
documentation warnings on linux-next. If it is okay with you, Mauro, I
would like to take responsibility for the task to send out the patches
to address all warnings on linux-next in make htmldocs and follow up
with all the discussions. I can also provide a short weekly summary
(probably always on Friday) on what is pending where and what I could
not resolve by myself.
Is that okay for you?
If at some point I do not have the time to take care anymore, I will
let you know.
Best regards,
Lukas
Hi Lukas,
Em Fri, 15 Jan 2021 07:12:38 +0100
Lukas Bulwahn <[email protected]> escreveu:
> [reduced the recipient list to the main responsible ones and list]
>
> Hi Mauro, hi Jonathan,
>
> We both, Mauro and I, have been submitting patches to address the
> documentation warnings on linux-next. If it is okay with you, Mauro, I
> would like to take responsibility for the task to send out the patches
> to address all warnings on linux-next in make htmldocs and follow up
> with all the discussions. I can also provide a short weekly summary
> (probably always on Friday) on what is pending where and what I could
> not resolve by myself.
>
> Is that okay for you?
>
> If at some point I do not have the time to take care anymore, I will
> let you know.
Yeah, sure!
Anyway, after applying the patches I sent this week, the warnings
I'm getting are all due to the validation scripts I wrote. So, if
everything gets merged (either yours or my version), we'll have zero
Sphinx/kernel-doc warnings again.
The script-validation warnings are:
1. Broken cross references
--------------------------
$ scripts/documentation-file-ref-check
Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml
Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml
Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
It sounds that part of the above is due to DT patches that weren't
merged yet, but there are a few others that can be solved, but may
require discussions with some Kernel developers/maintainers.
2. Duplicated ABI definitions
-----------------------------
$ scripts/get_abi.pl validate
Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394
Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395
Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396
Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397
Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398
Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399
Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599
Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588
Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
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:45
Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4
Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0
Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27
Perhaps you could check with Jonathan Cameron some strategy to address
the IIO warnings.
Thanks,
Mauro
On Fri, Jan 15, 2021 at 10:49 AM Mauro Carvalho Chehab
<[email protected]> wrote:
>
> Hi Lukas,
>
> Em Fri, 15 Jan 2021 07:12:38 +0100
> Lukas Bulwahn <[email protected]> escreveu:
>
> > [reduced the recipient list to the main responsible ones and list]
> >
> > Hi Mauro, hi Jonathan,
> >
> > We both, Mauro and I, have been submitting patches to address the
> > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > would like to take responsibility for the task to send out the patches
> > to address all warnings on linux-next in make htmldocs and follow up
> > with all the discussions. I can also provide a short weekly summary
> > (probably always on Friday) on what is pending where and what I could
> > not resolve by myself.
> >
> > Is that okay for you?
> >
> > If at some point I do not have the time to take care anymore, I will
> > let you know.
>
> Yeah, sure!
>
> Anyway, after applying the patches I sent this week, the warnings
> I'm getting are all due to the validation scripts I wrote. So, if
> everything gets merged (either yours or my version), we'll have zero
> Sphinx/kernel-doc warnings again.
>
It is a never ending story... I already have seen two new warnings on
today's linux-next and sent out patches.
> $ scripts/documentation-file-ref-check
> $ scripts/get_abi.pl validate
I will also try out those two scripts, but I cannot commit to
follow-up on all of those yet. I am also looking into addressing all
kerneldoc warnings, even if not pulled in by make htmldocs.
Lukas
Em Fri, 15 Jan 2021 13:36:23 +0100
Mauro Carvalho Chehab <[email protected]> escreveu:
> Em Fri, 15 Jan 2021 13:05:56 +0100
> Lukas Bulwahn <[email protected]> escreveu:
>
> > On Fri, Jan 15, 2021 at 10:49 AM Mauro Carvalho Chehab
> > <[email protected]> wrote:
> > >
> > > Hi Lukas,
> > >
> > > Em Fri, 15 Jan 2021 07:12:38 +0100
> > > Lukas Bulwahn <[email protected]> escreveu:
> > >
> > > > [reduced the recipient list to the main responsible ones and list]
> > > >
> > > > Hi Mauro, hi Jonathan,
> > > >
> > > > We both, Mauro and I, have been submitting patches to address the
> > > > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > > > would like to take responsibility for the task to send out the patches
> > > > to address all warnings on linux-next in make htmldocs and follow up
> > > > with all the discussions. I can also provide a short weekly summary
> > > > (probably always on Friday) on what is pending where and what I could
> > > > not resolve by myself.
> > > >
> > > > Is that okay for you?
> > > >
> > > > If at some point I do not have the time to take care anymore, I will
> > > > let you know.
> > >
> > > Yeah, sure!
> > >
> > > Anyway, after applying the patches I sent this week, the warnings
> > > I'm getting are all due to the validation scripts I wrote. So, if
> > > everything gets merged (either yours or my version), we'll have zero
> > > Sphinx/kernel-doc warnings again.
> > >
> >
> > It is a never ending story... I already have seen two new warnings on
> > today's linux-next and sent out patches.
>
> Yes, I know. After 5.10, it is easier to track new stuff, as
> Sphinx/kernel-doc warnings were all shut up there.
>
> >
> > > $ scripts/documentation-file-ref-check
> > > $ scripts/get_abi.pl validate
> >
> > I will also try out those two scripts, but I cannot commit to
> > follow-up on all of those yet.
>
> Yeah, some of those are not trivial to address.
>
> FYI, those are called by default after make allmodconfig/allyesconfig.
>
> > I am also looking into addressing all
> > kerneldoc warnings, even if not pulled in by make htmldocs.
>
> Make sense. There are lots of kerneldoc warnings for files that
> aren't currently part of the docs building system. It makes sense to
> fix those and add them to the Sphinx build logic.
>
> Here, I have a local script that checks for those:
>
> for i in $(git grep -h "\.\.\s*kernel-doc::" Documentation/|cut -d':' -f 3|grep -vE "\bsource$"|sort|uniq); do
> ./scripts/kernel-doc --none $i
> done
>
> It reports 101 warnings against next-20210114.
In time: those are for the ones that are included, but that
doesn't have all symbols added. I have another one somewhere
that does a more deeply check. I submitted it as a RFC sometime
ago to the docs ML:
https://git.linuxtv.org/mchehab/experimental.git/tree/scripts/docs_check_exports?h=doc_export_symbol&id=3f7d1e1b0bcdbe1d95eaa4b256259dfaa08faece
Such script checks only exported symbols.
Thanks,
Mauro
Em Fri, 15 Jan 2021 13:05:56 +0100
Lukas Bulwahn <[email protected]> escreveu:
> On Fri, Jan 15, 2021 at 10:49 AM Mauro Carvalho Chehab
> <[email protected]> wrote:
> >
> > Hi Lukas,
> >
> > Em Fri, 15 Jan 2021 07:12:38 +0100
> > Lukas Bulwahn <[email protected]> escreveu:
> >
> > > [reduced the recipient list to the main responsible ones and list]
> > >
> > > Hi Mauro, hi Jonathan,
> > >
> > > We both, Mauro and I, have been submitting patches to address the
> > > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > > would like to take responsibility for the task to send out the patches
> > > to address all warnings on linux-next in make htmldocs and follow up
> > > with all the discussions. I can also provide a short weekly summary
> > > (probably always on Friday) on what is pending where and what I could
> > > not resolve by myself.
> > >
> > > Is that okay for you?
> > >
> > > If at some point I do not have the time to take care anymore, I will
> > > let you know.
> >
> > Yeah, sure!
> >
> > Anyway, after applying the patches I sent this week, the warnings
> > I'm getting are all due to the validation scripts I wrote. So, if
> > everything gets merged (either yours or my version), we'll have zero
> > Sphinx/kernel-doc warnings again.
> >
>
> It is a never ending story... I already have seen two new warnings on
> today's linux-next and sent out patches.
Yes, I know. After 5.10, it is easier to track new stuff, as
Sphinx/kernel-doc warnings were all shut up there.
>
> > $ scripts/documentation-file-ref-check
> > $ scripts/get_abi.pl validate
>
> I will also try out those two scripts, but I cannot commit to
> follow-up on all of those yet.
Yeah, some of those are not trivial to address.
FYI, those are called by default after make allmodconfig/allyesconfig.
> I am also looking into addressing all
> kerneldoc warnings, even if not pulled in by make htmldocs.
Make sense. There are lots of kerneldoc warnings for files that
aren't currently part of the docs building system. It makes sense to
fix those and add them to the Sphinx build logic.
Here, I have a local script that checks for those:
for i in $(git grep -h "\.\.\s*kernel-doc::" Documentation/|cut -d':' -f 3|grep -vE "\bsource$"|sort|uniq); do
./scripts/kernel-doc --none $i
done
It reports 101 warnings against next-20210114.
Thanks,
Mauro
On Fri, 15 Jan 2021 10:49:47 +0100
Mauro Carvalho Chehab <[email protected]> wrote:
> Hi Lukas,
>
> Em Fri, 15 Jan 2021 07:12:38 +0100
> Lukas Bulwahn <[email protected]> escreveu:
>
> > [reduced the recipient list to the main responsible ones and list]
> >
> > Hi Mauro, hi Jonathan,
> >
> > We both, Mauro and I, have been submitting patches to address the
> > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > would like to take responsibility for the task to send out the patches
> > to address all warnings on linux-next in make htmldocs and follow up
> > with all the discussions. I can also provide a short weekly summary
> > (probably always on Friday) on what is pending where and what I could
> > not resolve by myself.
> >
> > Is that okay for you?
> >
> > If at some point I do not have the time to take care anymore, I will
> > let you know.
>
> Yeah, sure!
>
> Anyway, after applying the patches I sent this week, the warnings
> I'm getting are all due to the validation scripts I wrote. So, if
> everything gets merged (either yours or my version), we'll have zero
> Sphinx/kernel-doc warnings again.
>
> The script-validation warnings are:
>
> 1. Broken cross references
> --------------------------
>
> $ scripts/documentation-file-ref-check
> Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml
> Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml
> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml
> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml
> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml
> Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
>
> It sounds that part of the above is due to DT patches that weren't
> merged yet, but there are a few others that can be solved, but may
> require discussions with some Kernel developers/maintainers.
>
> 2. Duplicated ABI definitions
> -----------------------------
>
> $ scripts/get_abi.pl validate
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599
> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588
> Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> 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:45
> Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4
> Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0
> Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27
>
> Perhaps you could check with Jonathan Cameron some strategy to address
> the IIO warnings.
I'm being a bit rubbish on those ones. All need a bit of thought...
I'll try to kill off a few of them this weekend as *touch wood* my
review queue is looking fairly short.
Jonathan
>
> Thanks,
> Mauro
On Fri, 15 Jan 2021 07:12:38 +0100
Lukas Bulwahn <[email protected]> wrote:
> We both, Mauro and I, have been submitting patches to address the
> documentation warnings on linux-next. If it is okay with you, Mauro, I
> would like to take responsibility for the task to send out the patches
> to address all warnings on linux-next in make htmldocs and follow up
> with all the discussions. I can also provide a short weekly summary
> (probably always on Friday) on what is pending where and what I could
> not resolve by myself.
>
> Is that okay for you?
I'm certainly not going to complain about warning fixes! If you want to
take up this work, all I can say is - I'm looking forward to the patches.
Thanks for doing this.
jon
On Fri, 15 Jan 2021 13:47:20 +0000
Jonathan Cameron <[email protected]> wrote:
> On Fri, 15 Jan 2021 10:49:47 +0100
> Mauro Carvalho Chehab <[email protected]> wrote:
>
> > Hi Lukas,
> >
> > Em Fri, 15 Jan 2021 07:12:38 +0100
> > Lukas Bulwahn <[email protected]> escreveu:
> >
> > > [reduced the recipient list to the main responsible ones and list]
> > >
> > > Hi Mauro, hi Jonathan,
> > >
> > > We both, Mauro and I, have been submitting patches to address the
> > > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > > would like to take responsibility for the task to send out the patches
> > > to address all warnings on linux-next in make htmldocs and follow up
> > > with all the discussions. I can also provide a short weekly summary
> > > (probably always on Friday) on what is pending where and what I could
> > > not resolve by myself.
> > >
> > > Is that okay for you?
> > >
> > > If at some point I do not have the time to take care anymore, I will
> > > let you know.
> >
> > Yeah, sure!
> >
> > Anyway, after applying the patches I sent this week, the warnings
> > I'm getting are all due to the validation scripts I wrote. So, if
> > everything gets merged (either yours or my version), we'll have zero
> > Sphinx/kernel-doc warnings again.
> >
> > The script-validation warnings are:
> >
> > 1. Broken cross references
> > --------------------------
> >
> > $ scripts/documentation-file-ref-check
> > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml
> > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml
> > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml
> > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml
> > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml
> > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> >
> > It sounds that part of the above is due to DT patches that weren't
> > merged yet, but there are a few others that can be solved, but may
> > require discussions with some Kernel developers/maintainers.
> >
> > 2. Duplicated ABI definitions
> > -----------------------------
> >
> > $ scripts/get_abi.pl validate
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> > 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:45
> > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4
> > Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0
> > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27
> >
> > Perhaps you could check with Jonathan Cameron some strategy to address
> > the IIO warnings.
>
> I'm being a bit rubbish on those ones. All need a bit of thought...
>
> I'll try to kill off a few of them this weekend as *touch wood* my
> review queue is looking fairly short.
As I mentioned in the cover letter for the series I've just sent out, I ran into
a bit of an understanding gap around the two counter cases. This isn't helped
by the fact it is at least partly deprecated ABI given the counter subsystem
has much richer ABI for these types of devices.
@Fabrice, Benjamin and William.
What do we do about that one?
Thanks,
Jonathan
>
> Jonathan
>
> >
> > Thanks,
> > Mauro
>
On Sun, Jan 17, 2021 at 03:42:18PM +0000, Jonathan Cameron wrote:
> On Fri, 15 Jan 2021 13:47:20 +0000
> Jonathan Cameron <[email protected]> wrote:
>
> > On Fri, 15 Jan 2021 10:49:47 +0100
> > Mauro Carvalho Chehab <[email protected]> wrote:
> >
> > > Hi Lukas,
> > >
> > > Em Fri, 15 Jan 2021 07:12:38 +0100
> > > Lukas Bulwahn <[email protected]> escreveu:
> > >
> > > > [reduced the recipient list to the main responsible ones and list]
> > > >
> > > > Hi Mauro, hi Jonathan,
> > > >
> > > > We both, Mauro and I, have been submitting patches to address the
> > > > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > > > would like to take responsibility for the task to send out the patches
> > > > to address all warnings on linux-next in make htmldocs and follow up
> > > > with all the discussions. I can also provide a short weekly summary
> > > > (probably always on Friday) on what is pending where and what I could
> > > > not resolve by myself.
> > > >
> > > > Is that okay for you?
> > > >
> > > > If at some point I do not have the time to take care anymore, I will
> > > > let you know.
> > >
> > > Yeah, sure!
> > >
> > > Anyway, after applying the patches I sent this week, the warnings
> > > I'm getting are all due to the validation scripts I wrote. So, if
> > > everything gets merged (either yours or my version), we'll have zero
> > > Sphinx/kernel-doc warnings again.
> > >
> > > The script-validation warnings are:
> > >
> > > 1. Broken cross references
> > > --------------------------
> > >
> > > $ scripts/documentation-file-ref-check
> > > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml
> > > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml
> > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml
> > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml
> > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml
> > > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > >
> > > It sounds that part of the above is due to DT patches that weren't
> > > merged yet, but there are a few others that can be solved, but may
> > > require discussions with some Kernel developers/maintainers.
> > >
> > > 2. Duplicated ABI definitions
> > > -----------------------------
> > >
> > > $ scripts/get_abi.pl validate
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> > > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> > > 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:45
> > > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4
> > > Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0
> > > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27
> > >
> > > Perhaps you could check with Jonathan Cameron some strategy to address
> > > the IIO warnings.
> >
> > I'm being a bit rubbish on those ones. All need a bit of thought...
> >
> > I'll try to kill off a few of them this weekend as *touch wood* my
> > review queue is looking fairly short.
>
> As I mentioned in the cover letter for the series I've just sent out, I ran into
> a bit of an understanding gap around the two counter cases. This isn't helped
> by the fact it is at least partly deprecated ABI given the counter subsystem
> has much richer ABI for these types of devices.
>
> @Fabrice, Benjamin and William.
> What do we do about that one?
>
> Thanks,
>
> Jonathan
I'd consider the IIO counter ABI as entirely deprecated -- the Counter
subsystem supports all the functionality that's provided by the IIO
counter ABI, as well as additional functionality that is missing.
Regarding the iio:deviceX/in_count_quadrature_mode_available attribute:
superseded by the Counter subsystem counterX/countY/function attribute.
The IIO counter ABI allows users to select between a quadrature counting
mode or a non-quadrature counting mode; unfortunately, it does not
specify what kind of quadrature or what kind of non-quadrature counting
is actually being performed by the device.
Because the 104-quad-8 and stm32-lptimer-cnt drivers were the only ones
to use this attribute, they are luckily in sync -- both define the same
possible modes available: "quadrature" and "non-quadrature". You could
simply consolidate this attribute to the main sys-bus-iio file in order
to resolve this warning.
Given that it has already been superceded by the Counter subsystem, I'd
also be all right with just removing the IIO Counter ABI entirely from
the codebase, or alternatively setting a future date for removal.
William Breathitt Gray
> >
> > Jonathan
> >
> > >
> > > Thanks,
> > > Mauro
> >
>
On Tue, 19 Jan 2021 18:17:05 +0900
William Breathitt Gray <[email protected]> wrote:
> On Sun, Jan 17, 2021 at 03:42:18PM +0000, Jonathan Cameron wrote:
> > On Fri, 15 Jan 2021 13:47:20 +0000
> > Jonathan Cameron <[email protected]> wrote:
> >
> > > On Fri, 15 Jan 2021 10:49:47 +0100
> > > Mauro Carvalho Chehab <[email protected]> wrote:
> > >
> > > > Hi Lukas,
> > > >
> > > > Em Fri, 15 Jan 2021 07:12:38 +0100
> > > > Lukas Bulwahn <[email protected]> escreveu:
> > > >
> > > > > [reduced the recipient list to the main responsible ones and list]
> > > > >
> > > > > Hi Mauro, hi Jonathan,
> > > > >
> > > > > We both, Mauro and I, have been submitting patches to address the
> > > > > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > > > > would like to take responsibility for the task to send out the patches
> > > > > to address all warnings on linux-next in make htmldocs and follow up
> > > > > with all the discussions. I can also provide a short weekly summary
> > > > > (probably always on Friday) on what is pending where and what I could
> > > > > not resolve by myself.
> > > > >
> > > > > Is that okay for you?
> > > > >
> > > > > If at some point I do not have the time to take care anymore, I will
> > > > > let you know.
> > > >
> > > > Yeah, sure!
> > > >
> > > > Anyway, after applying the patches I sent this week, the warnings
> > > > I'm getting are all due to the validation scripts I wrote. So, if
> > > > everything gets merged (either yours or my version), we'll have zero
> > > > Sphinx/kernel-doc warnings again.
> > > >
> > > > The script-validation warnings are:
> > > >
> > > > 1. Broken cross references
> > > > --------------------------
> > > >
> > > > $ scripts/documentation-file-ref-check
> > > > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > > > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml
> > > > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > > > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml
> > > > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > >
> > > > It sounds that part of the above is due to DT patches that weren't
> > > > merged yet, but there are a few others that can be solved, but may
> > > > require discussions with some Kernel developers/maintainers.
> > > >
> > > > 2. Duplicated ABI definitions
> > > > -----------------------------
> > > >
> > > > $ scripts/get_abi.pl validate
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> > > > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> > > > 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:45
> > > > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4
> > > > Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0
> > > > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27
> > > >
> > > > Perhaps you could check with Jonathan Cameron some strategy to address
> > > > the IIO warnings.
> > >
> > > I'm being a bit rubbish on those ones. All need a bit of thought...
> > >
> > > I'll try to kill off a few of them this weekend as *touch wood* my
> > > review queue is looking fairly short.
> >
> > As I mentioned in the cover letter for the series I've just sent out, I ran into
> > a bit of an understanding gap around the two counter cases. This isn't helped
> > by the fact it is at least partly deprecated ABI given the counter subsystem
> > has much richer ABI for these types of devices.
> >
> > @Fabrice, Benjamin and William.
> > What do we do about that one?
> >
> > Thanks,
> >
> > Jonathan
>
> I'd consider the IIO counter ABI as entirely deprecated -- the Counter
> subsystem supports all the functionality that's provided by the IIO
> counter ABI, as well as additional functionality that is missing.
>
> Regarding the iio:deviceX/in_count_quadrature_mode_available attribute:
> superseded by the Counter subsystem counterX/countY/function attribute.
> The IIO counter ABI allows users to select between a quadrature counting
> mode or a non-quadrature counting mode; unfortunately, it does not
> specify what kind of quadrature or what kind of non-quadrature counting
> is actually being performed by the device.
>
> Because the 104-quad-8 and stm32-lptimer-cnt drivers were the only ones
> to use this attribute, they are luckily in sync -- both define the same
> possible modes available: "quadrature" and "non-quadrature". You could
> simply consolidate this attribute to the main sys-bus-iio file in order
> to resolve this warning.
>
> Given that it has already been superceded by the Counter subsystem, I'd
> also be all right with just removing the IIO Counter ABI entirely from
> the codebase, or alternatively setting a future date for removal.
I agree that we should look to remove this ABI. If we can establish no one
is relying on it today then we can drop quickly. If not it would be good
to establish when we drop it.
Fabrice, Benjami any thoughts on the stm32-lptimer-cnt?
I'm going to hazard a guess that there aren't many 104-quad-8 users
that you don't know about William, so if you think we can immediately drop
the interface from that, lets do so, whether or not we can clean up
the stm32 one at the same time.
Jonathan
>
> William Breathitt Gray
>
> > >
> > > Jonathan
> > >
> > > >
> > > > Thanks,
> > > > Mauro
> > >
> >
>
On 1/19/21 11:41 AM, Jonathan Cameron wrote:
> On Tue, 19 Jan 2021 18:17:05 +0900
> William Breathitt Gray <[email protected]> wrote:
>
>> On Sun, Jan 17, 2021 at 03:42:18PM +0000, Jonathan Cameron wrote:
>>> On Fri, 15 Jan 2021 13:47:20 +0000
>>> Jonathan Cameron <[email protected]> wrote:
>>>
>>>> On Fri, 15 Jan 2021 10:49:47 +0100
>>>> Mauro Carvalho Chehab <[email protected]> wrote:
>>>>
>>>>> Hi Lukas,
>>>>>
>>>>> Em Fri, 15 Jan 2021 07:12:38 +0100
>>>>> Lukas Bulwahn <[email protected]> escreveu:
>>>>>
>>>>>> [reduced the recipient list to the main responsible ones and list]
>>>>>>
>>>>>> Hi Mauro, hi Jonathan,
>>>>>>
>>>>>> We both, Mauro and I, have been submitting patches to address the
>>>>>> documentation warnings on linux-next. If it is okay with you, Mauro, I
>>>>>> would like to take responsibility for the task to send out the patches
>>>>>> to address all warnings on linux-next in make htmldocs and follow up
>>>>>> with all the discussions. I can also provide a short weekly summary
>>>>>> (probably always on Friday) on what is pending where and what I could
>>>>>> not resolve by myself.
>>>>>>
>>>>>> Is that okay for you?
>>>>>>
>>>>>> If at some point I do not have the time to take care anymore, I will
>>>>>> let you know.
>>>>>
>>>>> Yeah, sure!
>>>>>
>>>>> Anyway, after applying the patches I sent this week, the warnings
>>>>> I'm getting are all due to the validation scripts I wrote. So, if
>>>>> everything gets merged (either yours or my version), we'll have zero
>>>>> Sphinx/kernel-doc warnings again.
>>>>>
>>>>> The script-validation warnings are:
>>>>>
>>>>> 1. Broken cross references
>>>>> --------------------------
>>>>>
>>>>> $ scripts/documentation-file-ref-check
>>>>> Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
>>>>> Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
>>>>> Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
>>>>> Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
>>>>> Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml
>>>>> Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
>>>>> Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
>>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml
>>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml
>>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml
>>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml
>>>>> Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
>>>>> Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
>>>>>
>>>>> It sounds that part of the above is due to DT patches that weren't
>>>>> merged yet, but there are a few others that can be solved, but may
>>>>> require discussions with some Kernel developers/maintainers.
>>>>>
>>>>> 2. Duplicated ABI definitions
>>>>> -----------------------------
>>>>>
>>>>> $ scripts/get_abi.pl validate
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
>>>>> Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
>>>>> 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:45
>>>>> Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4
>>>>> Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0
>>>>> Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27
>>>>>
>>>>> Perhaps you could check with Jonathan Cameron some strategy to address
>>>>> the IIO warnings.
>>>>
>>>> I'm being a bit rubbish on those ones. All need a bit of thought...
>>>>
>>>> I'll try to kill off a few of them this weekend as *touch wood* my
>>>> review queue is looking fairly short.
>>>
>>> As I mentioned in the cover letter for the series I've just sent out, I ran into
>>> a bit of an understanding gap around the two counter cases. This isn't helped
>>> by the fact it is at least partly deprecated ABI given the counter subsystem
>>> has much richer ABI for these types of devices.
>>>
>>> @Fabrice, Benjamin and William.
>>> What do we do about that one?
>>>
>>> Thanks,
>>>
>>> Jonathan
>>
>> I'd consider the IIO counter ABI as entirely deprecated -- the Counter
>> subsystem supports all the functionality that's provided by the IIO
>> counter ABI, as well as additional functionality that is missing.
>>
>> Regarding the iio:deviceX/in_count_quadrature_mode_available attribute:
>> superseded by the Counter subsystem counterX/countY/function attribute.
>> The IIO counter ABI allows users to select between a quadrature counting
>> mode or a non-quadrature counting mode; unfortunately, it does not
>> specify what kind of quadrature or what kind of non-quadrature counting
>> is actually being performed by the device.
>>
>> Because the 104-quad-8 and stm32-lptimer-cnt drivers were the only ones
>> to use this attribute, they are luckily in sync -- both define the same
>> possible modes available: "quadrature" and "non-quadrature". You could
>> simply consolidate this attribute to the main sys-bus-iio file in order
>> to resolve this warning.
>>
>> Given that it has already been superceded by the Counter subsystem, I'd
>> also be all right with just removing the IIO Counter ABI entirely from
>> the codebase, or alternatively setting a future date for removal.
>
> I agree that we should look to remove this ABI. If we can establish no one
> is relying on it today then we can drop quickly. If not it would be good
> to establish when we drop it.
>
> Fabrice, Benjami any thoughts on the stm32-lptimer-cnt?
Hi Jonathan, William,
I apologize for the late reply, being busy on other topics. I think the
stm32 timer driver need some cleanup to remove this ABI:
- stm32-lptimer-counter indeed is similar to 104-quad-8 driver. It still
registers an IIO device with the "preset" attribute pointed out in the
doc warning. Yes, the counter interface covers the same.
So, I agree this ABI could be removed here. Still, I don't know if there
are users for the IIO counter ABI.
Dummy question... Is it needed to drop driver part and ABI, at the same
time ?
- stm32-timer-trigger driver which resides in iio, also registers preset
attr being pointed out above. I'm more concerned there: I think some
modes may depend on the preset attr, even for the trigger. Partial
removal was done by Benjamin earlier (after stm32-timer-cnt addition).
still I need to double check this.
At least dropping the stm32-lptimer-counter part, should avoid the
Warning here. So it may probably be ok in the short term?
Please advise,
Best Regards,
Fabrice
>
> I'm going to hazard a guess that there aren't many 104-quad-8 users
> that you don't know about William, so if you think we can immediately drop
> the interface from that, lets do so, whether or not we can clean up
> the stm32 one at the same time.
>
> Jonathan
>
>>
>> William Breathitt Gray
>>
>>>>
>>>> Jonathan
>>>>
>>>>>
>>>>> Thanks,
>>>>> Mauro
>>>>
>>>
>>
>