Skip to contentSkip to conversation

Documentation build warning fixes

PATCH In review Mauro Carvalho Chehab 6 participants 16 messages May 19, 2021 – May 25, 2021

Subsystems (10)
Documentation KVM GPIO IIO +6 more subsystems
lore
Share & tools
lore

Mauro Carvalho Chehab

author
#0 lore raw

cover Documentation build warning fixes

Hi Jon,

This small series contain a series of fixes for the documentation. it is against your docs-next branch.

Three of the patches fix duplicated symbols at the ABI documents. There are still some ABI warnings from IIO, but all but one were already fixed at linux-next. So, hopefully, after having everything merged, the ABI warnings will be solved.

Mauro Carvalho Chehab (10):
docs: update sysfs-platform_profile.rst reference
docs: vcpu-requests.rst: fix reference for atomic ops
docs: translations/zh_CN: fix a typo at 8.Conclusion.rst
docs: sched-bwc.rst: fix a typo on a doc name
docs: update pin-control.rst references
docs: virt: api.rst: fix a pointer to SGX documentation
docs: ABI: iommu: remove duplicated definition for
sysfs-kernel-iommu_groups
docs: ABI: sysfs-class-backlight: unify ambient light zone nodes
docs: ABI: sysfs-class-led-trigger-pattern: remove repeat duplication
iio: documentation: fix a typo

 Documentation/ABI/testing/sysfs-bus-iio       |   4 +-
 .../ABI/testing/sysfs-class-backlight         | 100 ++++++++++++++++++
 .../ABI/testing/sysfs-class-backlight-adp5520 |  31 ------
 .../ABI/testing/sysfs-class-backlight-adp8860 |  37 -------
 .../sysfs-class-backlight-driver-adp8870      |  32 ------
 .../testing/sysfs-class-led-driver-el15203000 |   9 --
 .../testing/sysfs-class-led-trigger-pattern   |   3 +
 .../ABI/testing/sysfs-kernel-iommu_groups     |  12 +--
 Documentation/scheduler/sched-bwc.rst         |   2 +-
 .../zh_CN/process/8.Conclusion.rst            |   2 +-
 Documentation/virt/kvm/api.rst                |   2 +-
 Documentation/virt/kvm/vcpu-requests.rst      |   2 +-
 include/linux/device.h                        |   2 +-
 include/linux/mfd/madera/pdata.h              |   2 +-
 include/linux/pinctrl/pinconf-generic.h       |   2 +-
 include/linux/platform_profile.h              |   2 +-
 16 files changed, 117 insertions(+), 127 deletions(-)
 delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-adp5520
 delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-adp8860
 delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870
 delete mode 100644 Documentation/ABI/testing/sysfs-class-led-driver-el15203000
Signature · 1 line
2.31.1
author
#1 lore raw

PATCH 1/10 docs: update sysfs-platform_profile.rst reference

The file name: Documentation/ABI/testing/sysfs-platform_profile.rst should be, instead: Documentation/userspace-api/sysfs-platform_profile.rst.

Update its cross-reference accordingly.

Fixes a2ff95e018f1 ("ACPI: platform: Add platform profile support")
Fixes 8e0cbf356377 ("Documentation: Add documentation for new platform_profile sysfs attribute")
Reviewed-by Hans de Goede <[email protected]>
Reviewed-by Mark Pearson <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 include/linux/platform_profile.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/platform_profile.h +1 -1
index a6329003aee7..e5cbb6841f3a 100644
@@ -2,7 +2,7 @@
 /*
  * Platform profile sysfs interface
  *
- * See Documentation/ABI/testing/sysfs-platform_profile.rst for more
+ * See Documentation/userspace-api/sysfs-platform_profile.rst for more
  * information.
  */
Signature · 1 line
2.31.1
author
#2 lore raw

PATCH 2/10 docs: vcpu-requests.rst: fix reference for atomic ops

In reply to Mauro Carvalho Chehab

Changeset f0400a77ebdc ("atomic: Delete obsolete documentation") got rid of atomic_ops.rst, pointing that this was superseded by Documentation/atomic_*.txt.

Update its reference accordingly.

