2021-09-27 11:14:25

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 0/7] Fix some issues with ABI files

Hi Greg,

All patches in this series are independent each other. This series is
based on today's next (next-20210927).

As you know, I've been busy those days adding a new feature for
get_abi.pl to identify missing documentation. While doing that,
I noticed several issues at the ABI files on "make htmldocs".
This series address them, and it is independent from the other
patches for get_abi.pl.

Patch 1 is actually a small improvement to get_abi.pl, addressing an
issue when there are multiple definitions for the same ABI symbol.
While this is not allowed, and produce warnings, there are still
3 occurrences:

./scripts/get_abi.pl validate
Warning: /sys/bus/iio/devices/iio:deviceX/fault_ovuv is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856:14 Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:0
Warning: /sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:12 Documentation/ABI/testing/sysfs-bus-iio:1911
Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 Documentation/ABI/testing/sysfs-bus-iio:91

Once those got fixed, perhaps a future patch could make get_abi.pl to
generate an error causing the compilation to break, if WERROR is defined.

Anyway, it is better to to make the script more reliable anyway, specially
since it is just one extra line of code.

Patches 2-7 fix random warnings introduced by new patches.

Regards,
Mauro

Mauro Carvalho Chehab (7):
scripts: get_abi.pl: create a valid ReST with duplicated tags
ABI: sysfs-platform-dell-privacy-wmi: correct ABI entries
ABI: sysfs-platform-dptf: Add tables markup to a table
ABI: configfs-usb-gadget-uac1: fix a broken table
ABI: configfs-usb-gadget-uac2: fix a broken table
ABI: sysfs-devices-removable: make a table valid as ReST markup
ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for
ReST

.../ABI/testing/configfs-usb-gadget-uac1 | 42 +++++++------
.../ABI/testing/configfs-usb-gadget-uac2 | 43 +++++++------
.../ABI/testing/sysfs-devices-removable | 8 ++-
.../testing/sysfs-platform-dell-privacy-wmi | 60 ++++++++++++-------
Documentation/ABI/testing/sysfs-platform-dptf | 4 ++
.../ABI/testing/sysfs-platform-intel-pmc | 2 +
scripts/get_abi.pl | 1 +
7 files changed, 99 insertions(+), 61 deletions(-)

--
2.31.1



2021-09-27 11:14:40

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 3/7] ABI: sysfs-platform-dptf: Add tables markup to a table

Solve those warnings:
Documentation/ABI/testing/sysfs-platform-dptf:130: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-platform-dptf:130: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-platform-dptf:130: WARNING: Definition list ends without a blank line; unexpected unindent.

Fixes: 668ce99e4ed4 ("ACPI: DPTF: Additional sysfs attributes for power participant driver")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---

See [PATCH 0/7] at: https://lore.kernel.org/all/[email protected]/T/#t

Documentation/ABI/testing/sysfs-platform-dptf | 4 ++++
1 file changed, 4 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-platform-dptf b/Documentation/ABI/testing/sysfs-platform-dptf
index 53c6b1000320..620fd20434a5 100644
--- a/Documentation/ABI/testing/sysfs-platform-dptf
+++ b/Documentation/ABI/testing/sysfs-platform-dptf
@@ -133,7 +133,10 @@ Contact: [email protected]
Description:
(RO) Presents SSC (spread spectrum clock) information for EMI
(Electro magnetic interference) control. This is a bit mask.
+
+ ======= ==========================================
Bits Description
+ ======= ==========================================
[7:0] Sets clock spectrum spread percentage:
0x00=0.2% , 0x3F=10%
1 LSB = 0.1% increase in spread (for
@@ -151,3 +154,4 @@ Description:
[10] 0: No white noise. 1: Add white noise
to spread waveform
[11] When 1, future writes are ignored.
+ ======= ==========================================
--
2.31.1

2021-09-27 11:15:21

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 4/7] ABI: configfs-usb-gadget-uac1: fix a broken table

Changeset 0356e6283c71 ("usb: gadget: f_uac1: add volume and mute support")
added some new elements to the table but didn't care enough to actually
adjust the columns, causing the output to be broken as warned by
Sphinx when producing the documentation.

Readjust it for it to be a valid ReST table.

Fixes: 0356e6283c71 ("usb: gadget: f_uac1: add volume and mute support")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---

See [PATCH 0/7] at: https://lore.kernel.org/all/[email protected]/T/#t

.../ABI/testing/configfs-usb-gadget-uac1 | 42 +++++++++++--------
1 file changed, 24 insertions(+), 18 deletions(-)

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-uac1 b/Documentation/ABI/testing/configfs-usb-gadget-uac1
index dd647d44d975..b576b3d6ea6d 100644
--- a/Documentation/ABI/testing/configfs-usb-gadget-uac1
+++ b/Documentation/ABI/testing/configfs-usb-gadget-uac1
@@ -4,23 +4,29 @@ KernelVersion: 4.14
Description:
The attributes:

- ========== ===================================
- c_chmask capture channel mask
- c_srate capture sampling rate
- c_ssize capture sample size (bytes)
- c_mute_present capture mute control enable
+ ===================== =======================================
+ c_chmask capture channel mask
+ c_srate capture sampling rate
+ c_ssize capture sample size (bytes)
+ c_mute_present capture mute control enable
c_volume_present capture volume control enable
- c_volume_min capture volume control min value (in 1/256 dB)
- c_volume_max capture volume control max value (in 1/256 dB)
- c_volume_res capture volume control resolution (in 1/256 dB)
- p_chmask playback channel mask
- p_srate playback sampling rate
- p_ssize playback sample size (bytes)
- p_mute_present playback mute control enable
+ c_volume_min capture volume control min value
+ (in 1/256 dB)
+ c_volume_max capture volume control max value
+ (in 1/256 dB)
+ c_volume_res capture volume control resolution
+ (in 1/256 dB)
+ p_chmask playback channel mask
+ p_srate playback sampling rate
+ p_ssize playback sample size (bytes)
+ p_mute_present playback mute control enable
p_volume_present playback volume control enable
- p_volume_min playback volume control min value (in 1/256 dB)
- p_volume_max playback volume control max value (in 1/256 dB)
- p_volume_res playback volume control resolution (in 1/256 dB)
- req_number the number of pre-allocated request
- for both capture and playback
- ========== ===================================
+ p_volume_min playback volume control min value
+ (in 1/256 dB)
+ p_volume_max playback volume control max value
+ (in 1/256 dB)
+ p_volume_res playback volume control resolution
+ (in 1/256 dB)
+ req_number the number of pre-allocated request
+ for both capture and playback
+ ===================== =======================================
--
2.31.1