* [PATCH 00/10] Documentation build warning fixes
@ 2021-05-19 8:51 Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 08/10] docs: ABI: sysfs-class-backlight: unify ambient light zone nodes Mauro Carvalho Chehab
2021-05-20 20:00 ` [PATCH 00/10] Documentation build warning fixes Jonathan Corbet
0 siblings, 2 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-19 8:51 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: linux-iio, Daniel Thompson, kvm, alsa-devel,
Mauro Carvalho Chehab, Greg Kroah-Hartman, linux-kernel,
dri-devel, linux-gpio, patches, Jingoo Han, Lee Jones,
Jonathan Cameron
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
--
2.31.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH 08/10] docs: ABI: sysfs-class-backlight: unify ambient light zone nodes
2021-05-19 8:51 [PATCH 00/10] Documentation build warning fixes Mauro Carvalho Chehab
@ 2021-05-19 8:51 ` Mauro Carvalho Chehab
2021-05-20 20:00 ` [PATCH 00/10] Documentation build warning fixes Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-19 8:51 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: Daniel Thompson, Mauro Carvalho Chehab, Jingoo Han, linux-kernel,
dri-devel, Lee Jones
./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 <mchehab+huawei@kernel.org>
---
.../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
diff --git a/Documentation/ABI/testing/sysfs-class-backlight b/Documentation/ABI/testing/sysfs-class-backlight
index 1fc86401bf95..c453646b06e2 100644
--- a/Documentation/ABI/testing/sysfs-class-backlight
+++ b/Documentation/ABI/testing/sysfs-class-backlight
@@ -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: device-drivers-devel@blackfin.uclinux.org
+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: device-drivers-devel@blackfin.uclinux.org
+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.
+
diff --git a/Documentation/ABI/testing/sysfs-class-backlight-adp5520 b/Documentation/ABI/testing/sysfs-class-backlight-adp5520
deleted file mode 100644
index 34b6ebafa210..000000000000
--- a/Documentation/ABI/testing/sysfs-class-backlight-adp5520
+++ /dev/null
@@ -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 <michael.hennerich@analog.com>
-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 <michael.hennerich@analog.com>
-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.
diff --git a/Documentation/ABI/testing/sysfs-class-backlight-adp8860 b/Documentation/ABI/testing/sysfs-class-backlight-adp8860
deleted file mode 100644
index 6610ac73f9ba..000000000000
--- a/Documentation/ABI/testing/sysfs-class-backlight-adp8860
+++ /dev/null
@@ -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 <michael.hennerich@analog.com>
-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 <michael.hennerich@analog.com>
-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.
diff --git a/Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870 b/Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870
deleted file mode 100644
index b08ca912cad4..000000000000
--- a/Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870
+++ /dev/null
@@ -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: device-drivers-devel@blackfin.uclinux.org
-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: device-drivers-devel@blackfin.uclinux.org
-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>.
--
2.31.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH 00/10] Documentation build warning fixes
2021-05-19 8:51 [PATCH 00/10] Documentation build warning fixes Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 08/10] docs: ABI: sysfs-class-backlight: unify ambient light zone nodes Mauro Carvalho Chehab
@ 2021-05-20 20:00 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2021-05-20 20:00 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: linux-iio, Daniel Thompson, kvm, alsa-devel,
Mauro Carvalho Chehab, Greg Kroah-Hartman, linux-kernel,
dri-devel, linux-gpio, patches, Jingoo Han, Lee Jones,
Jonathan Cameron
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 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
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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-05-20 20:00 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-05-19 8:51 [PATCH 00/10] Documentation build warning fixes Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 08/10] docs: ABI: sysfs-class-backlight: unify ambient light zone nodes Mauro Carvalho Chehab
2021-05-20 20:00 ` [PATCH 00/10] Documentation build warning fixes Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox