mbox series

[U-Boot,0/7] Restructure the i.MX U-Boot documentation

Message ID 1539133788-55-1-git-send-email-breno.lima@nxp.com
Headers show
Series Restructure the i.MX U-Boot documentation | expand

Message

Breno Matheus Lima Oct. 10, 2018, 1:10 a.m. UTC
This patch set is restructuring and cleaning up the current i.MX documentation
included in the U-Boot doc directory.

The current i.MX documentation is in the root directory so we cannot easily
check which one is i.MX related:
http://git.denx.de/?p=u-boot/u-boot-imx.git;a=tree;f=doc;

This series is restructuring the documentation only relevant for i.MX devices
in a new imx directory:

doc
└── imx
        ├── common
        │       ├── imx25.txt
        │       ├── imx27.txt
        │       ├── imx5.txt
        │       ├── imx6.txt
        │       └── mxs.txt
        ├── hab
        │       └── habv4
        │                ├── encrypted_boot.txt
        │                └── secure_boot.txt
        ├── misc
        │       └── sdp.txt
        └── mkimage
                 ├── imximage.txt
                 └── mxsimage.txt

Subsequent patches will include more content in HAB documentation.

Breno Lima (7):
  doc: imx: reorganize i.MX documentation
  doc: imx: Move SPD related info to the appropriate doc
  doc: imx: mkimage: reorganize i.MX mkimage documentation
  doc: imx: Reorganize i.MX SoC common documentation
  doc: imx: hab: Reorganize High Assurance Boot documentation
  doc: imx: misc: Reorganize miscellaneous documentation
  doc: imx: Improve i.MX documentation naming

 doc/{README.imx25 => imx/common/imx25.txt}    |  0
 doc/{README.imx27 => imx/common/imx27.txt}    |  0
 doc/{README.imx5 => imx/common/imx5.txt}      |  0
 doc/{README.imx6 => imx/common/imx6.txt}      | 25 -----------
 doc/{README.mxs => imx/common/mxs.txt}        |  0
 doc/imx/hab/habv4/encrypted_boot.txt          | 43 ++++++++++++++++++
 .../hab/habv4/secure_boot.txt}                | 44 -------------------
 doc/{README.sdp => imx/misc/sdp.txt}          | 22 +++++++++-
 .../mkimage/imximage.txt}                     |  0
 .../mkimage/mxsimage.txt}                     |  0
 10 files changed, 63 insertions(+), 71 deletions(-)
 rename doc/{README.imx25 => imx/common/imx25.txt} (100%)
 rename doc/{README.imx27 => imx/common/imx27.txt} (100%)
 rename doc/{README.imx5 => imx/common/imx5.txt} (100%)
 rename doc/{README.imx6 => imx/common/imx6.txt} (73%)
 rename doc/{README.mxs => imx/common/mxs.txt} (100%)
 create mode 100644 doc/imx/hab/habv4/encrypted_boot.txt
 rename doc/{README.mxc_hab => imx/hab/habv4/secure_boot.txt} (68%)
 rename doc/{README.sdp => imx/misc/sdp.txt} (82%)
 rename doc/{README.imximage => imx/mkimage/imximage.txt} (100%)
 rename doc/{README.mxsimage => imx/mkimage/mxsimage.txt} (100%)

Comments

Fabio Estevam Oct. 15, 2018, 11:06 a.m. UTC | #1
Hi Breno,

On Tue, Oct 9, 2018 at 10:54 PM Breno Matheus Lima <breno.lima@nxp.com> wrote:
>
> This patch set is restructuring and cleaning up the current i.MX documentation
> included in the U-Boot doc directory.
>
> The current i.MX documentation is in the root directory so we cannot easily
> check which one is i.MX related:
> http://git.denx.de/?p=u-boot/u-boot-imx.git;a=tree;f=doc;
>
> This series is restructuring the documentation only relevant for i.MX devices
> in a new imx directory:
>
> doc
> └── imx
>         ├── common
>         │       ├── imx25.txt
>         │       ├── imx27.txt
>         │       ├── imx5.txt
>         │       ├── imx6.txt
>         │       └── mxs.txt
>         ├── hab
>         │       └── habv4
>         │                ├── encrypted_boot.txt
>         │                └── secure_boot.txt
>         ├── misc
>         │       └── sdp.txt
>         └── mkimage
>                  ├── imximage.txt
>                  └── mxsimage.txt
>
> Subsequent patches will include more content in HAB documentation.
>
> Breno Lima (7):
>   doc: imx: reorganize i.MX documentation
>   doc: imx: Move SPD related info to the appropriate doc
>   doc: imx: mkimage: reorganize i.MX mkimage documentation
>   doc: imx: Reorganize i.MX SoC common documentation
>   doc: imx: hab: Reorganize High Assurance Boot documentation
>   doc: imx: misc: Reorganize miscellaneous documentation
>   doc: imx: Improve i.MX documentation naming

