[PATCH 1/1] doc: rename Freescale to NXP

[Heinrich Schuchardt]

On 8/16/21 3:32 PM, Fabio Estevam wrote:
> Hi Stefano,
>
> On Mon, Aug 16, 2021 at 9:34 AM Stefano Babic <sbabic at denx.de> wrote:
>>
>> Hi Heinrich,
>>
>> On 16.08.21 08:25, Heinrich Schuchardt wrote:
>>> Freescale Semiconductor, Inc. was merged into NXP Semiconductors in 2015.
>>>
>>> Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
>>> ---
>>
>> Ok, but what we do with the Freescale that all around ?
>>
>> You change docs for boards, but boards are in ./board/freescale. And we
>> have then "fsl" directories as short name for Freescale. Should we not

For me the important thing is that people looking into the documentation
find their way.

The only directory in /doc called fsl is
doc/device-tree-bindings/soc/fsl/. But the only file
doc/device-tree-bindings/soc/fsl/cpm_qe/qe/ucc.txt is not integrated
into the HTML documentation at all and seems to be a copy of a Linux file.

We should not duplicate the device-tree binding documentation from Linux.

StMicroelectronics just added a file
/doc/output/board/st/st.rst
referring to the Linux documentation. Only U-Boot specific files remain:

"U-Boot device tree bindings
----------------------------

The U-Boot specific bindings are defined in the U-Boot directory:
doc/device-tree-bindings

* clock
         - :download:`clock/st,stm32mp1.txt
<../../device-tree-bindings/clock/st,stm32mp1.txt>`
* ram
         - :download:`memory-controllers/st,stm32mp1-ddr.txt
<../../device-tree-bindings/memory-controllers/st,stm32mp1-ddr.txt>`

All the other device tree bindings used in U-Boot are specified in Linux
kernel. Please refer dt bindings from below specified paths in the Linux
kernel binding directory = Documentation/devicetree/bindings/

* acd
         - iio/adc/st,stm32-adc.yaml
* clock
..."

Best regards

Heinrich

