Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
Received-SPF: SoftFail (protection.outlook.com: domain of transitioning
 lenovo.com discourages use of 104.232.225.7 as permitted sender)
Message-ID: <b213c5e9-7b8d-491f-84cc-2a7c4825a547@lenovo.com>
Date:   Thu, 24 Mar 2022 15:30:46 -0400
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.7.0
Subject: Re: [External] [PATCH 2/4] Documentation/ABI:
 sysfs-class-firmware-attributes: Fix Sphinx errors
Content-Language: en-US
To:     Hans de Goede <hdegoede@redhat.com>,
        Mark Gross <markgross@kernel.org>,
        Andy Shevchenko <andy@kernel.org>,
        "David E . Box" <david.e.box@linux.intel.com>,
        =?UTF-8?Q?Thomas_Wei=c3=9fschuh?= <linux@weissschuh.net>,
        Sebastian Reichel <sre@kernel.org>
CC:     Stephen Rothwell <sfr@canb.auug.org.au>,
        <platform-driver-x86@vger.kernel.org>,
        <linux-kernel@vger.kernel.org>, <linux-pm@vger.kernel.org>
References: <20220324164737.21765-1-hdegoede@redhat.com>
 <20220324164737.21765-3-hdegoede@redhat.com>
From:   Mark Pearson <markpearson@lenovo.com>
In-Reply-To: <20220324164737.21765-3-hdegoede@redhat.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Mar 2022 19:30:53.2598
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 7eb7457e-b118-4d47-257c-08da0dcccfd6
X-MS-Exchange-CrossTenant-Id: 5c7d0b28-bdf8-410c-aa93-4df372b16203
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5c7d0b28-bdf8-410c-aa93-4df372b16203;Ip=[104.232.225.7];Helo=[mail.lenovo.com]
X-MS-Exchange-CrossTenant-AuthSource: SG2APC01FT0007.eop-APC01.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: KL1PR03MB6391
X-Spam-Status: No, score=-3.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
	DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,NICE_REPLY_A,RDNS_NONE,SPF_HELO_NONE,
	T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
	lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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@redhat.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