[PATCH 0/3] doc: rockchip: Improve documentation

As an additional step in the process of improve the Rockchip documentation and based on the comments from [1] move the list of supported boards and configs to doc/board/rockchip.
[1] https://patchwork.ozlabs.org/project/uboot/list/?series=177974
Walter Lozano (3): doc: board: rockchip: Improve supported board list format doc: board: rockchip: Add missing supported boards doc: rockchip: Remove list of supported boards
doc/README.rockchip | 72 ++-------------------------- doc/board/rockchip/rockchip.rst | 84 ++++++++++++++++++++------------- 2 files changed, 54 insertions(+), 102 deletions(-)

As an additional step to move documentation to doc/boards/rockchip improve format of the supported board list to make it more readable. Additionally, add the configuration files used to build them based on doc/README.rockchip.
Signed-off-by: Walter Lozano walter.lozano@collabora.com --- doc/board/rockchip/rockchip.rst | 68 ++++++++++++++++----------------- 1 file changed, 34 insertions(+), 34 deletions(-)
diff --git a/doc/board/rockchip/rockchip.rst b/doc/board/rockchip/rockchip.rst index cd9c8d6dc4..919a686423 100644 --- a/doc/board/rockchip/rockchip.rst +++ b/doc/board/rockchip/rockchip.rst @@ -22,43 +22,43 @@ mainline U-Boot. List of mainline supported rockchip boards:
* rk3288 - - Evb-RK3288 - - Firefly-RK3288 - - mqmaker MiQi - - Phytec RK3288 PCM-947 - - PopMetal-RK3288 - - Radxa Rock 2 Square - - Tinker-RK3288 - - Google Jerry - - Google Mickey - - Google Minnie - - Google Speedy - - Amarula Vyasa-RK3288 + - Rockchip Evb-RK3288 (evb-rk3288) + - Firefly-RK3288 (firefly-rk3288) + - MQmaker MiQi (miqi-rk3288) + - Phytec RK3288 PCM-947 (phycore-rk3288) + - PopMetal-RK3288 (popmetal-rk3288) + - Radxa Rock 2 Square (rock2) + - Tinker-RK3288 (tinker-rk3288) + - Google Jerry (chromebook_jerry) + - Google Mickey (chromebook_mickey) + - Google Minnie (chromebook_minnie) + - Google Speedy (chromebook_speedy) + - Amarula Vyasa-RK3288 (vyasa-rk3288) * rk3328 - - Rockchip RK3328 EVB - - Pine64 Rock64 + - Rockchip Evb-RK3328 (evb-rk3328) + - Pine64 Rock64 (rock64-rk3328) * rk3368 - - GeekBox - - PX5 EVB - - Rockchip sheep board - - Theobroma Systems RK3368-uQ7 SoM + - GeekBox (geekbox) + - PX5 EVB (evb-px5) + - Rockchip Sheep (sheep-rk3368) + - Theobroma Systems RK3368-uQ7 SoM - Lion (lion-rk3368) * rk3399 - - 96boards RK3399 Ficus - - 96boards Rock960 - - Firefly-RK3399 Board - - Firefly ROC-RK3399-PC Board - - FriendlyElec NanoPC-T4 - - FriendlyElec NanoPi M4 - - FriendlyARM NanoPi NEO4 - - Google Bob - - Khadas Edge - - Khadas Edge-Captain - - Khadas Edge-V - - Orange Pi RK3399 Board - - Pine64 RockPro64 - - Radxa ROCK Pi 4 - - Rockchip RK3399 Evaluation Board - - Theobroma Systems RK3399-Q7 SoM + - 96boards RK3399 Ficus (ficus-rk3399) + - 96boards Rock960 (rock960-rk3399) + - Firefly-RK3399 (firefly_rk3399) + - Firefly ROC-RK3399-PC + - FriendlyElec NanoPC-T4 (nanopc-t4-rk3399) + - FriendlyElec NanoPi M4 (nanopi-m4-rk3399) + - FriendlyARM NanoPi NEO4 (nanopi-neo4-rk3399) + - Google Bob (chromebook_bob) + - Khadas Edge (khadas-edge-rk3399) + - Khadas Edge-Captain (khadas-edge-captain-rk3399) + - Khadas Edge-V (hadas-edge-v-rk3399) + - Orange Pi RK3399 (orangepi-rk3399) + - Pine64 RockPro64 (rockpro64-rk3399) + - Radxa ROCK Pi 4 (rock-pi-4-rk3399) + - Rockchip Evb-RK3399 (evb_rk3399) + - Theobroma Systems RK3399-Q7 SoM - Puma (puma_rk3399)
Building --------

