mbox series

[0/4] Documentation/ABI: platform/x86: Sphinx warning fixes

Message ID 20220324164737.21765-1-hdegoede@redhat.com
Headers show
Series Documentation/ABI: platform/x86: Sphinx warning fixes | expand

Message

Hans de Goede March 24, 2022, 4:47 p.m. UTC 
Hi All,

After Stephen reported some Sphinx warnings for files under
Documentation/ABI/testing, I had to first figure out how to reproduce
these. It turns out that to regenerate the htmldocs for files under
Documentation/ABI/testing once has to run:

touch Documentation/admin-guide/abi-testing.rst && make htmldocs

This turned up warnings in multiple sysfs ABI files for platform/x86
drivers, as well as in some new functionality in sysfs-class-power,
which was merged through the platform-drivers-x86 tree.

I plan to merge this series through the platform-drivers-x86 tree and
send this out in a fixed pull-req to Linus once 5.18-rc1 is out.

Regards,

Hans

p.s.

platform-drivers-x86 authors, for future patch submissions touching
files under Documentation/ABI/testing please run:

touch Documentation/admin-guide/abi-testing.rst && make htmldocs

and make sure no warnings are introduced.


Hans de Goede (4):
  Documentation/ABI: sysfs-driver-intel_sdsi: Fix sphinx warnings
  Documentation/ABI: sysfs-class-firmware-attributes: Fix Sphinx errors
  Documentation/ABI: sysfs-class-firmware-attributes: Misc. cleanups
  Documentation/ABI: sysfs-class-power: Fix Sphinx error

 .../testing/sysfs-class-firmware-attributes   | 48 ++++++++++---------
 Documentation/ABI/testing/sysfs-class-power   |  1 +
 .../ABI/testing/sysfs-driver-intel_sdsi       | 18 +++----
 3 files changed, 37 insertions(+), 30 deletions(-)

Comments

Mark Pearson March 24, 2022, 7:31 p.m. UTC | #1 
On 3/24/22 12:47, Hans de Goede wrote:
> Cleanup / fix some minor issues.
> 
> Signed-off-by: Hans de Goede <hdegoede@redhat.com>
> ---
>  Documentation/ABI/testing/sysfs-class-firmware-attributes | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-firmware-attributes b/Documentation/ABI/testing/sysfs-class-firmware-attributes
> index 5356ff2ed6c8..4cdba3477176 100644
> --- a/Documentation/ABI/testing/sysfs-class-firmware-attributes
> +++ b/Documentation/ABI/testing/sysfs-class-firmware-attributes
> @@ -116,7 +116,7 @@ Description:
>  					    <value>[ForceIf:<attribute>=<value>]
>  					    <value>[ForceIfNot:<attribute>=<value>]
>  
> -					For example:
> +					For example::
>  
>  					    LegacyOrom/dell_value_modifier has value:
>  						    Disabled[ForceIf:SecureBoot=Enabled]
> @@ -212,7 +212,7 @@ Description:
>  		the next boot.
>  
>  		Lenovo specific class extensions
> -		------------------------------
> +		--------------------------------
>  
>  		On Lenovo systems the following additional settings are available:
>  
> @@ -349,7 +349,7 @@ Description:
>  
>  		    # echo "factory" > /sys/class/firmware-attributes/*/device/attributes/reset_bios
>  		    # cat /sys/class/firmware-attributes/*/device/attributes/reset_bios
> -		    # builtinsafe lastknowngood [factory] custom
> +		    builtinsafe lastknowngood [factory] custom
>  
>  		Note that any changes to this attribute requires a reboot
>  		for changes to take effect.
Looks good - thanks for taking care of this
Mark