>
> Yes, agreed.
>
> IMHO it is not worth the effort to convert from board/freescale to
> board/nxp as it will
> not bring any real gain to the project.
>
> Regards,
>
> Fabio Estevam
>
>
>
>
>
>
>
>> have a single commit for everything ?
>>
>> Best regards,
>> Stefano
>>
>>>    doc/board/index.rst                              | 2 +-
>>>    doc/board/{freescale => nxp}/imx8mm_evk.rst      | 0
>>>    doc/board/{freescale => nxp}/imx8mn_evk.rst      | 0
>>>    doc/board/{freescale => nxp}/imx8mp_evk.rst      | 0
>>>    doc/board/{freescale => nxp}/imx8mq_evk.rst      | 0
>>>    doc/board/{freescale => nxp}/imx8qxp_mek.rst     | 0
>>>    doc/board/{freescale => nxp}/imxrt1020-evk.rst   | 0
>>>    doc/board/{freescale => nxp}/imxrt1050-evk.rst   | 0
>>>    doc/board/{freescale => nxp}/index.rst           | 4 ++--
>>>    doc/board/{freescale => nxp}/mx6sabreauto.rst    | 0
>>>    doc/board/{freescale => nxp}/mx6sabresd.rst      | 0
>>>    doc/board/{freescale => nxp}/mx6ul_14x14_evk.rst | 0
>>>    doc/board/{freescale => nxp}/mx6ullevk.rst       | 0
>>>    doc/board/{freescale => nxp}/psb.rst             | 0
>>>    14 files changed, 3 insertions(+), 3 deletions(-)
>>>    rename doc/board/{freescale => nxp}/imx8mm_evk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/imx8mn_evk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/imx8mp_evk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/imx8mq_evk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/imx8qxp_mek.rst (100%)
>>>    rename doc/board/{freescale => nxp}/imxrt1020-evk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/imxrt1050-evk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/index.rst (86%)
>>>    rename doc/board/{freescale => nxp}/mx6sabreauto.rst (100%)
>>>    rename doc/board/{freescale => nxp}/mx6sabresd.rst (100%)
>>>    rename doc/board/{freescale => nxp}/mx6ul_14x14_evk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/mx6ullevk.rst (100%)
>>>    rename doc/board/{freescale => nxp}/psb.rst (100%)
>>>
>>> diff --git a/doc/board/index.rst b/doc/board/index.rst
>>> index 9e90978891..33087074fa 100644
>>> --- a/doc/board/index.rst
>>> +++ b/doc/board/index.rst
>>> @@ -14,11 +14,11 @@ Board-specific doc
>>>       congatec/index
>>>       coreboot/index
>>>       emulation/index
>>> -   freescale/index
>>>       google/index
>>>       intel/index
>>>       kontron/index
>>>       microchip/index
>>> +   nxp/index
>>>       openpiton/index
>>>       qualcomm/index
>>>       rockchip/index
>>> diff --git a/doc/board/freescale/imx8mm_evk.rst b/doc/board/nxp/imx8mm_evk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/imx8mm_evk.rst
>>> rename to doc/board/nxp/imx8mm_evk.rst
>>> diff --git a/doc/board/freescale/imx8mn_evk.rst b/doc/board/nxp/imx8mn_evk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/imx8mn_evk.rst
>>> rename to doc/board/nxp/imx8mn_evk.rst
>>> diff --git a/doc/board/freescale/imx8mp_evk.rst b/doc/board/nxp/imx8mp_evk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/imx8mp_evk.rst
>>> rename to doc/board/nxp/imx8mp_evk.rst
>>> diff --git a/doc/board/freescale/imx8mq_evk.rst b/doc/board/nxp/imx8mq_evk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/imx8mq_evk.rst
>>> rename to doc/board/nxp/imx8mq_evk.rst
>>> diff --git a/doc/board/freescale/imx8qxp_mek.rst b/doc/board/nxp/imx8qxp_mek.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/imx8qxp_mek.rst
>>> rename to doc/board/nxp/imx8qxp_mek.rst
>>> diff --git a/doc/board/freescale/imxrt1020-evk.rst b/doc/board/nxp/imxrt1020-evk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/imxrt1020-evk.rst
>>> rename to doc/board/nxp/imxrt1020-evk.rst
>>> diff --git a/doc/board/freescale/imxrt1050-evk.rst b/doc/board/nxp/imxrt1050-evk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/imxrt1050-evk.rst
>>> rename to doc/board/nxp/imxrt1050-evk.rst
>>> diff --git a/doc/board/freescale/index.rst b/doc/board/nxp/index.rst
>>> similarity index 86%
>>> rename from doc/board/freescale/index.rst
>>> rename to doc/board/nxp/index.rst
>>> index aa192effab..63956287c5 100644
>>> --- a/doc/board/freescale/index.rst
>>> +++ b/doc/board/nxp/index.rst
>>> @@ -1,7 +1,7 @@
>>>    .. SPDX-License-Identifier: GPL-2.0+
>>>
>>> -Freescale
>>> -=========
>>> +NXP Semiconductors
>>> +==================
>>>
>>>    .. toctree::
>>>       :maxdepth: 2
>>> diff --git a/doc/board/freescale/mx6sabreauto.rst b/doc/board/nxp/mx6sabreauto.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/mx6sabreauto.rst
>>> rename to doc/board/nxp/mx6sabreauto.rst
>>> diff --git a/doc/board/freescale/mx6sabresd.rst b/doc/board/nxp/mx6sabresd.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/mx6sabresd.rst
>>> rename to doc/board/nxp/mx6sabresd.rst
>>> diff --git a/doc/board/freescale/mx6ul_14x14_evk.rst b/doc/board/nxp/mx6ul_14x14_evk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/mx6ul_14x14_evk.rst
>>> rename to doc/board/nxp/mx6ul_14x14_evk.rst
>>> diff --git a/doc/board/freescale/mx6ullevk.rst b/doc/board/nxp/mx6ullevk.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/mx6ullevk.rst
>>> rename to doc/board/nxp/mx6ullevk.rst
>>> diff --git a/doc/board/freescale/psb.rst b/doc/board/nxp/psb.rst
>>> similarity index 100%
>>> rename from doc/board/freescale/psb.rst
>>> rename to doc/board/nxp/psb.rst
>>> --
>>> 2.30.2
>>>
>>
>>
>> --
>> =====================================================================
>> 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
>> =====================================================================