On Fri, 22 May 2020 at 08:15, Walter Lozano walter.lozano@collabora.com wrote:
As an additional step to move documentation to doc/boards/rockchip improve format of the supported board list to make it more readable. Additionally, add the configuration files used to build them based on doc/README.rockchip.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
doc/board/rockchip/rockchip.rst | 68 ++++++++++++++++----------------- 1 file changed, 34 insertions(+), 34 deletions(-)
Reviewed-by: Simon Glass sjg@chromium.org

On 2020/5/22 下午10:14, Walter Lozano wrote:
As an additional step to move documentation to doc/boards/rockchip improve format of the supported board list to make it more readable. Additionally, add the configuration files used to build them based on doc/README.rockchip.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
Reviewed-by: Kever Yang kever.yang@rock-chips.com
Thanks, - Kever
doc/board/rockchip/rockchip.rst | 68 ++++++++++++++++----------------- 1 file changed, 34 insertions(+), 34 deletions(-)
diff --git a/doc/board/rockchip/rockchip.rst b/doc/board/rockchip/rockchip.rst index cd9c8d6dc4..919a686423 100644 --- a/doc/board/rockchip/rockchip.rst +++ b/doc/board/rockchip/rockchip.rst @@ -22,43 +22,43 @@ mainline U-Boot. List of mainline supported rockchip boards:
- rk3288
- Evb-RK3288
- Firefly-RK3288
- mqmaker MiQi
- Phytec RK3288 PCM-947
- PopMetal-RK3288
- Radxa Rock 2 Square
- Tinker-RK3288
- Google Jerry
- Google Mickey
- Google Minnie
- Google Speedy
- Amarula Vyasa-RK3288
- Rockchip Evb-RK3288 (evb-rk3288)
- Firefly-RK3288 (firefly-rk3288)
- MQmaker MiQi (miqi-rk3288)
- Phytec RK3288 PCM-947 (phycore-rk3288)
- PopMetal-RK3288 (popmetal-rk3288)
- Radxa Rock 2 Square (rock2)
- Tinker-RK3288 (tinker-rk3288)
- Google Jerry (chromebook_jerry)
- Google Mickey (chromebook_mickey)
- Google Minnie (chromebook_minnie)
- Google Speedy (chromebook_speedy)
- Amarula Vyasa-RK3288 (vyasa-rk3288)
- rk3328
- Rockchip RK3328 EVB
- Pine64 Rock64
- Rockchip Evb-RK3328 (evb-rk3328)
- Pine64 Rock64 (rock64-rk3328)
- rk3368
- GeekBox
- PX5 EVB
- Rockchip sheep board
- Theobroma Systems RK3368-uQ7 SoM
- GeekBox (geekbox)
- PX5 EVB (evb-px5)
- Rockchip Sheep (sheep-rk3368)
- Theobroma Systems RK3368-uQ7 SoM - Lion (lion-rk3368)
- rk3399
- 96boards RK3399 Ficus
- 96boards Rock960
- Firefly-RK3399 Board
- Firefly ROC-RK3399-PC Board
- FriendlyElec NanoPC-T4
- FriendlyElec NanoPi M4
- FriendlyARM NanoPi NEO4
- Google Bob
- Khadas Edge
- Khadas Edge-Captain
- Khadas Edge-V
- Orange Pi RK3399 Board
- Pine64 RockPro64
- Radxa ROCK Pi 4
- Rockchip RK3399 Evaluation Board
- Theobroma Systems RK3399-Q7 SoM
- 96boards RK3399 Ficus (ficus-rk3399)
- 96boards Rock960 (rock960-rk3399)
- Firefly-RK3399 (firefly_rk3399)
- Firefly ROC-RK3399-PC
- FriendlyElec NanoPC-T4 (nanopc-t4-rk3399)
- FriendlyElec NanoPi M4 (nanopi-m4-rk3399)
- FriendlyARM NanoPi NEO4 (nanopi-neo4-rk3399)
- Google Bob (chromebook_bob)
- Khadas Edge (khadas-edge-rk3399)
- Khadas Edge-Captain (khadas-edge-captain-rk3399)
- Khadas Edge-V (hadas-edge-v-rk3399)
- Orange Pi RK3399 (orangepi-rk3399)
- Pine64 RockPro64 (rockpro64-rk3399)
- Radxa ROCK Pi 4 (rock-pi-4-rk3399)
- Rockchip Evb-RK3399 (evb_rk3399)
- Theobroma Systems RK3399-Q7 SoM - Puma (puma_rk3399)
Building

