[Documentation] Use release-notes machine-list.inc In user-guide

Submitted by Thomas A. F. Thorne on May 16, 2019, 12:38 p.m. | Patch ID: 161283

Details

Message ID 20190516123836.11165-1-TafThorne@GoogleMail.com
State New
Headers show

Commit Message

Thomas A. F. Thorne May 16, 2019, 12:38 p.m.
The user-guide gets little attention compared to the release notes.
Frequently the correct list of supported machines is visible in the
release notes but the user-guide is left very out of date.  This change
switches to using the machine-list.inc file in the release directory in
both documents to help ensure the user-guide stays up to date.

This issue is described in GitHub Issue #28

Signed-off-by: Thomas A. F. Thorne <TafThorne@GoogleMail.com>
---
 user-guide/source/machine-list.inc | 65 ------------------------------
 user-guide/source/machines.rst     |  2 +-
 2 files changed, 1 insertion(+), 66 deletions(-)
 delete mode 100644 user-guide/source/machine-list.inc

Patch hide | download patch | download mbox

diff --git a/user-guide/source/machine-list.inc b/user-guide/source/machine-list.inc
deleted file mode 100644
index f5f1f2a..0000000
--- a/user-guide/source/machine-list.inc
+++ /dev/null
@@ -1,65 +0,0 @@ 
-======================  ==================================================  =======================  ==================
-       Machine                                 Name                                   SoC                  Layer
-======================  ==================================================  =======================  ==================
-apalis-imx6             Toradex Apalis iMX6Q/D                              i.MX6                    meta-fsl-arm-extra
-cfa10036                Crystalfontz CFA-10036                              i.MX28                   meta-fsl-arm-extra
-cfa10037                Crystalfontz CFA-10037                              i.MX28                   meta-fsl-arm-extra
-cfa10049                Crystalfontz CFA-10049                              i.MX28                   meta-fsl-arm-extra
-cfa10055                Crystalfontz CFA-10055                              i.MX28                   meta-fsl-arm-extra
-cfa10056                Crystalfontz CFA-10056                              i.MX28                   meta-fsl-arm-extra
-cfa10057                Crystalfontz CFA-10057                              i.MX28                   meta-fsl-arm-extra
-cfa10058                Crystalfontz CFA-10058                              i.MX28                   meta-fsl-arm-extra
-cgtqmx6                 Congatec QMX6 Evaluation board                      i.MX6 Q/DL               meta-fsl-arm-extra
-cm-fx6                  CompuLab CM-FX6                                     i.MX6 Q/DL               meta-fsl-arm-extra
-colibri-imx6            Toradex Colibri iMX6DL/S                            i.MX6 DL/S               meta-fsl-arm-extra
-colibri-imx7            Toradex Colibri iMX7D/S                             i.MX 7Dual / i.MX 7Solo  meta-fsl-arm-extra
-colibri-vf              Toradex Colibri VF50/VF61                           VF500/VF610              meta-fsl-arm-extra
-cubox-i                 SolidRun CuBox-i and HummingBoard                   i.MX6 Q/DL               meta-fsl-arm-extra
-imx233-olinuxino-maxi   OLIMEX iMX233-OLinuXino-Maxi                        i.MX23                   meta-fsl-arm-extra
-imx233-olinuxino-micro  OLIMEX iMX233-OLinuXino-Micro                       i.MX23                   meta-fsl-arm-extra
-imx233-olinuxino-mini   OLIMEX iMX233-OLinuXino-Mini                        i.MX23                   meta-fsl-arm-extra
-imx233-olinuxino-nano   OLIMEX iMX233-OLinuXino-Nano                        i.MX23                   meta-fsl-arm-extra
-imx23evk                Freescale i.MX23 Evaluation Kit                     i.MX23                   meta-fsl-arm
-imx28evk                Freescale i.MX28 Evaluation Kit                     i.MX28                   meta-fsl-arm
-imx51evk                Freescale i.MX51 Evaluation Kit                     i.MX51                   meta-fsl-arm
-imx53ard                Freescale i.MX53 SABRE Automotive Board             i.MX53                   meta-fsl-arm
-imx53qsb                Freescale i.MX53 Quick Start Board                  i.MX53                   meta-fsl-arm
-imx6dl-riotboard        RIoTboard                                           i.MX6S                   meta-fsl-arm-extra
-imx6dlsabreauto         Freescale i.MX6DL SABRE Automotive                  i.MX6DL                  meta-fsl-arm
-imx6dlsabresd           Freescale i.MX6DL SABRE Smart Device                i.MX6DL                  meta-fsl-arm
-imx6q-dms-ba16          Advantech DMS BA16                                  i.MX6Q                   meta-fsl-arm-extra
-imx6qdl-variscite-som   Variscite i.MX6Q/DL VAR-SOM-MX6                     i.MX6Q/DL                meta-fsl-arm-extra
-imx6qpsabreauto         Freescale i.MX6Q Plus SABRE Automotive              i.MX6QP                  meta-fsl-arm
-imx6qpsabresd           Freescale i.MX6Q Plus SABRE Smart Device            i.MX6QP                  meta-fsl-arm
-imx6qsabreauto          Freescale i.MX6Q SABRE Automotive                   i.MX6Q                   meta-fsl-arm
-imx6qsabrelite          Boundary Devices i.MX6Q SABRE Lite                  i.MX6Q                   meta-fsl-arm-extra
-imx6qsabresd            Freescale i.MX6Q SABRE Smart Device                 i.MX6Q                   meta-fsl-arm
-imx6sl-warp             WaRP                                                i.MX6SL                  meta-fsl-arm-extra
-imx6slevk               Freescale i.MX6SL Evaluation Kit                    i.MX6SL                  meta-fsl-arm
-imx6solosabreauto       Freescale i.MX6Solo SABRE Automotive                i.MX6S                   meta-fsl-arm
-imx6solosabresd         Freescale i.MX6Solo SABRE Smart Device              i.MX6S                   meta-fsl-arm
-imx6sxsabreauto         Freescale i.MX6SoloX Sabre Automotive               i.MX6SX                  meta-fsl-arm
-imx6sxsabresd           Freescale i.MX6SoloX SabreSD                        i.MX6SX                  meta-fsl-arm
-imx6ul-pico-hobbit      Hobbitboard (PICO-IMX6UL)                           i.MX6UL                  meta-fsl-arm-extra
-imx6ulevk               Freescale i.MX6UL Evaluation Kit                    i.MX6UL                  meta-fsl-arm
-imx7dsabresd            Freescale i.MX7D SABRE Smart Device                 i.MX7D                   meta-fsl-arm
-imx7s-warp              WaRP7                                               i.MX7S                   meta-fsl-arm-extra
-ls1021atwr              Freescale LS1021ATWR board                          ls102xa                  meta-fsl-arm
-m28evk                  DENX M28 SoM Evaluation Kit                         i.MX28                   meta-fsl-arm-extra
-m53evk                  DENX M53 SoM Evaluation Kit                         i.MX53                   meta-fsl-arm-extra
-nitrogen6sx             Boundary Devices Nitrogen6SX                        i.MX6SX                  meta-fsl-arm-extra
-nitrogen6x              Boundary Devices Nitrogen6X                         i.MX6 Q/DL               meta-fsl-arm-extra
-nitrogen6x-lite         Boundary Devices Nitrogen6X Lite                    i.MX6S                   meta-fsl-arm-extra
-nitrogen7               Boundary Devices Nitrogen7                          i.MX7D                   meta-fsl-arm-extra
-pcm052                  Phytec phyCORE Vybrid Development Kit               vf60                     meta-fsl-arm-extra
-twr-vf65gs10            Freescale Vybrid TWR-VF65GS10                       VF610                    meta-fsl-arm
-tx6q-10x0               Ka-Ro electronics i.MX6Q TX6Q Computer-On-Module    i.MX6Q                   meta-fsl-arm-extra
-tx6q-11x0               Ka-Ro electronics i.MX6Q TX6Q Computer-On-Module    i.MX6Q                   meta-fsl-arm-extra
-tx6s-8034               Ka-Ro electronics i.MX6S TX6S Computer-On-Module    i.MX6S                   meta-fsl-arm-extra
-tx6s-8035               Ka-Ro electronics i.MX6S TX6S Computer-On-Module    i.MX6S                   meta-fsl-arm-extra
-tx6u-8033               Ka-Ro electronics i.MX6DL TX6DL Computer-On-Module  i.MX6DL                  meta-fsl-arm-extra
-tx6u-80x0               Ka-Ro electronics i.MX6DL TX6DL Computer-On-Module  i.MX6DL                  meta-fsl-arm-extra
-tx6u-81x0               Ka-Ro electronics i.MX6DL TX6DL Computer-On-Module  i.MX6DL                  meta-fsl-arm-extra
-ventana                 i.MX6Q/DL Ventana Platform                          i.MX6Q/DL                meta-fsl-arm-extra
-wandboard               Wandboard i.MX6 Wandboard Quad/Dual/Solo            i.MX6Q/DL                meta-fsl-arm-extra
-======================  ==================================================  =======================  ==================
diff --git a/user-guide/source/machines.rst b/user-guide/source/machines.rst
index c32e550..3f848f5 100644
--- a/user-guide/source/machines.rst
+++ b/user-guide/source/machines.rst
@@ -10,5 +10,5 @@  Please refer to the table below for the complete list of supported boards.
 .. tabularcolumns:: c | p{5cm} | c | c
 .. table:: Supported machines
 
