linux-kernel - Re: [External] [PATCH 2/4] Documentation/ABI: sysfs-class-firmware-attributes: Fix Sphinx errors

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <b213c5e9-7b8d-491f-84cc-2a7c4825a547@lenovo.com>
Date:   Thu, 24 Mar 2022 15:30:46 -0400
From:   Mark Pearson <markpearson@...ovo.com>
To:     Hans de Goede <hdegoede@...hat.com>,
        Mark Gross <markgross@...nel.org>,
        Andy Shevchenko <andy@...nel.org>,
        "David E . Box" <david.e.box@...ux.intel.com>,
        Thomas Weißschuh <linux@...ssschuh.net>,
        Sebastian Reichel <sre@...nel.org>
CC:     Stephen Rothwell <sfr@...b.auug.org.au>,
        <platform-driver-x86@...r.kernel.org>,
        <linux-kernel@...r.kernel.org>, <linux-pm@...r.kernel.org>
Subject: Re: [External] [PATCH 2/4] Documentation/ABI:
 sysfs-class-firmware-attributes: Fix Sphinx errors

Thanks Hans

On 3/24/22 12:47, Hans de Goede wrote:
> Fix the following warnings from "make htmldocs":
> 
> Documentation/ABI/testing/sysfs-class-firmware-attributes:130:
>   ERROR: Unexpected indentation.
>   ERROR: Unexpected indentation.
>   ERROR: Unexpected indentation.
> 
> Signed-off-by: Hans de Goede <hdegoede@...hat.com>
> ---
>  .../testing/sysfs-class-firmware-attributes   | 42 ++++++++++---------
>  1 file changed, 23 insertions(+), 19 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-firmware-attributes b/Documentation/ABI/testing/sysfs-class-firmware-attributes
> index 05820365f1ec..5356ff2ed6c8 100644
> --- a/Documentation/ABI/testing/sysfs-class-firmware-attributes
> +++ b/Documentation/ABI/testing/sysfs-class-firmware-attributes
> @@ -246,9 +246,7 @@ Description:
>  					that is being referenced (e.g hdd0, hdd1 etc)
>  					This attribute defaults to device 0.
>  
> -		certificate:
> -		signature:
> -		save_signature:
> +		certificate, signature, save_signature:
>  					These attributes are used for certificate based authentication. This is
>  					used in conjunction with a signing server as an alternative to password
>  					based authentication.
> @@ -257,22 +255,27 @@ Description:
>  					The attributes can be displayed to check the stored value.
>  
>  					Some usage examples:
> -					Installing a certificate to enable feature:
> -						echo <supervisor password > authentication/Admin/current_password
> -						echo <signed certificate> > authentication/Admin/certificate
>  
> -					Updating the installed certificate:
> -						echo <signature> > authentication/Admin/signature
> -						echo <signed certificate> > authentication/Admin/certificate
> +						Installing a certificate to enable feature::
>  
> -					Removing the installed certificate:
> -						echo <signature> > authentication/Admin/signature
> -						echo '' > authentication/Admin/certificate
> +							echo "supervisor password" > authentication/Admin/current_password
> +							echo "signed certificate" > authentication/Admin/certificate
>  
> -					Changing a BIOS setting:
> -						echo <signature> > authentication/Admin/signature
> -						echo <save signature> > authentication/Admin/save_signature
> -						echo Enable > attribute/PasswordBeep/current_value
> +						Updating the installed certificate::
> +
> +							echo "signature" > authentication/Admin/signature
> +							echo "signed certificate" > authentication/Admin/certificate
> +
> +						Removing the installed certificate::
> +
> +							echo "signature" > authentication/Admin/signature
> +							echo "" > authentication/Admin/certificate
> +
> +						Changing a BIOS setting::
> +
> +							echo "signature" > authentication/Admin/signature
> +							echo "save signature" > authentication/Admin/save_signature
> +							echo Enable > attribute/PasswordBeep/current_value
>  
>  					You cannot enable certificate authentication if a supervisor password
>  					has not been set.
> @@ -288,9 +291,10 @@ Description:
>  		certificate_to_password:
>  					Write only attribute used to switch from certificate based authentication
>  					back to password based.
> -					Usage:
> -						echo <signature> > authentication/Admin/signature
> -						echo <password> > authentication/Admin/certificate_to_password
> +					Usage::
> +
> +						echo "signature" > authentication/Admin/signature
> +						echo "password" > authentication/Admin/certificate_to_password
>  
>  
>  What:		/sys/class/firmware-attributes/*/attributes/pending_reboot

Looks good!
Mark