Update the list of supported boards with the information available on doc/README.rockchip.
Signed-off-by: Walter Lozano walter.lozano@collabora.com --- doc/board/rockchip/rockchip.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
diff --git a/doc/board/rockchip/rockchip.rst b/doc/board/rockchip/rockchip.rst index 919a686423..c174fd83bc 100644 --- a/doc/board/rockchip/rockchip.rst +++ b/doc/board/rockchip/rockchip.rst @@ -21,6 +21,13 @@ mainline U-Boot.
List of mainline supported rockchip boards:
+* rk3036 + - Rockchip Evb-RK3036 (evb-rk3036) + - Kylin (kylin_rk3036) +* rk3128 + - Rockchip Evb-RK3128 (evb-rk3128) +* rk3229 + - Rockchip Evb-RK3229 (evb-rk3229) * rk3288 - Rockchip Evb-RK3288 (evb-rk3288) - Firefly-RK3288 (firefly-rk3288) @@ -34,9 +41,13 @@ List of mainline supported rockchip boards: - Google Minnie (chromebook_minnie) - Google Speedy (chromebook_speedy) - Amarula Vyasa-RK3288 (vyasa-rk3288) +* rk3308 + - Rockchip Evb-RK3308 (evb-rk3308) + - Roc-cc-RK3308 (roc-cc-rk3308) * rk3328 - Rockchip Evb-RK3328 (evb-rk3328) - Pine64 Rock64 (rock64-rk3328) + - Firefly-RK3328 (roc-cc-rk3328) * rk3368 - GeekBox (geekbox) - PX5 EVB (evb-px5) @@ -59,6 +70,11 @@ List of mainline supported rockchip boards: - Radxa ROCK Pi 4 (rock-pi-4-rk3399) - Rockchip Evb-RK3399 (evb_rk3399) - Theobroma Systems RK3399-Q7 SoM - Puma (puma_rk3399) +* rv1108 + - Rockchip Evb-rv1108 (evb-rv1108) + - Elgin-R1 (elgin-rv1108) +* rv3188 + - Radxa Rock (rock)
Building --------

On Fri, 22 May 2020 at 08:15, Walter Lozano walter.lozano@collabora.com wrote:
Update the list of supported boards with the information available on doc/README.rockchip.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
doc/board/rockchip/rockchip.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
Reviewed-by: Simon Glass sjg@chromium.org

On 2020/5/22 下午10:14, Walter Lozano wrote:
Update the list of supported boards with the information available on doc/README.rockchip.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
Reviewed-by: Kever Yang kever.yang@rock-chips.com
Thanks, - Kever
doc/board/rockchip/rockchip.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
diff --git a/doc/board/rockchip/rockchip.rst b/doc/board/rockchip/rockchip.rst index 919a686423..c174fd83bc 100644 --- a/doc/board/rockchip/rockchip.rst +++ b/doc/board/rockchip/rockchip.rst @@ -21,6 +21,13 @@ mainline U-Boot.
List of mainline supported rockchip boards:
+* rk3036
- Rockchip Evb-RK3036 (evb-rk3036)
- Kylin (kylin_rk3036)
+* rk3128
- Rockchip Evb-RK3128 (evb-rk3128)
+* rk3229
- Rockchip Evb-RK3229 (evb-rk3229)
- rk3288
- Rockchip Evb-RK3288 (evb-rk3288)
- Firefly-RK3288 (firefly-rk3288)
@@ -34,9 +41,13 @@ List of mainline supported rockchip boards: - Google Minnie (chromebook_minnie) - Google Speedy (chromebook_speedy) - Amarula Vyasa-RK3288 (vyasa-rk3288) +* rk3308
- Rockchip Evb-RK3308 (evb-rk3308)
- Roc-cc-RK3308 (roc-cc-rk3308)
- rk3328
- Rockchip Evb-RK3328 (evb-rk3328)
- Pine64 Rock64 (rock64-rk3328)
- Firefly-RK3328 (roc-cc-rk3328)
- rk3368
- GeekBox (geekbox)
- PX5 EVB (evb-px5)
@@ -59,6 +70,11 @@ List of mainline supported rockchip boards: - Radxa ROCK Pi 4 (rock-pi-4-rk3399) - Rockchip Evb-RK3399 (evb_rk3399) - Theobroma Systems RK3399-Q7 SoM - Puma (puma_rk3399) +* rv1108
- Rockchip Evb-rv1108 (evb-rv1108)
- Elgin-R1 (elgin-rv1108)
+* rv3188
- Radxa Rock (rock)
Building

As documentation is being moved to doc/boards/rockchip create a warning message and remove the redundant list of supported boards.
Signed-off-by: Walter Lozano walter.lozano@collabora.com --- doc/README.rockchip | 72 +++------------------------------------------ 1 file changed, 4 insertions(+), 68 deletions(-)
diff --git a/doc/README.rockchip b/doc/README.rockchip index 70c8798ed2..154166ec78 100644 --- a/doc/README.rockchip +++ b/doc/README.rockchip @@ -8,6 +8,10 @@ U-Boot on Rockchip
A wide range of Rockchip SoCs are supported in mainline U-Boot
+Warning +======= +This document is being moved to doc/board/rockchip, so information on it +might be incomplete or outdated.
Prerequisites ============= @@ -24,77 +28,9 @@ You will need: - Suitable ARM cross compiler, e.g.: sudo apt-get install gcc-4.7-arm-linux-gnueabi
- Building ========
-At present 11 RK3288 boards are supported: - - - EVB RK3288 - use evb-rk3288 configuration - - Firefly RK3288 - use firefly-rk3288 configuration - - Hisense Chromebook - use chromebook_jerry configuration - - Asus C100P Chromebook - use chromebook_minnie configuration - - Asus Chromebit - use chromebook_mickey configuration - - MiQi RK3288 - use miqi-rk3288 configuration - - phyCORE-RK3288 RDK - use phycore-rk3288 configuration - - PopMetal RK3288 - use popmetal-rk3288 configuration - - Radxa Rock 2 - use rock2 configuration - - Tinker RK3288 - use tinker-rk3288 configuration - - Vyasa RK3288 - use vyasa-rk3288 configuration - -Two RK3036 boards are supported: - - - EVB RK3036 - use evb-rk3036 configuration - - Kylin - use kylin_rk3036 configuration - -Two RK3308 boards are supported: - - - EVB RK3308 - use evb-rk3308 configuration - - ROC-CC-RK3308 - use roc-cc-rk3308 configuration - -Three RK3328 boards are supported: - - - EVB RK3328 - use evb-rk3328_defconfig - - Pine64 Rock64 board - use rock64-rk3328_defconfig - - Firefly / Libre Computer Project ROC-RK3328-CC board - - use roc-cc-rk3328_defconfig - -Size RK3399 boards are supported (aarch64): - - - EBV RK3399 - use evb_rk3399 configuration - - Firefly RK3399 - use the firefly_rk3399 configuration - - Puma - use puma_rk3399 configuration - - Ficus - use ficus-rk3399 configuration - - Rock960 (Vamrs) - use rock960-rk3399 configuration - - Bob - use chromebook_bob configuration - -Four RK3368 boards are supported: - - - Sheep - use sheep-rk3368 configuration - - Lion - use lion-rk3368 configuration - - Geekbox - use geekbox configuration - - EVB PX5 - use evb-px5 configuration - -One RK3128 board is supported: - - - EVB RK3128 - use evb-rk3128 configuration - -One RK3229 board is supported: - - - EVB RK3229 - use evb-rk3229 configuration - -Two RV1108 boards are supported: - - - EVB RV1108 - use evb-rv1108 configuration - - Elgin R1 - use elgin-rv1108 configuration - -One RV3188 baord is supported: - - - Raxda Rock - use rock configuration - - -For example: - 1. To build RK3288 board:
CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all