Fixes f0400a77ebdc ("atomic: Delete obsolete documentation")
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/virt/kvm/vcpu-requests.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/vcpu-requests.rst +1 -1
index 5feb3706a7ae..5f8798e7fdf8 100644
@@ -302,6 +302,6 @@ VCPU returns from the call.
 References
 ==========
 
-.. [atomic-ops] Documentation/core-api/atomic_ops.rst
+.. [atomic-ops] Documentation/atomic_bitops.txt and Documentation/atomic_t.txt
 .. [memory-barriers] Documentation/memory-barriers.txt
 .. [lwn-mb] https://lwn.net/Articles/573436/
Signature · 1 line
2.31.1
author
#3 lore raw

PATCH 3/10 docs: translations/zh_CN: fix a typo at 8.Conclusion.rst

In reply to Mauro Carvalho Chehab

transaltions -> translations

Acked-by Wu XiangCheng <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/translations/zh_CN/process/8.Conclusion.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/translations/zh_CN/process/8.Conclusion.rst +1 -1
index 71c3e30efc6f..4707f0101964 100644
@@ -19,7 +19,7 @@
 :ref:`Documentation/translations/zh_CN/process/howto.rst <cn_process_howto>`
 文件是一个重要的起点；
 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
-和 :ref:`Documentation/transaltions/zh_CN/process/submitting-drivers.rst <cn_submittingdrivers>`
+和 :ref:`Documentation/translations/zh_CN/process/submitting-drivers.rst <cn_submittingdrivers>`
 也是所有内核开发人员都应该阅读的内容。许多内部内核API都是使用kerneldoc机制
 记录的；“make htmldocs”或“make pdfdocs”可用于以HTML或PDF格式生成这些文档
 （尽管某些发行版提供的tex版本会遇到内部限制，无法正确处理文档）。
Signature · 1 line
2.31.1
author
#4 lore raw

PATCH 4/10 docs: sched-bwc.rst: fix a typo on a doc name

In reply to Mauro Carvalho Chehab

cgroupv2.rst -> cgroup-v2.rst

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/scheduler/sched-bwc.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/scheduler/sched-bwc.rst +1 -1
index 845eee659199..1fc73555f5c4 100644
@@ -29,7 +29,7 @@ Quota and period are managed within the cpu subsystem via cgroupfs.
 .. note::
    The cgroupfs files described in this section are only applicable
    to cgroup v1. For cgroup v2, see
-   :ref:`Documentation/admin-guide/cgroupv2.rst <cgroup-v2-cpu>`.
+   :ref:`Documentation/admin-guide/cgroup-v2.rst <cgroup-v2-cpu>`.
 
 - cpu.cfs_quota_us: the total available run-time within a period (in
   microseconds)
Signature · 1 line
2.31.1
author
#5 lore raw

PATCH 5/10 docs: update pin-control.rst references

In reply to Mauro Carvalho Chehab

Changeset 5513b411ea5b ("Documentation: rename pinctl to pin-control")
renamed: Documentation/driver-api/pinctl.rst
to: Documentation/driver-api/pin-control.rst.

Update the cross-references accordingly.

Fixes 5513b411ea5b ("Documentation: rename pinctl to pin-control")
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 include/linux/device.h                  | 2 +-
 include/linux/mfd/madera/pdata.h        | 2 +-
 include/linux/pinctrl/pinconf-generic.h | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
