[PATCH] Documentation: pldmfw: Demote library overview section

Bagas Sanjaya posted 1 patch 3 months ago
Documentation/driver-api/pldmfw/index.rst | 1 -
1 file changed, 1 deletion(-)
[PATCH] Documentation: pldmfw: Demote library overview section
Posted by Bagas Sanjaya 3 months ago
pldmfw library overview section is formatted as title heading (the
second title of index.rst), making it listed in driver-api toctree.

Demote the section.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/driver-api/pldmfw/index.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/driver-api/pldmfw/index.rst b/Documentation/driver-api/pldmfw/index.rst
index fd871b83f34f3a..e59beca374c1fa 100644
--- a/Documentation/driver-api/pldmfw/index.rst
+++ b/Documentation/driver-api/pldmfw/index.rst
@@ -14,7 +14,6 @@ the PLDM for Firmware Update standard
    file-format
    driver-ops
 
-==================================
 Overview of the ``pldmfw`` library
 ==================================
 

base-commit: e5e7ca66a7fc6b8073c30a048e1157b88d427980
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH] Documentation: pldmfw: Demote library overview section
Posted by Randy Dunlap 3 months ago

On 11/2/25 7:02 PM, Bagas Sanjaya wrote:
> pldmfw library overview section is formatted as title heading (the
> second title of index.rst), making it listed in driver-api toctree.
> 
> Demote the section.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  Documentation/driver-api/pldmfw/index.rst | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/Documentation/driver-api/pldmfw/index.rst b/Documentation/driver-api/pldmfw/index.rst
> index fd871b83f34f3a..e59beca374c1fa 100644
> --- a/Documentation/driver-api/pldmfw/index.rst
> +++ b/Documentation/driver-api/pldmfw/index.rst
> @@ -14,7 +14,6 @@ the PLDM for Firmware Update standard
>     file-format
>     driver-ops
>  
> -==================================
>  Overview of the ``pldmfw`` library
>  ==================================
>  
> 
> base-commit: e5e7ca66a7fc6b8073c30a048e1157b88d427980

-- 
~Randy
Re: [PATCH] Documentation: pldmfw: Demote library overview section
Posted by Jacob Keller 3 months ago

On 11/2/2025 9:09 PM, Randy Dunlap wrote:
> 
> 
> On 11/2/25 7:02 PM, Bagas Sanjaya wrote:
>> pldmfw library overview section is formatted as title heading (the
>> second title of index.rst), making it listed in driver-api toctree.
>>
>> Demote the section.
>>
>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>
> 
> Thanks.

Acked-by: Jacob Keller <jacob.e.keller@intel.com>

libpldm doesn't have its own tree at present, and most updates typically
have gone through netdev. However, I think this makes the most sense to
be taken through docs tree, since it doesn't impact any code.

Thanks,
Jake

> 
>> ---
>>  Documentation/driver-api/pldmfw/index.rst | 1 -
>>  1 file changed, 1 deletion(-)
>>
>> diff --git a/Documentation/driver-api/pldmfw/index.rst b/Documentation/driver-api/pldmfw/index.rst
>> index fd871b83f34f3a..e59beca374c1fa 100644
>> --- a/Documentation/driver-api/pldmfw/index.rst
>> +++ b/Documentation/driver-api/pldmfw/index.rst
>> @@ -14,7 +14,6 @@ the PLDM for Firmware Update standard
>>     file-format
>>     driver-ops
>>  
>> -==================================
>>  Overview of the ``pldmfw`` library
>>  ==================================
>>  
>>
>> base-commit: e5e7ca66a7fc6b8073c30a048e1157b88d427980
> 

Re: [PATCH] Documentation: pldmfw: Demote library overview section
Posted by Jonathan Corbet 3 months ago
Jacob Keller <jacob.e.keller@intel.com> writes:

> On 11/2/2025 9:09 PM, Randy Dunlap wrote:
>> 
>> 
>> On 11/2/25 7:02 PM, Bagas Sanjaya wrote:
>>> pldmfw library overview section is formatted as title heading (the
>>> second title of index.rst), making it listed in driver-api toctree.
>>>
>>> Demote the section.
>>>
>>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>> 
>> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
>> Tested-by: Randy Dunlap <rdunlap@infradead.org>
>> 
>> Thanks.
>
> Acked-by: Jacob Keller <jacob.e.keller@intel.com>
>
> libpldm doesn't have its own tree at present, and most updates typically
> have gone through netdev. However, I think this makes the most sense to
> be taken through docs tree, since it doesn't impact any code.

OK I have applied it, thanks.

jon