On Fri, 22 May 2020 at 11:16, Walter Lozano walter.lozano@collabora.com wrote:
As documentation is being moved to doc/boards/rockchip create a warning message and remove the redundant list of supported boards.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
doc/README.rockchip | 72 +++------------------------------------------ 1 file changed, 4 insertions(+), 68 deletions(-)
How about we simply remove this file and move all its content to doc/boards/rockchip?
I'd say it can be all done in one go.
Thanks, Eze
diff --git a/doc/README.rockchip b/doc/README.rockchip index 70c8798ed2..154166ec78 100644 --- a/doc/README.rockchip +++ b/doc/README.rockchip @@ -8,6 +8,10 @@ U-Boot on Rockchip
A wide range of Rockchip SoCs are supported in mainline U-Boot
+Warning +======= +This document is being moved to doc/board/rockchip, so information on it +might be incomplete or outdated.
Prerequisites
@@ -24,77 +28,9 @@ You will need: - Suitable ARM cross compiler, e.g.: sudo apt-get install gcc-4.7-arm-linux-gnueabi
Building
-At present 11 RK3288 boards are supported:
- EVB RK3288 - use evb-rk3288 configuration
- Firefly RK3288 - use firefly-rk3288 configuration
- Hisense Chromebook - use chromebook_jerry configuration
- Asus C100P Chromebook - use chromebook_minnie configuration
- Asus Chromebit - use chromebook_mickey configuration
- MiQi RK3288 - use miqi-rk3288 configuration
- phyCORE-RK3288 RDK - use phycore-rk3288 configuration
- PopMetal RK3288 - use popmetal-rk3288 configuration
- Radxa Rock 2 - use rock2 configuration
- Tinker RK3288 - use tinker-rk3288 configuration
- Vyasa RK3288 - use vyasa-rk3288 configuration
-Two RK3036 boards are supported:
- EVB RK3036 - use evb-rk3036 configuration
- Kylin - use kylin_rk3036 configuration
-Two RK3308 boards are supported:
- EVB RK3308 - use evb-rk3308 configuration
- ROC-CC-RK3308 - use roc-cc-rk3308 configuration
-Three RK3328 boards are supported:
- EVB RK3328 - use evb-rk3328_defconfig
- Pine64 Rock64 board - use rock64-rk3328_defconfig
- Firefly / Libre Computer Project ROC-RK3328-CC board -
use roc-cc-rk3328_defconfig
-Size RK3399 boards are supported (aarch64):
- EBV RK3399 - use evb_rk3399 configuration
- Firefly RK3399 - use the firefly_rk3399 configuration
- Puma - use puma_rk3399 configuration
- Ficus - use ficus-rk3399 configuration
- Rock960 (Vamrs) - use rock960-rk3399 configuration
- Bob - use chromebook_bob configuration
-Four RK3368 boards are supported:
- Sheep - use sheep-rk3368 configuration
- Lion - use lion-rk3368 configuration
- Geekbox - use geekbox configuration
- EVB PX5 - use evb-px5 configuration
-One RK3128 board is supported:
- EVB RK3128 - use evb-rk3128 configuration
-One RK3229 board is supported:
- EVB RK3229 - use evb-rk3229 configuration
-Two RV1108 boards are supported:
- EVB RV1108 - use evb-rv1108 configuration
- Elgin R1 - use elgin-rv1108 configuration
-One RV3188 baord is supported:
- Raxda Rock - use rock configuration
-For example:
To build RK3288 board:
CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
-- 2.20.1

Hi Ezequiel,
On 22/5/20 18:37, Ezequiel Garcia wrote:
On Fri, 22 May 2020 at 11:16, Walter Lozano walter.lozano@collabora.com wrote:
As documentation is being moved to doc/boards/rockchip create a warning message and remove the redundant list of supported boards.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
doc/README.rockchip | 72 +++------------------------------------------ 1 file changed, 4 insertions(+), 68 deletions(-)
How about we simply remove this file and move all its content to doc/boards/rockchip?
I'd say it can be all done in one go.
I've been thinking about it after the comments received in the previous patch. From my point of view, the best approach would be to split doc/README.rockchip into a main document doc/board/rockchip/rockchip.rst and some more specific ones, such as doc/board/rockchip/rk3399.rst.
Any thought?
Regards,
Walter
diff --git a/doc/README.rockchip b/doc/README.rockchip index 70c8798ed2..154166ec78 100644 --- a/doc/README.rockchip +++ b/doc/README.rockchip @@ -8,6 +8,10 @@ U-Boot on Rockchip
A wide range of Rockchip SoCs are supported in mainline U-Boot
+Warning +======= +This document is being moved to doc/board/rockchip, so information on it +might be incomplete or outdated.
Prerequisites
@@ -24,77 +28,9 @@ You will need: - Suitable ARM cross compiler, e.g.: sudo apt-get install gcc-4.7-arm-linux-gnueabi
Building
-At present 11 RK3288 boards are supported:
- EVB RK3288 - use evb-rk3288 configuration
- Firefly RK3288 - use firefly-rk3288 configuration
- Hisense Chromebook - use chromebook_jerry configuration
- Asus C100P Chromebook - use chromebook_minnie configuration
- Asus Chromebit - use chromebook_mickey configuration
- MiQi RK3288 - use miqi-rk3288 configuration
- phyCORE-RK3288 RDK - use phycore-rk3288 configuration
- PopMetal RK3288 - use popmetal-rk3288 configuration
- Radxa Rock 2 - use rock2 configuration
- Tinker RK3288 - use tinker-rk3288 configuration
- Vyasa RK3288 - use vyasa-rk3288 configuration
-Two RK3036 boards are supported:
- EVB RK3036 - use evb-rk3036 configuration
- Kylin - use kylin_rk3036 configuration
-Two RK3308 boards are supported:
- EVB RK3308 - use evb-rk3308 configuration
- ROC-CC-RK3308 - use roc-cc-rk3308 configuration
-Three RK3328 boards are supported:
- EVB RK3328 - use evb-rk3328_defconfig
- Pine64 Rock64 board - use rock64-rk3328_defconfig
- Firefly / Libre Computer Project ROC-RK3328-CC board -
use roc-cc-rk3328_defconfig
-Size RK3399 boards are supported (aarch64):
- EBV RK3399 - use evb_rk3399 configuration
- Firefly RK3399 - use the firefly_rk3399 configuration
- Puma - use puma_rk3399 configuration
- Ficus - use ficus-rk3399 configuration
- Rock960 (Vamrs) - use rock960-rk3399 configuration
- Bob - use chromebook_bob configuration
-Four RK3368 boards are supported:
- Sheep - use sheep-rk3368 configuration
- Lion - use lion-rk3368 configuration
- Geekbox - use geekbox configuration
- EVB PX5 - use evb-px5 configuration
-One RK3128 board is supported:
- EVB RK3128 - use evb-rk3128 configuration
-One RK3229 board is supported:
- EVB RK3229 - use evb-rk3229 configuration
-Two RV1108 boards are supported:
- EVB RV1108 - use evb-rv1108 configuration
- Elgin R1 - use elgin-rv1108 configuration
-One RV3188 baord is supported:
- Raxda Rock - use rock configuration
-For example:
To build RK3288 board:
CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
-- 2.20.1

Hi Walter,
On Fri, 22 May 2020 at 16:39, Walter Lozano walter.lozano@collabora.com wrote:
Hi Ezequiel,
On 22/5/20 18:37, Ezequiel Garcia wrote:
On Fri, 22 May 2020 at 11:16, Walter Lozano walter.lozano@collabora.com wrote:
As documentation is being moved to doc/boards/rockchip create a warning message and remove the redundant list of supported boards.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
doc/README.rockchip | 72 +++------------------------------------------ 1 file changed, 4 insertions(+), 68 deletions(-)
How about we simply remove this file and move all its content to doc/boards/rockchip?
I'd say it can be all done in one go.
I've been thinking about it after the comments received in the previous patch. From my point of view, the best approach would be to split doc/README.rockchip into a main document doc/board/rockchip/rockchip.rst and some more specific ones, such as doc/board/rockchip/rk3399.rst.
Sounds reasonable to me.
Any thought?
Regards,
Walter
Regards, Simon