include/linux/device.h +1 -1
index 38a2071cf776..d1183cfdc8fb 100644
@@ -399,7 +399,7 @@ struct dev_links_info {
  * 		along with subsystem-level and driver-level callbacks.
  * @em_pd:	device's energy model performance domain
  * @pins:	For device pin management.
- *		See Documentation/driver-api/pinctl.rst for details.
+ *		See Documentation/driver-api/pin-control.rst for details.
  * @msi_list:	Hosts MSI descriptors
  * @msi_domain: The generic MSI domain this device is using.
  * @numa_node:	NUMA node this device is close to.
include/linux/mfd/madera/pdata.h +1 -1
index 601cbbc10370..32e3470708ed 100644
@@ -31,7 +31,7 @@ struct pinctrl_map;
  * @irq_flags:	    Mode for primary IRQ (defaults to active low)
  * @gpio_base:	    Base GPIO number
  * @gpio_configs:   Array of GPIO configurations (See
- *		    Documentation/driver-api/pinctl.rst)
+ *		    Documentation/driver-api/pin-control.rst)
  * @n_gpio_configs: Number of entries in gpio_configs
  * @gpsw:	    General purpose switch mode setting. Depends on the external
  *		    hardware connected to the switch. (See the SW1_MODE field
include/linux/pinctrl/pinconf-generic.h +1 -1
index e18ab3d5908f..5a96602a3316 100644
@@ -89,7 +89,7 @@ struct pinctrl_map;
  * 	it.
  * @PIN_CONFIG_OUTPUT: this will configure the pin as an output and drive a
  * 	value on the line. Use argument 1 to indicate high level, argument 0 to
- *	indicate low level. (Please see Documentation/driver-api/pinctl.rst,
+ *	indicate low level. (Please see Documentation/driver-api/pin-control.rst,
  *	section "GPIO mode pitfalls" for a discussion around this parameter.)
  * @PIN_CONFIG_PERSIST_STATE: retain pin state across sleep or controller reset
  * @PIN_CONFIG_POWER_SOURCE: if the pin can select between different power
Signature · 1 line
2.31.1
maintainer Acked-by on v1 5/10
#6 lore raw

Re: [PATCH 05/10] docs: update pin-control.rst references

Quoted 9 lines · Mauro Carvalho Chehab

Changeset 5513b411ea5b ("Documentation: rename pinctl to pin-control")
renamed: Documentation/driver-api/pinctl.rst
to: Documentation/driver-api/pin-control.rst.

Update the cross-references accordingly.

Fixes 5513b411ea5b ("Documentation: rename pinctl to pin-control")
Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

For the Madera change:

Acked-by Charles Keepax <[email protected]>

Thanks,
Charles

Acked-by on v1 5/10
#7 lore raw

Re: [PATCH 05/10] docs: update pin-control.rst references

In reply to Mauro Carvalho Chehab
Quoted 4 lines · Mauro Carvalho Chehab

Changeset 5513b411ea5b ("Documentation: rename pinctl to pin-control")
renamed: Documentation/driver-api/pinctl.rst
to: Documentation/driver-api/pin-control.rst.

Quoted 8 lines

Update the cross-references accordingly.

Fixes 5513b411ea5b ("Documentation: rename pinctl to pin-control")
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 include/linux/device.h                  | 2 +-
 include/linux/mfd/madera/pdata.h        | 2 +-
Acked-by Lee Jones <[email protected]>
Quoted 2 lines
 include/linux/pinctrl/pinconf-generic.h | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
Acked-by on v1 5/10
#8 lore raw

Re: [PATCH 05/10] docs: update pin-control.rst references

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

Changeset 5513b411ea5b ("Documentation: rename pinctl to pin-control")
renamed: Documentation/driver-api/pinctl.rst
to: Documentation/driver-api/pin-control.rst.

Update the cross-references accordingly.

Fixes 5513b411ea5b ("Documentation: rename pinctl to pin-control")
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Acked-by Linus Walleij <[email protected]>

I suppose you take it through the doc tree? I can apply it if you prefer.

Yours,
Linus Walleij

author
#9 lore raw

PATCH 6/10 docs: virt: api.rst: fix a pointer to SGX documentation

In reply to Mauro Carvalho Chehab

The document which describes the SGX kernel architecture was added at commit 3fa97bf00126 ("Documentation/x86: Document SGX kernel architecture")

but the reference at virt/kvm/api.rst is pointing to some non-existing document.

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
index 22d077562149..e86fe3481574 100644
@@ -6360,7 +6360,7 @@ system fingerprint.  To prevent userspace from circumventing such restrictions
 by running an enclave in a VM, KVM prevents access to privileged attributes by
 default.
 
-See Documentation/x86/sgx/2.Kernel-internals.rst for more details.
+See Documentation/x86/sgx.rst for more details.
 
 8. Other capabilities.
 ======================
Signature · 1 line
2.31.1
author
#10 lore raw

PATCH 7/10 docs: ABI: iommu: remove duplicated definition for sysfs-kernel-iommu_groups

In reply to Mauro Carvalho Chehab

./scripts/get_abi.pl is reporting a duplicated definition for /sys/kernel/iommu_groups/reserved_regions, both at the same file:

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

Fix it by merging those into an unified entry.

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/ABI/testing/sysfs-kernel-iommu_groups | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)
Documentation/ABI/testing/sysfs-kernel-iommu_groups +4 -8
index 0fedbb0f94e4..eae2f1c1e11e 100644
@@ -25,14 +25,10 @@ Description:    /sys/kernel/iommu_groups/reserved_regions list IOVA
 		the base IOVA, the second is the end IOVA and the third
 		field describes the type of the region.
 
-What:		/sys/kernel/iommu_groups/reserved_regions
-Date: 		June 2019
-KernelVersion:  v5.3
-Contact: 	Eric Auger <[email protected]>
-Description:    In case an RMRR is used only by graphics or USB devices
-		it is now exposed as "direct-relaxable" instead of "direct".
-		In device assignment use case, for instance, those RMRR
-		are considered to be relaxable and safe.
+		Since kernel 5.3, in case an RMRR is used only by graphics or
+		USB devices it is now exposed as "direct-relaxable" instead
+		of "direct". In device assignment use case, for instance,
+		those RMRR are considered to be relaxable and safe.
 
 What:		/sys/kernel/iommu_groups/<grp_id>/type
 Date:		November 2020
Signature · 1 line
2.31.1
author
#11 lore raw

PATCH 8/10 docs: ABI: sysfs-class-backlight: unify ambient light zone nodes

In reply to Mauro Carvalho Chehab

./scripts/get_abi.pl is warning about duplicated symbol definition:

Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12

What happens is that 3 drivers use the same pattern to report max and dim setting for different ambient light zones.

It should be noticed that the adp8870 doc was missing an entry for l1_daylight_dim, which was fixed on this patch.

While the ambient light zone is device-specific, the sysfs definition is actually common. So, unify them at:

Documentation/ABI/testing/sysfs-class-backlight

and use as the contact point, the e-mail reported by get_maintainers.pl for the subsystem.

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 .../ABI/testing/sysfs-class-backlight         | 100 ++++++++++++++++++
 .../ABI/testing/sysfs-class-backlight-adp5520 |  31 ------
 .../ABI/testing/sysfs-class-backlight-adp8860 |  37 -------
 .../sysfs-class-backlight-driver-adp8870      |  32 ------
 4 files changed, 100 insertions(+), 100 deletions(-)
 delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-adp5520
 delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-adp8860
 delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870
Documentation/ABI/testing/sysfs-class-backlight +100 -0
index 1fc86401bf95..c453646b06e2 100644
@@ -84,3 +84,103 @@ Description:
 		It can be enabled by writing the value stored in
 		/sys/class/backlight/<backlight>/max_brightness to
 		/sys/class/backlight/<backlight>/brightness.
+
+What:		/sys/class/backlight/<backlight>/<ambient light zone>_max
+Date:		Sep, 2009
+KernelVersion:	v2.6.32
+Contact:	[email protected]
+Description:
+		Control the maximum brightness for <ambient light zone>
+		on this <backlight>. Values are between 0 and 127. This file
+		will also show the brightness level stored for this
+		<ambient light zone>.
+
+		The <ambient light zone> is device-driver specific:
+
+		For ADP5520 and ADP5501, <ambient light zone> can be:
+
+		===========  ================================================
+		Ambient      sysfs entry
+		light zone
+		===========  ================================================
+		daylight     /sys/class/backlight/<backlight>/daylight_max
+		office       /sys/class/backlight/<backlight>/office_max
+		dark         /sys/class/backlight/<backlight>/dark_max
+		===========  ================================================
+
+		For ADP8860, <ambient light zone> can be:
+
+		===========  ================================================
+		Ambient      sysfs entry
+		light zone
+		===========  ================================================
+		l1_daylight  /sys/class/backlight/<backlight>/l1_daylight_max
+		l2_office    /sys/class/backlight/<backlight>/l2_office_max
+		l3_dark      /sys/class/backlight/<backlight>/l3_dark_max
+		===========  ================================================
+
+		For ADP8870, <ambient light zone> can be:
+
+		===========  ================================================
+		Ambient      sysfs entry
+		light zone
+		===========  ================================================
+		l1_daylight  /sys/class/backlight/<backlight>/l1_daylight_max
+		l2_bright    /sys/class/backlight/<backlight>/l2_bright_max
+		l3_office    /sys/class/backlight/<backlight>/l3_office_max
+		l4_indoor    /sys/class/backlight/<backlight>/l4_indoor_max
+		l5_dark      /sys/class/backlight/<backlight>/l5_dark_max
+		===========  ================================================
+
+		See also: /sys/class/backlight/<backlight>/ambient_light_zone.
+
+What:		/sys/class/backlight/<backlight>/<ambient light zone>_dim
+Date:		Sep, 2009
+KernelVersion:	v2.6.32
+Contact:	[email protected]
+Description:
+		Control the dim brightness for <ambient light zone>
+		on this <backlight>. Values are between 0 and 127, typically
+		set to 0. Full off when the backlight is disabled.
+		This file will also show the dim brightness level stored for
+		this <ambient light zone>.
+
+		The <ambient light zone> is device-driver specific:
+
+		For ADP5520 and ADP5501, <ambient light zone> can be:
+
+		===========  ================================================
+		Ambient      sysfs entry
+		light zone
+		===========  ================================================
+		daylight     /sys/class/backlight/<backlight>/daylight_dim
+		office       /sys/class/backlight/<backlight>/office_dim
+		dark         /sys/class/backlight/<backlight>/dark_dim
+		===========  ================================================
+
+		For ADP8860, <ambient light zone> can be:
+
+		===========  ================================================
+		Ambient      sysfs entry
+		light zone
+		===========  ================================================
+		l1_daylight  /sys/class/backlight/<backlight>/l1_daylight_dim
+		l2_office    /sys/class/backlight/<backlight>/l2_office_dim
+		l3_dark      /sys/class/backlight/<backlight>/l3_dark_dim
+		===========  ================================================
+
+		For ADP8870, <ambient light zone> can be:
+
+		===========  ================================================
+		Ambient      sysfs entry
+		light zone
+		===========  ================================================
+		l1_daylight  /sys/class/backlight/<backlight>/l1_daylight_dim
+		l2_bright    /sys/class/backlight/<backlight>/l2_bright_dim
+		l3_office    /sys/class/backlight/<backlight>/l3_office_dim
+		l4_indoor    /sys/class/backlight/<backlight>/l4_indoor_dim
+		l5_dark      /sys/class/backlight/<backlight>/l5_dark_dim
+		===========  ================================================
+
+		See also: /sys/class/backlight/<backlight>/ambient_light_zone.
+
Documentation/ABI/testing/sysfs-class-backlight-adp5520 deleted +0 -31
deleted file mode 100644
index 34b6ebafa210..000000000000
@@ -1,31 +0,0 @@
-sysfs interface for analog devices adp5520(01) backlight driver
----------------------------------------------------------------
-
-The backlight brightness control operates at three different levels for the
-adp5520 and adp5501 devices: daylight (level 1), office (level 2) and dark
-(level 3). By default the brightness operates at the daylight brightness level.
-
-What:		/sys/class/backlight/<backlight>/daylight_max
-What:		/sys/class/backlight/<backlight>/office_max
-What:		/sys/class/backlight/<backlight>/dark_max
-Date:		Sep, 2009
-KernelVersion:	v2.6.32
-Contact:	Michael Hennerich <[email protected]>
-Description:
-		(RW) Maximum current setting for the backlight when brightness
-		is at one of the three levels (daylight, office or dark). This
-		is an input code between 0 and 127, which is transformed to a
-		value between 0 mA and 30 mA using linear or non-linear
-		algorithms.
-
-What:		/sys/class/backlight/<backlight>/daylight_dim
-What:		/sys/class/backlight/<backlight>/office_dim
-What:		/sys/class/backlight/<backlight>/dark_dim
-Date:		Sep, 2009
-KernelVersion:	v2.6.32
-Contact:	Michael Hennerich <[email protected]>
-Description:
-		(RW) Dim current setting for the backlight when brightness is at
-		one of the three levels (daylight, office or dark). This is an
-		input code between 0 and 127, which is transformed to a value
-		between 0 mA and 30 mA using linear or non-linear algorithms.
Documentation/ABI/testing/sysfs-class-backlight-adp8860 deleted +0 -37
deleted file mode 100644
index 6610ac73f9ba..000000000000
@@ -1,37 +0,0 @@
-sysfs interface for analog devices adp8860 backlight driver
------------------------------------------------------------
-
-The backlight brightness control operates at three different levels for the
-adp8860, adp8861 and adp8863 devices: daylight (level 1), office (level 2) and
-dark (level 3). By default the brightness operates at the daylight brightness
-level.
-
-See also /sys/class/backlight/<backlight>/ambient_light_level and
-/sys/class/backlight/<backlight>/ambient_light_zone.
-
-
-What:		/sys/class/backlight/<backlight>/l1_daylight_max
-What:		/sys/class/backlight/<backlight>/l2_office_max
-What:		/sys/class/backlight/<backlight>/l3_dark_max
-Date:		Apr, 2010
-KernelVersion:	v2.6.35
-Contact:	Michael Hennerich <[email protected]>
-Description:
-		(RW) Maximum current setting for the backlight when brightness
-		is at one of the three levels (daylight, office or dark). This
-		is an input code between 0 and 127, which is transformed to a
-		value between 0 mA and 30 mA using linear or non-linear
-		algorithms.
-
-
-What:		/sys/class/backlight/<backlight>/l1_daylight_dim
-What:		/sys/class/backlight/<backlight>/l2_office_dim
-What:		/sys/class/backlight/<backlight>/l3_dark_dim
-Date:		Apr, 2010
-KernelVersion:	v2.6.35
-Contact:	Michael Hennerich <[email protected]>
-Description:
-		(RW) Dim current setting for the backlight when brightness is at
-		one of the three levels (daylight, office or dark). This is an
-		input code between 0 and 127, which is transformed to a value
-		between 0 mA and 30 mA using linear or non-linear algorithms.
Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870 deleted +0 -32
deleted file mode 100644
index b08ca912cad4..000000000000
@@ -1,32 +0,0 @@
-See also /sys/class/backlight/<backlight>/ambient_light_level and
-/sys/class/backlight/<backlight>/ambient_light_zone.
-
-What:		/sys/class/backlight/<backlight>/<ambient light zone>_max
-What:		/sys/class/backlight/<backlight>/l1_daylight_max
-What:		/sys/class/backlight/<backlight>/l2_bright_max
-What:		/sys/class/backlight/<backlight>/l3_office_max
-What:		/sys/class/backlight/<backlight>/l4_indoor_max
-What:		/sys/class/backlight/<backlight>/l5_dark_max
-Date:		May 2011
-KernelVersion:	3.0
-Contact:	[email protected]
-Description:
-		Control the maximum brightness for <ambient light zone>
-		on this <backlight>. Values are between 0 and 127. This file
-		will also show the brightness level stored for this
-		<ambient light zone>.
-
-What:		/sys/class/backlight/<backlight>/<ambient light zone>_dim
-What:		/sys/class/backlight/<backlight>/l2_bright_dim
-What:		/sys/class/backlight/<backlight>/l3_office_dim
-What:		/sys/class/backlight/<backlight>/l4_indoor_dim
-What:		/sys/class/backlight/<backlight>/l5_dark_dim
-Date:		May 2011
-KernelVersion:	3.0
-Contact:	[email protected]
-Description:
-		Control the dim brightness for <ambient light zone>
-		on this <backlight>. Values are between 0 and 127, typically
-		set to 0. Full off when the backlight is disabled.
-		This file will also show the dim brightness level stored for
-		this <ambient light zone>.
Signature · 1 line
2.31.1
author
#12 lore raw

PATCH 9/10 docs: ABI: sysfs-class-led-trigger-pattern: remove repeat duplication

In reply to Mauro Carvalho Chehab

As reported by scripts/get_abi.pl:

Warning: /sys/class/leds/<led>/repeat is defined 2 times: Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28

The definition for the EL15203000 is just a special case of the sysfs led class. So, drop it and mentions the possible exception at the class definition.

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 .../ABI/testing/sysfs-class-led-driver-el15203000        | 9 ---------
 .../ABI/testing/sysfs-class-led-trigger-pattern          | 3 +++
 2 files changed, 3 insertions(+), 9 deletions(-)
 delete mode 100644 Documentation/ABI/testing/sysfs-class-led-driver-el15203000
Documentation/ABI/testing/sysfs-class-led-driver-el15203000 deleted +0 -9
deleted file mode 100644
index 04f3ffdc5936..000000000000
@@ -1,9 +0,0 @@
-What:		/sys/class/leds/<led>/repeat
-Date:		September 2019
-KernelVersion:	5.5
-Description:
-		EL15203000 supports only indefinitely patterns,
-		so this file should always store -1.
-
-		For more info, please see:
-		Documentation/ABI/testing/sysfs-class-led-trigger-pattern
Documentation/ABI/testing/sysfs-class-led-trigger-pattern +3 -0
index d91a07767adf..8c57d2780554 100644
@@ -35,3 +35,6 @@ Description:
 
 		This file will always return the originally written repeat
 		number.
+
+		It should be noticed that some leds, like EL15203000 may
+		only support indefinitely patterns, so they always store -1.
Signature · 1 line
2.31.1
author
#13 lore raw

PATCH 10/10 iio: documentation: fix a typo

In reply to Mauro Carvalho Chehab

Descrption -> Description

This causes some errors when parsed via scripts/get_abi.pl.

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/ABI/testing/sysfs-bus-iio | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-bus-iio +2 -2
index 267973541e72..433fe0ab74be 100644
@@ -786,7 +786,7 @@ What:		/sys/.../events/in_capacitanceY_adaptive_thresh_rising_en
 What:		/sys/.../events/in_capacitanceY_adaptive_thresh_falling_en
 KernelVersion:	5.13
 Contact:	[email protected]
-Descrption:
+Description:
 		Adaptive thresholds are similar to normal fixed thresholds
 		but the value is expressed as an offset from a value which
 		provides a low frequency approximation of the channel itself.

@@ -798,7 +798,7 @@ What:		/sys/.../in_capacitanceY_adaptive_thresh_rising_timeout
 What:		/sys/.../in_capacitanceY_adaptive_thresh_falling_timeout
 KernelVersion:	5.11
 Contact:	[email protected]
-Descrption:
+Description:
 		When adaptive thresholds are used, the tracking signal
 		may adjust too slowly to step changes in the raw signal.
 		*_timeout (in seconds) specifies a time for which the
Signature · 1 line
2.31.1
#14 lore raw

Re: [PATCH 10/10] iio: documentation: fix a typo

Documentation/ABI/testing/sysfs-bus-iio What: /sys/.../in_capacitanceY_adaptive_thresh_rising_timeout · line 804

Quoted 9 lines · Mauro Carvalho Chehab
Documentation/ABI/testing/sysfs-bus-iio +1 -1
@@ -798,7 +798,7 @@ What:		/sys/.../in_capacitanceY_adaptive_thresh_rising_timeout
 What:		/sys/.../in_capacitanceY_adaptive_thresh_falling_timeout
 KernelVersion:	5.11
 Contact:	[email protected]
-Descrption:
+Description:
 		When adaptive thresholds are used, the tracking signal
 		may adjust too slowly to step changes in the raw signal.
 		*_timeout (in seconds) specifies a time for which the

This must be the warning Jon refers to. * as wildcard, rather than
* as emphasis marker.

maintainer
#15 lore raw
In reply to Mauro Carvalho Chehab
Quoted 10 lines · Mauro Carvalho Chehab

Hi Jon,

This small series contain a series of fixes for the documentation. it is against your docs-next branch.

Three of the patches fix duplicated symbols at the ABI documents. There are still some ABI warnings from IIO, but all but one were already fixed at linux-next. So, hopefully, after having everything merged, the ABI warnings will be solved.

Quoted 12 lines

Mauro Carvalho Chehab (10):
docs: update sysfs-platform_profile.rst reference
docs: vcpu-requests.rst: fix reference for atomic ops
docs: translations/zh_CN: fix a typo at 8.Conclusion.rst
docs: sched-bwc.rst: fix a typo on a doc name
docs: update pin-control.rst references
docs: virt: api.rst: fix a pointer to SGX documentation
docs: ABI: iommu: remove duplicated definition for
sysfs-kernel-iommu_groups
docs: ABI: sysfs-class-backlight: unify ambient light zone nodes
docs: ABI: sysfs-class-led-trigger-pattern: remove repeat duplication
iio: documentation: fix a typo

Seems like good stuff. The last patch in the series, though, adds a warning:

Documentation/ABI/testing/sysfs-bus-iio:799: WARNING: Inline emphasis start-string without end-string.

So I left that one out and applied the rest.

Thanks,

jon