I think this cleanup makes things better organized, thanks:

Reviewed-by: Fabio Estevam <festevam@gmail.com>
Stefano Babic Oct. 22, 2018, 12:25 p.m. UTC | #2
On 10/10/18 03:10, Breno Matheus Lima wrote:
> This patch set is restructuring and cleaning up the current i.MX documentation
> included in the U-Boot doc directory.
> 
> The current i.MX documentation is in the root directory so we cannot easily
> check which one is i.MX related:
> http://git.denx.de/?p=u-boot/u-boot-imx.git;a=tree;f=doc;
> 
> This series is restructuring the documentation only relevant for i.MX devices
> in a new imx directory:
> 
> doc
> └── imx
>         ├── common
>         │       ├── imx25.txt
>         │       ├── imx27.txt
>         │       ├── imx5.txt
>         │       ├── imx6.txt
>         │       └── mxs.txt
>         ├── hab
>         │       └── habv4
>         │                ├── encrypted_boot.txt
>         │                └── secure_boot.txt
>         ├── misc
>         │       └── sdp.txt
>         └── mkimage
>                  ├── imximage.txt
>                  └── mxsimage.txt
> 
> Subsequent patches will include more content in HAB documentation.
> 
> Breno Lima (7):
>   doc: imx: reorganize i.MX documentation
>   doc: imx: Move SPD related info to the appropriate doc
>   doc: imx: mkimage: reorganize i.MX mkimage documentation
>   doc: imx: Reorganize i.MX SoC common documentation
>   doc: imx: hab: Reorganize High Assurance Boot documentation
>   doc: imx: misc: Reorganize miscellaneous documentation
>   doc: imx: Improve i.MX documentation naming
> 
>  doc/{README.imx25 => imx/common/imx25.txt}    |  0
>  doc/{README.imx27 => imx/common/imx27.txt}    |  0
>  doc/{README.imx5 => imx/common/imx5.txt}      |  0
>  doc/{README.imx6 => imx/common/imx6.txt}      | 25 -----------
>  doc/{README.mxs => imx/common/mxs.txt}        |  0
>  doc/imx/hab/habv4/encrypted_boot.txt          | 43 ++++++++++++++++++
>  .../hab/habv4/secure_boot.txt}                | 44 -------------------
>  doc/{README.sdp => imx/misc/sdp.txt}          | 22 +++++++++-
>  .../mkimage/imximage.txt}                     |  0
>  .../mkimage/mxsimage.txt}                     |  0
>  10 files changed, 63 insertions(+), 71 deletions(-)
>  rename doc/{README.imx25 => imx/common/imx25.txt} (100%)
>  rename doc/{README.imx27 => imx/common/imx27.txt} (100%)
>  rename doc/{README.imx5 => imx/common/imx5.txt} (100%)
>  rename doc/{README.imx6 => imx/common/imx6.txt} (73%)
>  rename doc/{README.mxs => imx/common/mxs.txt} (100%)
>  create mode 100644 doc/imx/hab/habv4/encrypted_boot.txt
>  rename doc/{README.mxc_hab => imx/hab/habv4/secure_boot.txt} (68%)
>  rename doc/{README.sdp => imx/misc/sdp.txt} (82%)
>  rename doc/{README.imximage => imx/mkimage/imximage.txt} (100%)
>  rename doc/{README.mxsimage => imx/mkimage/mxsimage.txt} (100%)
> 

Nice work !

Applied to u-boot-imx, thanks !

Best regards,
Stefano Babic