On 2020/5/22 下午10:14, Walter Lozano wrote:
As documentation is being moved to doc/boards/rockchip create a warning message and remove the redundant list of supported boards.
Signed-off-by: Walter Lozano walter.lozano@collabora.com
Reviewed-by: Kever Yang kever.yang@rock-chips.com
Thanks, - Kever
doc/README.rockchip | 72 +++------------------------------------------ 1 file changed, 4 insertions(+), 68 deletions(-)
diff --git a/doc/README.rockchip b/doc/README.rockchip index 70c8798ed2..154166ec78 100644 --- a/doc/README.rockchip +++ b/doc/README.rockchip @@ -8,6 +8,10 @@ U-Boot on Rockchip
A wide range of Rockchip SoCs are supported in mainline U-Boot
+Warning +======= +This document is being moved to doc/board/rockchip, so information on it +might be incomplete or outdated.
Prerequisites
@@ -24,77 +28,9 @@ You will need: - Suitable ARM cross compiler, e.g.: sudo apt-get install gcc-4.7-arm-linux-gnueabi
Building
-At present 11 RK3288 boards are supported:
- EVB RK3288 - use evb-rk3288 configuration
- Firefly RK3288 - use firefly-rk3288 configuration
- Hisense Chromebook - use chromebook_jerry configuration
- Asus C100P Chromebook - use chromebook_minnie configuration
- Asus Chromebit - use chromebook_mickey configuration
- MiQi RK3288 - use miqi-rk3288 configuration
- phyCORE-RK3288 RDK - use phycore-rk3288 configuration
- PopMetal RK3288 - use popmetal-rk3288 configuration
- Radxa Rock 2 - use rock2 configuration
- Tinker RK3288 - use tinker-rk3288 configuration
- Vyasa RK3288 - use vyasa-rk3288 configuration
-Two RK3036 boards are supported:
- EVB RK3036 - use evb-rk3036 configuration
- Kylin - use kylin_rk3036 configuration
-Two RK3308 boards are supported:
- EVB RK3308 - use evb-rk3308 configuration
- ROC-CC-RK3308 - use roc-cc-rk3308 configuration
-Three RK3328 boards are supported:
- EVB RK3328 - use evb-rk3328_defconfig
- Pine64 Rock64 board - use rock64-rk3328_defconfig
- Firefly / Libre Computer Project ROC-RK3328-CC board -
use roc-cc-rk3328_defconfig
-Size RK3399 boards are supported (aarch64):
- EBV RK3399 - use evb_rk3399 configuration
- Firefly RK3399 - use the firefly_rk3399 configuration
- Puma - use puma_rk3399 configuration
- Ficus - use ficus-rk3399 configuration
- Rock960 (Vamrs) - use rock960-rk3399 configuration
- Bob - use chromebook_bob configuration
-Four RK3368 boards are supported:
- Sheep - use sheep-rk3368 configuration
- Lion - use lion-rk3368 configuration
- Geekbox - use geekbox configuration
- EVB PX5 - use evb-px5 configuration
-One RK3128 board is supported:
- EVB RK3128 - use evb-rk3128 configuration
-One RK3229 board is supported:
- EVB RK3229 - use evb-rk3229 configuration
-Two RV1108 boards are supported:
- EVB RV1108 - use evb-rv1108 configuration
- Elgin R1 - use elgin-rv1108 configuration
-One RV3188 baord is supported:
- Raxda Rock - use rock configuration
-For example:
To build RK3288 board:
CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all

On 2020/5/22 下午10:14, Walter Lozano wrote:
As an additional step in the process of improve the Rockchip documentation and based on the comments from [1] move the list of supported boards and configs to doc/board/rockchip.
[1] https://patchwork.ozlabs.org/project/uboot/list/?series=177974
Walter Lozano (3): doc: board: rockchip: Improve supported board list format doc: board: rockchip: Add missing supported boards doc: rockchip: Remove list of supported boards
doc/README.rockchip | 72 ++-------------------------- doc/board/rockchip/rockchip.rst | 84 ++++++++++++++++++++------------- 2 files changed, 54 insertions(+), 102 deletions(-)
Applied to u-boot-rockchip master.
Thanks, - Kever
participants (4)
-
Ezequiel Garcia
-
Kever Yang
-
Simon Glass
-
Walter Lozano