[PATCH 1/2] doc: ti: reorganize existing ti docs

Heinrich Schuchardt xypron.glpk at gmx.de
Thu Dec 22 10:58:48 CET 2022


On 12/22/22 10:56, Heinrich Schuchardt wrote:
> On 12/19/22 21:29, Bryan Brattlof wrote:
>> Texas Instruments produces quite a lot of SoCs based upon a common
>> architecture 'generation'. (eg: OMAP, K3) TI's existing documentation
>> layout makes noticing this generation jump rather difficult.
>>
>> To make navigation easier, split the existing documentation into
>> individual SoC families so we may begin grouping them according to their
>> generational (eg: OMAP, K3) families.
>>
>> Signed-off-by: Bryan Brattlof <bb at ti.com>
>> ---
>>   doc/board/ti/am335x_evm.rst | 5 ++++-
>>   doc/board/ti/am62x_sk.rst   | 4 ++--
>>   doc/board/ti/j721e_evm.rst  | 4 ++--
>>   3 files changed, 8 insertions(+), 5 deletions(-)
>>
>> diff --git a/doc/board/ti/am335x_evm.rst b/doc/board/ti/am335x_evm.rst
>> index a90f32da7aea5..7db9604ce05c9 100644
>> --- a/doc/board/ti/am335x_evm.rst
>> +++ b/doc/board/ti/am335x_evm.rst
>> @@ -1,8 +1,11 @@
>>   .. SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
>>   .. sectionauthor:: Tom Rini <trini at konsulko.com>
>>
>> +AM335x Generation
>> +=================
>> +
>>   Summary
>> -=======
>
> "AM335x Generation" is a level 1 header (<h1>). "Summary" should not be
> on the same header level. Please, use:
>
> Summary
> -------

Sorry misread the patch.

Reviewed-by: Heinrich Schuchardt <xypron.glpk at gmx.de>

>
> Best regards
>
> Heinrich
>
>> +-------
>>
>>   This document covers various features of the `am335x_evm` default
>>   configuration, some of the related defconfigs, and how to enable
>> hardware
>> diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
>> index 4e68c2018a50b..b1b7d99befb92 100644
>> --- a/doc/board/ti/am62x_sk.rst
>> +++ b/doc/board/ti/am62x_sk.rst
>> @@ -1,8 +1,8 @@
>>   .. SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
>>   .. sectionauthor:: Vignesh Raghavendra <vigneshr at ti.com>
>>
>> -Texas Instruments AM62 Platforms
>> -================================
>> +AM62 Platforms
>> +===============
>>
>>   Introduction:
>>   -------------
>> diff --git a/doc/board/ti/j721e_evm.rst b/doc/board/ti/j721e_evm.rst
>> index ad70f15b7a418..e898601c41ea4 100644
>> --- a/doc/board/ti/j721e_evm.rst
>> +++ b/doc/board/ti/j721e_evm.rst
>> @@ -1,8 +1,8 @@
>>   .. SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
>>   .. sectionauthor:: Lokesh Vutla <lokeshvutla at ti.com>
>>
>> -Texas Instruments K3 Platforms
>> -==============================
>> +J721E Platforms
>> +===============
>>
>>   Introduction:
>>   -------------
>



More information about the U-Boot mailing list