From b4325ee4f42367082b3a927ae5b2fc3193e4ee15 Mon Sep 17 00:00:00 2001
From: Arul Kumaran <arulkumaran.devarajan@huawei.com>
Date: Thu, 25 Feb 2021 18:20:59 +0530
Subject: [PATCH] Supported Board: Main Readme Update
* Supported boards Main readme updated for new contents.
* build-open-harmony modified to include cross-reference syntax
* Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>
---
.../source/quick-start/build-open-harmony.rst | 6 ++++++
.../source/supported-boards/Readme.rst | 18 +++++++++++++++---
2 files changed, 21 insertions(+), 3 deletions(-)
diff --git a/documentation/source/quick-start/build-open-harmony.rst b/documentation/source/quick-start/build-open-harmony.rst
index ead5a5d..c685187 100644
--- a/documentation/source/quick-start/build-open-harmony.rst
+++ b/documentation/source/quick-start/build-open-harmony.rst
@@ -112,6 +112,8 @@ You can use the following syntax to build the OHOS flavour of your choice.
$ MACHINE=<target_machine> bitbake <image-name>
+.. _linux_flavour:
+
OHOS Linux flavour
====================
@@ -192,6 +194,8 @@ or close qemu using key combination:
**Ctrl-A** followed by 'x'
+.. _zephyr_flavour:
+
OHOS Zephyr flavour
====================
@@ -247,6 +251,8 @@ To exit qemu, use key combination:
**Ctrl-A** followed by 'x'
+.. _freertos_flavour:
+
OHOS FreeRTOS flavour
======================
diff --git a/documentation/source/supported-boards/Readme.rst b/documentation/source/supported-boards/Readme.rst
index 36075cd..7db42a7 100644
--- a/documentation/source/supported-boards/Readme.rst
+++ b/documentation/source/supported-boards/Readme.rst
@@ -5,7 +5,7 @@
Supported Boards
################
-|main_project_name| supports the following boards:
+|main_project_name| project developers are continually adding board-specific support. Currently, you can build an |main_project_name| image using your preferred OS flavour using the supported boards. Currently, |main_project_name| supports the following boards:
.. toctree::
:maxdepth: 1
@@ -14,5 +14,17 @@ Supported Boards
96b-nitrogen
seco-intel-b68
seco-imx8mm-c61
-
-
+
+|main_project_name| is a distributed OS that is designed to run on top of a variety of OS kernels ranging from Linux to RTOSs. |main_project_name| uses notion of kernel specific flavours with predefined IMAGES and MACHINES:
+
+* :ref:`linux_flavour`
+* :ref:`zephyr_flavour`
+* :ref:`freertos_flavour`
+
+For more detailed information of kernel specific flavours, see `Getting Started <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/quick-start/build-open-harmony.rst>`_.
+
+.. note::
+
+ A single board can be included in more than one flavour only when it has **well-maintained support** in targeted kernels.
+
+
--
GitLab