[PATCH 0/7] Fix some issues with ABI files

[PATCH 0/7] Fix some issues with ABI files

[Mauro Carvalho Chehab]

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

[PATCH 7/7] ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for ReST

[Mauro Carvalho Chehab]

The ReST format requires blank lines before/after identation changes,
for it to properly detect lists.

Fixes: ee7abc105e2b ("platform/x86: intel_pmc_core: export platform global reset bits via etr3 sysfs file")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

See [PATCH 0/7] at: https://lore.kernel.org/all/cover.1632740376.git.mchehab+huawei@kernel.org/T/#t

 Documentation/ABI/testing/sysfs-platform-intel-pmc | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-platform-intel-pmc b/Documentation/ABI/testing/sysfs-platform-intel-pmc
index ef199af75ab0..f31d59b21f9b 100644
--- a/Documentation/ABI/testing/sysfs-platform-intel-pmc
+++ b/Documentation/ABI/testing/sysfs-platform-intel-pmc
@@ -11,8 +11,10 @@ Description:
 		to take effect.
 
 		Display global reset setting bits for PMC.
+
 			* bit 31 - global reset is locked
 			* bit 20 - global reset is set
+
 		Writing bit 20 value to the etr3 will induce
 		a platform "global reset" upon consequent platform reset,
 		in case the register is not locked.
-- 
2.31.1

RE: [PATCH 7/7] ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for ReST

[Winkler, Tomas]

> 
> The ReST format requires blank lines before/after identation changes, for it
> to properly detect lists.
> 
> Fixes: ee7abc105e2b ("platform/x86: intel_pmc_core: export platform global
> reset bits via etr3 sysfs file")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Ack.
> ---
> 
> See [PATCH 0/7] at:
> https://lore.kernel.org/all/cover.1632740376.git.mchehab+huawei@kernel.o
> rg/T/#t
> 
>  Documentation/ABI/testing/sysfs-platform-intel-pmc | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-pmc
> b/Documentation/ABI/testing/sysfs-platform-intel-pmc
> index ef199af75ab0..f31d59b21f9b 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-pmc
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-pmc
> @@ -11,8 +11,10 @@ Description:
>  		to take effect.
> 
>  		Display global reset setting bits for PMC.
> +
>  			* bit 31 - global reset is locked
>  			* bit 20 - global reset is set
> +
>  		Writing bit 20 value to the etr3 will induce
>  		a platform "global reset" upon consequent platform reset,
>  		in case the register is not locked.
> --
> 2.31.1

Re: [PATCH 7/7] ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for ReST

[Hans de Goede]

Hi,

On 9/27/21 1:10 PM, Mauro Carvalho Chehab wrote:
> The ReST format requires blank lines before/after identation changes,
> for it to properly detect lists.
> 
> Fixes: ee7abc105e2b ("platform/x86: intel_pmc_core: export platform global reset bits via etr3 sysfs file")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Once I've run some tests on this branch the patches there will be
added to the platform-drivers-x86/for-next branch and eventually
will be included in the pdx86 pull-request to Linus for the next
merge-window.

Regards,

Hans


> ---
> 
> See [PATCH 0/7] at: https://lore.kernel.org/all/cover.1632740376.git.mchehab+huawei@kernel.org/T/#t
> 
>  Documentation/ABI/testing/sysfs-platform-intel-pmc | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-pmc b/Documentation/ABI/testing/sysfs-platform-intel-pmc
> index ef199af75ab0..f31d59b21f9b 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-pmc
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-pmc
> @@ -11,8 +11,10 @@ Description:
>  		to take effect.
>  
>  		Display global reset setting bits for PMC.
> +
>  			* bit 31 - global reset is locked
>  			* bit 20 - global reset is set
> +
>  		Writing bit 20 value to the etr3 will induce
>  		a platform "global reset" upon consequent platform reset,
>  		in case the register is not locked.
>