[PATCH 1/1] imx: Kconfig: fix references to doc/README.mxc_hab

[Stefano Babic]

Hi everybody,

On 14/04/20 04:05, Heinrich Schuchardt wrote:
> On 4/14/20 3:28 AM, Breno Matheus Lima wrote:
>> Hi Heinrich,
>>
>> Em seg., 13 de abr. de 2020 às 11:04, Heinrich Schuchardt
>> <xypron.glpk at gmx.de> escreveu:
>>>
>>> Am April 13, 2020 2:49:00 PM UTC schrieb Breno Matheus Lima <brenomatheus at gmail.com>:
>>>> Hi Heinrich,
>>>>
>>>> Em dom., 12 de abr. de 2020 às 17:35, Heinrich Schuchardt
>>>> <xypron.glpk at gmx.de> escreveu:
>>>>>
>>>>> On 4/12/20 6:16 PM, Fabio Estevam wrote:
>>>>>> Hi Heinrich,
>>>>>>
>>>>>> On Sun, Apr 12, 2020 at 11:23 AM Heinrich Schuchardt
>>>> <xypron.glpk at gmx.de> wrote:
>>>>>>>
>>>>>>> doc/README.mxc_hab was moved to
>>>> doc/imx/habv4/guides/encrypted_boot.txt by
>>>>>>> commit df11b0c4d4e3 ("doc: imx: reorganize i.MX documentation"),
>>>> commit
>>>>>>> dfe9ff9cc79b ("doc: imx: hab: Reorganize High Assurance Boot
>>>>>>> documentation"), commit 8a23fc9c94bf ("doc: imx: habv4: Remove
>>>> extra hab,
>>>>>>> directory for a cleaner documentation structure"), and commit
>>>> 364c0a89bcfa
>>>>>>> ("doc: imx: habv4: Move encrypted boot guide").
>>>>>>>
>>>>>>> Fixes: df11b0c4d4e3 ("doc: imx: reorganize i.MX documentation")
>>>>>>> Fixes: dfe9ff9cc79b ("doc: imx: hab: Reorganize High Assurance
>>>> Boot
>>>>>>> documentation")
>>>>>>> Fixes: 8a23fc9c94bf ("doc: imx: habv4: Remove extra hab, directory
>>>>>>> for a cleaner documentation structure")
>>>>>>> Fixes: commit 364c0a89bcfa ("doc: imx: habv4: Move encrypted boot
>>>> guide").
>>>>>>> Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
>>>>>>> ---
>>>>>>>  arch/arm/mach-imx/Kconfig | 6 +++---
>>>>>>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>>>>>>
>>>>>>> diff --git a/arch/arm/mach-imx/Kconfig b/arch/arm/mach-imx/Kconfig
>>>>>>> index aa140c4798..44b47780ee 100644
>>>>>>> --- a/arch/arm/mach-imx/Kconfig
>>>>>>> +++ b/arch/arm/mach-imx/Kconfig
>>>>>>> @@ -41,7 +41,7 @@ config IMX_HAB
>>>>>>>         imply CMD_DEKBLOB
>>>>>>>         help
>>>>>>>           This option enables the support for secure boot (HAB).
>>>>>>> -         See doc/README.mxc_hab for more details.
>>>>>>> +         See doc/imx/habv4/guides/encrypted_boot.txt for more
>>>> details.
>>>>>>
>>>>>> Thanks for your patch.
>>>>>>
>>>>>> Indeed, doc/README.mxc_hab is gone and we should replace it, but I
>>>> was
>>>>>> wondering if we should point the file to
>>>>>> doc/imx/habv4/guides/mx6_mx7_secure_boot.txt instead.
>>>>>>
>>>>>> Breno,
>>>>>>
>>>>>> What do you think?
>>>>>
>>>>> It is doc/imx/habv4/guides/encrypted_boot.txt that mentions
>>>>> CONFIG_IMX_HAB and CONFIG_CMD_DEKBLOB.
>>>>>
>>>>> Maybe both files can be merged. Anyway the imx directory should move
>>>> to
>>>>> doc/board and be integrated into doc/board/index.rst.
>>>>>
>>>>> Shouldn't the content of folder doc/imx be moved to
>>>> doc/board/freescale/
>>>>> and linked in doc/board/freescale/index.rst?
>>>>>
>>>>> We should be able to generate HTML documentation for imx using 'make
>>>>> htmldocs'.
>>>>
>>>> Thanks for your feedback.
>>>>
>>>> Do you think we can convert this documentation to sphinx format and
>>>> create an index.rst at doc/imx/? The HABv4 documentation is SoC
>>>> specific and not board related.
>>>
>>> Maybe besides an arch and a board folder we should have a doc/soc/ folder.
>>>
>>
>> Thanks for your suggestion, do we have similar documentation for other SoCs?
>>
>> Please take a look in commit df11b0c4 ("doc: imx: reorganize i.MX
>> documentation") all i.MX documentation that were located at U-Boot doc
>> root directory.
> 
> df11b0c4 was a good step forward.
> 
> doc/mvebu/armada-8k-memory.txt
> seems to be another SoC related file.
> 
> A lot of other SoC files are at doc/README.*.
> 
> Overall the doc/ directory is not in a good state yet. Many documents
> are not yet integrated into the generated documentation.
> 

Agree that doc/ is in a bad state - nevertheless we should try to move
on to the right direction. As Breno says, this is not related to a
single board.  doc/README.soc was done years ago, without generating
documentation. I think we should go away from this model. I see also
very positive the switch to rst for any i.MX documentation.

Regards,
Stefano


> Best regards
> 
> Heinrich
> 
>>
>> Thanks,
>> Breno Lima
>>
> 

-- 
=====================================================================
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================