From 7cdea09c963548ee7b78055b1758db9383091779 Mon Sep 17 00:00:00 2001
From: Arul Kumaran <arulkumaran.devarajan@huawei.com>
Date: Thu, 6 May 2021 17:34:36 +0530
Subject: [PATCH] docs/hardware-support: Introduce new topic 'Supported Images'
* Hardware supported boards modified to reference Supported Images.
* docs/index.rst modified to include Supported Images topic in toctree.
Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>
---
docs/build-flavours/freertos-flavour.rst | 2 +
docs/build-flavours/linux-flavour.rst | 2 +
docs/build-flavours/zephyr-flavour.rst | 2 +
docs/hardware-support/boards/96b-Avenger.rst | 18 -----
docs/hardware-support/boards/96b-nitrogen.rst | 5 --
docs/hardware-support/boards/raspberrypi4.rst | 14 ----
.../boards/seco-imx8mm-c61.rst | 15 ----
.../boards/seco-intel-b68.rst | 18 -----
.../virtual-boards/qemuarm.rst | 14 ----
.../virtual-boards/qemuarm64.rst | 14 ----
.../virtual-boards/qemux86-64.rst | 14 ----
.../virtual-boards/qemux86.rst | 14 ----
docs/index.rst | 1 +
docs/supported-images.rst | 73 +++++++++++++++++++
14 files changed, 80 insertions(+), 126 deletions(-)
create mode 100644 docs/supported-images.rst
diff --git a/docs/build-flavours/freertos-flavour.rst b/docs/build-flavours/freertos-flavour.rst
index 18a28b99..34eda856 100644
--- a/docs/build-flavours/freertos-flavour.rst
+++ b/docs/build-flavours/freertos-flavour.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. _FreeRTOS_Kernel:
+
FreeRTOS Kernel Build Flavour
#############################
diff --git a/docs/build-flavours/linux-flavour.rst b/docs/build-flavours/linux-flavour.rst
index 2ffaf6b7..4eaa8101 100644
--- a/docs/build-flavours/linux-flavour.rst
+++ b/docs/build-flavours/linux-flavour.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. _Linux_Kernel:
+
Linux Kernel Build Flavour
##########################
diff --git a/docs/build-flavours/zephyr-flavour.rst b/docs/build-flavours/zephyr-flavour.rst
index 5dca58ff..6d2025f2 100644
--- a/docs/build-flavours/zephyr-flavour.rst
+++ b/docs/build-flavours/zephyr-flavour.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. _Zephyr_Kernel:
+
Zephyr Kernel Build Flavour
###########################
diff --git a/docs/hardware-support/boards/96b-Avenger.rst b/docs/hardware-support/boards/96b-Avenger.rst
index 7b16a94b..7fda9754 100644
--- a/docs/hardware-support/boards/96b-Avenger.rst
+++ b/docs/hardware-support/boards/96b-Avenger.rst
@@ -31,24 +31,6 @@ For more details on Avenger96 board, see `Avenger96 product page <https://www.96
Working with the board
**********************
-Supported images
-================
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Size
- - Description
- * - allscenarios-image-base
- - Approximate 100-200 MB
- - All Scenarios OS image including the base OS software stack
- * - allscenarios-image-extra
- - Approximate 100-200 MB
- - All Scenarios OS Wayland image including the base OS software stack
-
-
Building OHOS image
===================
diff --git a/docs/hardware-support/boards/96b-nitrogen.rst b/docs/hardware-support/boards/96b-nitrogen.rst
index 9a4985e6..72d66799 100644
--- a/docs/hardware-support/boards/96b-nitrogen.rst
+++ b/docs/hardware-support/boards/96b-nitrogen.rst
@@ -35,11 +35,6 @@ For more details on 96Boards Nitrogen, see `Nitrogen product page <https://www.9
Working with the board
**********************
-Supported image
-===============
-
-* zephyr-philosophers
-
Building an application
=======================
diff --git a/docs/hardware-support/boards/raspberrypi4.rst b/docs/hardware-support/boards/raspberrypi4.rst
index 487b8714..8701fdbd 100644
--- a/docs/hardware-support/boards/raspberrypi4.rst
+++ b/docs/hardware-support/boards/raspberrypi4.rst
@@ -50,20 +50,6 @@ For more details on the Raspberry Pi 4 board, see `Raspberry Pi hardware page
Working with the board
**********************
-Supported images
-================
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Description
- * - allscenarios-image-base
- - All Scenarios OS image including the base OS software stack
- * - allscenarios-image-extra
- - All Scenarios OS Wayland image including the base OS software stack
-
Building All Scenarios OS image
===============================
diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst
index 23463e23..f5fd2e4a 100644
--- a/docs/hardware-support/boards/seco-imx8mm-c61.rst
+++ b/docs/hardware-support/boards/seco-imx8mm-c61.rst
@@ -29,21 +29,6 @@ For more detailed specifications of SBC-C61 SECO board, see `SBC-C61 Specificati
Working with the board
**********************
-Supported image
-===============
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Size
- - Description
- * - allscenarios-image-base
- - Approximate 100-200 MB
- - All Scenarios OS image including the base OS software stack
-
-
Building OHOS image
===================
diff --git a/docs/hardware-support/boards/seco-intel-b68.rst b/docs/hardware-support/boards/seco-intel-b68.rst
index 08dd1dcc..a9e87333 100644
--- a/docs/hardware-support/boards/seco-intel-b68.rst
+++ b/docs/hardware-support/boards/seco-intel-b68.rst
@@ -28,24 +28,6 @@ For more detailed specifications of SBC-B68-eNUC SECO board, see `SBC-B68-eNUC S
Working with the board
**********************
-Supported images
-================
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Size
- - Description
- * - allscenarios-image-base
- - Approximate 100-200 MB
- - All Scenarios OS image including the base OS software stack
- * - allscenarios-image-extra
- - Approximate 100-200 MB
- - All Scenarios OS Wayland image including the base OS software stack
-
-
Building OHOS image
===================
diff --git a/docs/hardware-support/virtual-boards/qemuarm.rst b/docs/hardware-support/virtual-boards/qemuarm.rst
index fcd3a88f..b0e8da86 100644
--- a/docs/hardware-support/virtual-boards/qemuarm.rst
+++ b/docs/hardware-support/virtual-boards/qemuarm.rst
@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
-Supported images
-----------------
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Description
- * - allscenarios-image-base
- - All Scenarios OS image including the base OS software stack
- * - allscenarios-image-extra
- - All Scenarios OS Wayland image including the base OS software stack
-
Build steps
-----------
diff --git a/docs/hardware-support/virtual-boards/qemuarm64.rst b/docs/hardware-support/virtual-boards/qemuarm64.rst
index ba848fe6..471f3dce 100644
--- a/docs/hardware-support/virtual-boards/qemuarm64.rst
+++ b/docs/hardware-support/virtual-boards/qemuarm64.rst
@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
-Supported images
-----------------
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Description
- * - allscenarios-image-base
- - All Scenarios OS image including the base OS software stack
- * - allscenarios-image-extra
- - All Scenarios OS Wayland image including the base OS software stack
-
Build steps
-----------
diff --git a/docs/hardware-support/virtual-boards/qemux86-64.rst b/docs/hardware-support/virtual-boards/qemux86-64.rst
index 8beac404..fdcc68ea 100644
--- a/docs/hardware-support/virtual-boards/qemux86-64.rst
+++ b/docs/hardware-support/virtual-boards/qemux86-64.rst
@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
-Supported images
-----------------
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Description
- * - allscenarios-image-base
- - All Scenarios OS image including the base OS software stack
- * - allscenarios-image-extra
- - All Scenarios OS Wayland image including the base OS software stack
-
Build steps
-----------
diff --git a/docs/hardware-support/virtual-boards/qemux86.rst b/docs/hardware-support/virtual-boards/qemux86.rst
index b38a7657..2d1a9b3c 100644
--- a/docs/hardware-support/virtual-boards/qemux86.rst
+++ b/docs/hardware-support/virtual-boards/qemux86.rst
@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
-Supported images
-----------------
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Description
- * - allscenarios-image-base
- - All Scenarios OS image including the base OS software stack
- * - allscenarios-image-extra
- - All Scenarios OS Wayland image including the base OS software stack
-
Build steps
-----------
diff --git a/docs/index.rst b/docs/index.rst
index f5c6cbe8..c0b83a04 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,4 +15,5 @@ Build system documentation
ohos-build/index
ci/index
blueprints/index
+ supported-images
hardware-support/index
diff --git a/docs/supported-images.rst b/docs/supported-images.rst
new file mode 100644
index 00000000..56871458
--- /dev/null
+++ b/docs/supported-images.rst
@@ -0,0 +1,73 @@
+.. SPDX-FileCopyrightText: Huawei Inc.
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+Supported Images
+################
+
+To create a custom Linux distribution to match the product requirements,
+All Scenarios OS includes a set of predefined images for developing a product image.
+
+Linux Kernel
+************
+
+The Linux kernel is a free and open-source Unix-like operating system (OS)
+kernel that serves as the primary interface between the computer's hardware and its processes.
+
+All Scenarios OS supports the following images listed in the table:
+
+.. list-table:: Linux supported images
+ :header-rows: 1
+
+ * - Image Name
+ - Description
+ * - allscenarios-image-base
+ -
+ * All Scenarios OS image including the base OS software stack.
+ * This image also includes middleware and application packages to support a wide range of hardware which includes WiFi, Bluetooth, sound, and serial ports.
+ * - allscenarios-image-extra
+ -
+ * All Scenarios OS Wayland image including the base OS software stack. This is a Wayland protocol and Weston reference compositor-based image.
+ * It uses the Wayland protocol and implementation to exchange data with its clients.
+ * This image provides the Wayland protocol libraries and the reference Weston compositor and includes a Wayland-capable terminal program.
+
+To build a Linux-based image for a supported machine, see :ref:`Linux Kernel Build Flavour <Linux_Kernel>`.
+
+Zephyr Kernel
+*************
+
+The Zephyr OS is a well-known security-oriented real-time operating system (RTOS)
+that is intended for use on resource-constrained and embedded systems.
+
+For more detailed information on Zephyr OS Kernel, see `Zephyr documentation <https://docs.zephyrproject.org/latest/index.html#>`_.
+
+All Scenarios OS supports the following images for the Zephyr OS kernel:
+
+.. list-table:: Zephyr supported images
+ :header-rows: 1
+
+ * - Image Name
+ - Description
+ * - zephyr-philosophers
+ - A sample Zephyr application implementing the Dining Philosophers problem.
+
+To build a Zephyr-based image for a supported machine, see :ref:`Zephyr Kernel Build Flavour <Zephyr_Kernel>`.
+
+FreeRTOS Kernel
+***************
+
+The FreeRTOS kernel is a real-time operating system (RTOS) that runs on a variety
+of platforms which is used to build microcontroller-based embedded applications.
+
+The standard RTOS kernel binary image ranges from 4000 to 9000 bytes.
+All Scenarios OS supports the following images for FreeRTOS Kernel:
+
+.. list-table:: FreeRTOS supported images
+ :header-rows: 1
+
+ * - Image Name
+ - Description
+ * - freertos-demo
+ - Machine configuration for running an ARMv5 system on QEMU.
+
+To build a FreeRTOS-based image for a supported machine, see :ref:`FreeRTOS Kernel Build Flavour <FreeRTOS_Kernel>`.
--
GitLab