-   .. include:: machine-list.inc
+   .. include:: ../../release-notes/source/machine-list.inc
 

Comments

Daiane Angolini May 16, 2019, 4:28 p.m.
On Thu, May 16, 2019 at 9:40 AM Thomas A. F. Thorne
<tafthorne@googlemail.com> wrote:
>
> The user-guide gets little attention compared to the release notes.
> Frequently the correct list of supported machines is visible in the
> release notes but the user-guide is left very out of date.  This change
> switches to using the machine-list.inc file in the release directory in
> both documents to help ensure the user-guide stays up to date.
>
> This issue is described in GitHub Issue #28

Thanks for the patch. PR merged!

Daiane
>
> Signed-off-by: Thomas A. F. Thorne <TafThorne@GoogleMail.com>
> ---
>  user-guide/source/machine-list.inc | 65 ------------------------------
>  user-guide/source/machines.rst     |  2 +-
>  2 files changed, 1 insertion(+), 66 deletions(-)
>  delete mode 100644 user-guide/source/machine-list.inc
>
> diff --git a/user-guide/source/machine-list.inc b/user-guide/source/machine-list.inc
> deleted file mode 100644
> index f5f1f2a..0000000
> --- a/user-guide/source/machine-list.inc
> +++ /dev/null
> @@ -1,65 +0,0 @@
> -======================  ==================================================  =======================  ==================
> -       Machine                                 Name                                   SoC                  Layer
> -======================  ==================================================  =======================  ==================
> -apalis-imx6             Toradex Apalis iMX6Q/D                              i.MX6                    meta-fsl-arm-extra
> -cfa10036                Crystalfontz CFA-10036                              i.MX28                   meta-fsl-arm-extra
> -cfa10037                Crystalfontz CFA-10037                              i.MX28                   meta-fsl-arm-extra
> -cfa10049                Crystalfontz CFA-10049                              i.MX28                   meta-fsl-arm-extra
> -cfa10055                Crystalfontz CFA-10055                              i.MX28                   meta-fsl-arm-extra
> -cfa10056                Crystalfontz CFA-10056                              i.MX28                   meta-fsl-arm-extra
> -cfa10057                Crystalfontz CFA-10057                              i.MX28                   meta-fsl-arm-extra
> -cfa10058                Crystalfontz CFA-10058                              i.MX28                   meta-fsl-arm-extra
> -cgtqmx6                 Congatec QMX6 Evaluation board                      i.MX6 Q/DL               meta-fsl-arm-extra
> -cm-fx6                  CompuLab CM-FX6                                     i.MX6 Q/DL               meta-fsl-arm-extra
> -colibri-imx6            Toradex Colibri iMX6DL/S                            i.MX6 DL/S               meta-fsl-arm-extra
> -colibri-imx7            Toradex Colibri iMX7D/S                             i.MX 7Dual / i.MX 7Solo  meta-fsl-arm-extra
> -colibri-vf              Toradex Colibri VF50/VF61                           VF500/VF610              meta-fsl-arm-extra
> -cubox-i                 SolidRun CuBox-i and HummingBoard                   i.MX6 Q/DL               meta-fsl-arm-extra
> -imx233-olinuxino-maxi   OLIMEX iMX233-OLinuXino-Maxi                        i.MX23                   meta-fsl-arm-extra
> -imx233-olinuxino-micro  OLIMEX iMX233-OLinuXino-Micro                       i.MX23                   meta-fsl-arm-extra
> -imx233-olinuxino-mini   OLIMEX iMX233-OLinuXino-Mini                        i.MX23                   meta-fsl-arm-extra
> -imx233-olinuxino-nano   OLIMEX iMX233-OLinuXino-Nano                        i.MX23                   meta-fsl-arm-extra
> -imx23evk                Freescale i.MX23 Evaluation Kit                     i.MX23                   meta-fsl-arm
> -imx28evk                Freescale i.MX28 Evaluation Kit                     i.MX28                   meta-fsl-arm
> -imx51evk                Freescale i.MX51 Evaluation Kit                     i.MX51                   meta-fsl-arm
> -imx53ard                Freescale i.MX53 SABRE Automotive Board             i.MX53                   meta-fsl-arm
> -imx53qsb                Freescale i.MX53 Quick Start Board                  i.MX53                   meta-fsl-arm
> -imx6dl-riotboard        RIoTboard                                           i.MX6S                   meta-fsl-arm-extra
> -imx6dlsabreauto         Freescale i.MX6DL SABRE Automotive                  i.MX6DL                  meta-fsl-arm
> -imx6dlsabresd           Freescale i.MX6DL SABRE Smart Device                i.MX6DL                  meta-fsl-arm
> -imx6q-dms-ba16          Advantech DMS BA16                                  i.MX6Q                   meta-fsl-arm-extra
> -imx6qdl-variscite-som   Variscite i.MX6Q/DL VAR-SOM-MX6                     i.MX6Q/DL                meta-fsl-arm-extra
> -imx6qpsabreauto         Freescale i.MX6Q Plus SABRE Automotive              i.MX6QP                  meta-fsl-arm
> -imx6qpsabresd           Freescale i.MX6Q Plus SABRE Smart Device            i.MX6QP                  meta-fsl-arm
> -imx6qsabreauto          Freescale i.MX6Q SABRE Automotive                   i.MX6Q                   meta-fsl-arm
> -imx6qsabrelite          Boundary Devices i.MX6Q SABRE Lite                  i.MX6Q                   meta-fsl-arm-extra
> -imx6qsabresd            Freescale i.MX6Q SABRE Smart Device                 i.MX6Q                   meta-fsl-arm
> -imx6sl-warp             WaRP                                                i.MX6SL                  meta-fsl-arm-extra
> -imx6slevk               Freescale i.MX6SL Evaluation Kit                    i.MX6SL                  meta-fsl-arm
> -imx6solosabreauto       Freescale i.MX6Solo SABRE Automotive                i.MX6S                   meta-fsl-arm
> -imx6solosabresd         Freescale i.MX6Solo SABRE Smart Device              i.MX6S                   meta-fsl-arm
> -imx6sxsabreauto         Freescale i.MX6SoloX Sabre Automotive               i.MX6SX                  meta-fsl-arm
> -imx6sxsabresd           Freescale i.MX6SoloX SabreSD                        i.MX6SX                  meta-fsl-arm
> -imx6ul-pico-hobbit      Hobbitboard (PICO-IMX6UL)                           i.MX6UL                  meta-fsl-arm-extra
> -imx6ulevk               Freescale i.MX6UL Evaluation Kit                    i.MX6UL                  meta-fsl-arm
> -imx7dsabresd            Freescale i.MX7D SABRE Smart Device                 i.MX7D                   meta-fsl-arm
> -imx7s-warp              WaRP7                                               i.MX7S                   meta-fsl-arm-extra
> -ls1021atwr              Freescale LS1021ATWR board                          ls102xa                  meta-fsl-arm
> -m28evk                  DENX M28 SoM Evaluation Kit                         i.MX28                   meta-fsl-arm-extra
> -m53evk                  DENX M53 SoM Evaluation Kit                         i.MX53                   meta-fsl-arm-extra
> -nitrogen6sx             Boundary Devices Nitrogen6SX                        i.MX6SX                  meta-fsl-arm-extra
> -nitrogen6x              Boundary Devices Nitrogen6X                         i.MX6 Q/DL               meta-fsl-arm-extra
> -nitrogen6x-lite         Boundary Devices Nitrogen6X Lite                    i.MX6S                   meta-fsl-arm-extra
> -nitrogen7               Boundary Devices Nitrogen7                          i.MX7D                   meta-fsl-arm-extra
> -pcm052                  Phytec phyCORE Vybrid Development Kit               vf60                     meta-fsl-arm-extra
> -twr-vf65gs10            Freescale Vybrid TWR-VF65GS10                       VF610                    meta-fsl-arm
> -tx6q-10x0               Ka-Ro electronics i.MX6Q TX6Q Computer-On-Module    i.MX6Q                   meta-fsl-arm-extra
> -tx6q-11x0               Ka-Ro electronics i.MX6Q TX6Q Computer-On-Module    i.MX6Q                   meta-fsl-arm-extra
> -tx6s-8034               Ka-Ro electronics i.MX6S TX6S Computer-On-Module    i.MX6S                   meta-fsl-arm-extra
> -tx6s-8035               Ka-Ro electronics i.MX6S TX6S Computer-On-Module    i.MX6S                   meta-fsl-arm-extra
> -tx6u-8033               Ka-Ro electronics i.MX6DL TX6DL Computer-On-Module  i.MX6DL                  meta-fsl-arm-extra
> -tx6u-80x0               Ka-Ro electronics i.MX6DL TX6DL Computer-On-Module  i.MX6DL                  meta-fsl-arm-extra
> -tx6u-81x0               Ka-Ro electronics i.MX6DL TX6DL Computer-On-Module  i.MX6DL                  meta-fsl-arm-extra
> -ventana                 i.MX6Q/DL Ventana Platform                          i.MX6Q/DL                meta-fsl-arm-extra
> -wandboard               Wandboard i.MX6 Wandboard Quad/Dual/Solo            i.MX6Q/DL                meta-fsl-arm-extra
> -======================  ==================================================  =======================  ==================
> diff --git a/user-guide/source/machines.rst b/user-guide/source/machines.rst
> index c32e550..3f848f5 100644
> --- a/user-guide/source/machines.rst
> +++ b/user-guide/source/machines.rst
> @@ -10,5 +10,5 @@ Please refer to the table below for the complete list of supported boards.
>  .. tabularcolumns:: c | p{5cm} | c | c
>  .. table:: Supported machines
>
> -   .. include:: machine-list.inc
> +   .. include:: ../../release-notes/source/machine-list.inc
>
> --
> 2.17.1
>
> --
> _______________________________________________
> meta-freescale mailing list
> meta-freescale@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/meta-freescale