[meta-freescale] [Documentation][PATCH] RN: Rearrange files and restructure the sections
Daiane Angolini
daiane.angolini at freescale.com
Wed Nov 19 06:24:45 PST 2014
This change does not remove any text. It only moves around targeting a
better overall order. The changes are:
The file
* machines-maintainers.rst
--> is included in bsp-scope.rst
The files
* soc-hierarchy.rst
* kernel-linux.rst
* bootloaders.rst
* userspace-pkg.rst
* fsl-userspace-pkg.rst
* pkggrp-img.rst
--> are included in new source-code.rst
In addition, it changes some section levels. It means, what was section
may become chapter, what was section, may become sub-section,
sub-section may become sub-subsection.
The new (numbered only here) TOC looks like:
1. Introduction
1.1. What is the FSL Community BSP
1.1.1. Motivation
1.1.2. What the FSL Community BSP is not
1.1.3. What you can expect
1.1.4. What the community expects from you
1.2. Upstream
1.2.1. Main branch names
1.2.2. Upstreaming cycle
1.3. The differences between FSL Community BSP and Freescale
Official Release
1.3.1. Freescale Official Release
1.3.2. FSL Community BSP
2. FSL Community BSP Scope
2.1. Kernel Release Notes
2.2. Different Product SoC Families
2.3. Supported Board List
2.3.1. Machine Maintainers
2.3.1.1. Machines with maintainers
2.3.1.2. Machines without a maintainer
3. Software Architeture
3.1. SoC Hierarchy
3.2. Linux Kernel
3.2.1. Default Linux Providers
3.3. Bootloaders
3.4. User Space Packages
3.4.1. Freescale User Space Packages
3.4.1.1. Version by soc-hierarchy
3.4.1.2. Hardware relation by soc-hierarchy
3.5. PackageGroups and Images
3.5.1. PACKAGEGROUPS
3.5.2. Images
4. Test results
5. Acknowledgements
5.1. Dizzy Source Code
6. Known Issues
6.1. Open
6.2. Closed
Signed-off-by: Daiane Angolini <daiane.angolini at freescale.com>
---
release-notes/source/bootloaders.rst | 18 ----
release-notes/source/bsp-scope.rst | 51 ++++++++--
release-notes/source/fsl-userspace-pkg.rst | 47 ---------
release-notes/source/index.rst | 8 +-
release-notes/source/kernel-linux.rst | 23 -----
release-notes/source/machines-maintainers.rst | 41 --------
release-notes/source/pkggrp-img.rst | 34 -------
release-notes/source/soc-hierarchy.rst | 10 --
release-notes/source/source-code.rst | 137 ++++++++++++++++++++++++++
release-notes/source/userspace-pkg.rst | 10 --
10 files changed, 182 insertions(+), 197 deletions(-)
delete mode 100644 release-notes/source/bootloaders.rst
delete mode 100644 release-notes/source/fsl-userspace-pkg.rst
delete mode 100644 release-notes/source/kernel-linux.rst
delete mode 100644 release-notes/source/machines-maintainers.rst
delete mode 100644 release-notes/source/pkggrp-img.rst
delete mode 100644 release-notes/source/soc-hierarchy.rst
create mode 100644 release-notes/source/source-code.rst
delete mode 100644 release-notes/source/userspace-pkg.rst
diff --git a/release-notes/source/bootloaders.rst b/release-notes/source/bootloaders.rst
deleted file mode 100644
index 2ba13c0..0000000
--- a/release-notes/source/bootloaders.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-.. include:: variables.inc
-
-Bootloaders
-============
-
-|project_name| supports barebox and u-boot as bootloaders.
-
-.. tabularcolumns:: l | l | l
-.. include:: fsl-community-bsp-supported-bootloaders-descr.inc
-
-
-The following table shows the default bootloaders (and their
-versions) for the supported boards.
-
-.. tabularcolumns:: l | l | l
-.. table:: Default bootloader version for each supported machine
-
- .. include:: bootloader-default.inc
diff --git a/release-notes/source/bsp-scope.rst b/release-notes/source/bsp-scope.rst
index 235142d..152e6cf 100644
--- a/release-notes/source/bsp-scope.rst
+++ b/release-notes/source/bsp-scope.rst
@@ -1,10 +1,7 @@
.. include:: variables.inc
-Scope
-=========
-
|project_name| Scope
------------------------
+***********************
The scope of the |project_name| includes the meta layers:
* `meta-fsl-arm <http://git.yoctoproject.org/cgit/cgit.cgi/meta-fsl-arm/?h=dizzy>`_:
@@ -18,7 +15,7 @@ The scope of the |project_name| includes the meta layers:
Frequently Asked Questions (FAQ)
Kernel Release Notes
---------------------
+====================
The |project_name| includes support for several kernel providers. Each machine
may have a different Linux Kernel provider.
@@ -30,7 +27,7 @@ Board. This document is present into the Document Bundle provided by Freescale.
See the respective Linux Kernel provider for your machine in section :ref:`linux-providers`
Different Product SoC Families
-------------------------------
+==============================
Currently, the |project_name| includes the following Product SoC Families:
* **i.MX Application Processors (imx)**: Regarding the `i.MX Freescale Page
@@ -65,10 +62,50 @@ across different markets.
.. _supported-boards:
Supported Board List
---------------------
+====================
Please, see the next table for the complete supported board list.
.. tabularcolumns:: c | p{5cm} | c | c
.. table:: Supported machines in |project_name|
.. include:: machine-list.inc
+
+Machine Maintainers
+-------------------
+
+Since |project_name| Release 1.6 (Daisy), the maintainer field in machine configuration
+files of **meta-fsl-arm** and **meta-fsl-arm-extra** is mandatory for any new board
+to be added.
+
+So now on, every new board must have someone assigned as maintainer.
+This ensures, in long term, all boards with a maintainer assigned.
+Current orphan boards are not going to be removed unless it causes maintenance
+problem and the fix is not straightforward.
+
+The maintainer duties:
+ * The one with casting vote when a deadlock is faced.
+ * Responsible to keep that machine working (that means, booting and with some stability)
+ * Keep kernel, u-boot updated/tested/working.
+ * Keep release notes updated
+ * Keep test cycle updated
+ * Keep the most usual images building and booting
+
+When a build error is detected, the maintainer will "fix" it. For those maintainers with kernel control (meta-fsl-arm-extra),
+it is expected that they properly fix the kernel issue (when it's a kernel issue). However, anything out of community control
+should be worked around anyway.
+
+Machines with maintainers
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. tabularcolumns:: l | p{9cm}
+.. table:: Machines with maintainers
+
+ .. include:: machines-with-maintainers.inc
+
+Machines without a maintainer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. tabularcolumns:: l | p{9cm}
+.. table:: Machines without a maintainer
+
+ .. include:: machines-without-maintainers.inc
diff --git a/release-notes/source/fsl-userspace-pkg.rst b/release-notes/source/fsl-userspace-pkg.rst
deleted file mode 100644
index 9ac504c..0000000
--- a/release-notes/source/fsl-userspace-pkg.rst
+++ /dev/null
@@ -1,47 +0,0 @@
-Freescale User Space Packages
-=============================
-This section shows the version package for each board.
-Those packages provide hardware acceleration for GPU or VPU,
-hardware optimization or some hardware test tools.
-
- * **Hardware acceleration** is achieved using a different core
- for processing some specific task. In this case, GPU or VPU.
-
- * **Hardware optimization** is achieved with some changes in source
- code in order to get a better performance for a specific task
- on a specific hardware. For example, audio decode made by software,
- but with optimizations for ARM.
-
- * **Hardware-specific** is applicable when the package was designed to
- be executed on a specific hardware, and it does not make sense
- on other hardware. For example, imx-test is a test package for
- imx boards. It can be cross-compiled for any other core, although
- it will only behave as expect if executed on imx boards.
-
-The package version and variety varies on :ref:`soc-hierarchy`.
-For example, machines with i.MX28 SoC does not have VPU, the recipe imx-vpu is not needed.
-There are differences, as well, in GPU support recipes.
-
---------------------------------
-Version by :ref:`soc-hierarchy`
---------------------------------
-
-The following table shows the version of each package depending on the :ref:`soc-hierarchy`.
-
-.. tabularcolumns:: L | C | C | C | C | C | C
-.. table:: User space package version by SoC hierarchy
-
- .. include:: soc-pkg.inc
-
-
------------------------------------------
-Hardware relation by :ref:`soc-hierarchy`
------------------------------------------
-
-The following table shows how packages interact with hardware depending on the :ref:`soc-hierarchy`
-
-.. tabularcolumns:: L | C | C | C | C
-.. table:: Hardware dependant packages
-
- .. include:: soc-pkg-optimization.inc
-
diff --git a/release-notes/source/index.rst b/release-notes/source/index.rst
index 455cefd..aac3ee0 100644
--- a/release-notes/source/index.rst
+++ b/release-notes/source/index.rst
@@ -10,13 +10,7 @@
introduction
bsp-scope
- machines-maintainers
- soc-hierarchy
- kernel-linux
- bootloaders
- userspace-pkg
- fsl-userspace-pkg
- pkggrp-img
+ source-code
test-results
Acknowledgement
known-issues
diff --git a/release-notes/source/kernel-linux.rst b/release-notes/source/kernel-linux.rst
deleted file mode 100644
index 13d847c..0000000
--- a/release-notes/source/kernel-linux.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-.. include:: variables.inc
-.. _linux-providers:
-
-Linux Kernel
-============
-
-|project_name| supports the following sources for Linux Kernel:
-
-.. tabularcolumns:: l | l | l
-.. include:: fsl-community-bsp-supported-kernels.inc
-
-
------------------------
-Default Linux Providers
------------------------
-
-The following table shows the default version of Linux Kernel provided by
-|project_name| for each supported machine.
-
-.. tabularcolumns:: l | l | l
-.. table:: Default Linux kernel version for each supported machine
-
- .. include:: linux-default.inc
diff --git a/release-notes/source/machines-maintainers.rst b/release-notes/source/machines-maintainers.rst
deleted file mode 100644
index 5ac5e7f..0000000
--- a/release-notes/source/machines-maintainers.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-.. include:: variables.inc
-
-Machine Maintainers
-==================
-
-Since |project_name| Release 1.6 (Daisy), the maintainer field in machine configuration
-files of **meta-fsl-arm** and **meta-fsl-arm-extra** is mandatory for any new board
-to be added.
-
-So now on, every new board must have someone assigned as maintainer.
-This ensures, in long term, all boards with a maintainer assigned.
-Current orphan boards are not going to be removed unless it causes maintenance
-problem and the fix is not straightforward.
-
-The maintainer duties:
- * The one with casting vote when a deadlock is faced.
- * Responsible to keep that machine working (that means, booting and with some stability)
- * Keep kernel, u-boot updated/tested/working.
- * Keep release notes updated
- * Keep test cycle updated
- * Keep the most usual images building and booting
-
-When a build error is detected, the maintainer will "fix" it. For those maintainers with kernel control (meta-fsl-arm-extra),
-it is expected that they properly fix the kernel issue (when it's a kernel issue). However, anything out of community control
-should be worked around anyway.
-
-Machines with maintainers
--------------------------
-
-.. tabularcolumns:: l | p{9cm}
-.. table:: Machines with maintainers
-
- .. include:: machines-with-maintainers.inc
-
-Machines without a maintainer
------------------------------
-
-.. tabularcolumns:: l | p{9cm}
-.. table:: Machines without a maintainer
-
- .. include:: machines-without-maintainers.inc
diff --git a/release-notes/source/pkggrp-img.rst b/release-notes/source/pkggrp-img.rst
deleted file mode 100644
index 808c96d..0000000
--- a/release-notes/source/pkggrp-img.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. include:: variables.inc
-
-PackageGroups and Images
-========================
-
-The |project_name| provides a list of PACKAGEGROUPS and images intended to ease
-the initial development of custom applications.
-
-The main goal is not to provide a production solution, on the contrary, it should
-be seen as an example of package set for a specific IP development, and an example
-of initial generic development and test images.
-
--------------
-PACKAGEGROUPS
--------------
-
-The following list shows the current PACKAGEGROUPs available in |release_name|
-when using |project_name|.
-
-You can understand what a PACKAGEGROUPS is and learn how to use it in `Yocto Project Development Manual <http://www.yoctoproject.org/docs/1.6.1/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks>`_
-
-.. include:: packagegroups.inc
-
-------
-Images
-------
-
-The following images are provided by |project_name| only. See the
-list of Yocto Project's reference images in `Yocto Project Reference Manual <http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#ref-images>`_
-
-.. include:: images.inc
-
-
-
diff --git a/release-notes/source/soc-hierarchy.rst b/release-notes/source/soc-hierarchy.rst
deleted file mode 100644
index cfadd9a..0000000
--- a/release-notes/source/soc-hierarchy.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. _soc-hierarchy:
-
-SoC Hierarchy
-============================
-
-The following tree shows the SoC hierarchy:
-
-.. blockdiag:: soc-tree.diag
- :scale: 60%
- :align: center
diff --git a/release-notes/source/source-code.rst b/release-notes/source/source-code.rst
new file mode 100644
index 0000000..1bde22a
--- /dev/null
+++ b/release-notes/source/source-code.rst
@@ -0,0 +1,137 @@
+.. include:: variables.inc
+Software Architeture
+********************
+
+.. _soc-hierarchy:
+
+SoC Hierarchy
+============================
+
+The following tree shows the SoC hierarchy:
+
+.. blockdiag:: soc-tree.diag
+ :scale: 60%
+ :align: center
+
+
+.. _linux-providers:
+
+Linux Kernel
+============
+
+|project_name| supports the following sources for Linux Kernel:
+
+.. tabularcolumns:: l | l | l
+.. include:: fsl-community-bsp-supported-kernels.inc
+
+Default Linux Providers
+-----------------------
+
+The following table shows the default version of Linux Kernel provided by
+|project_name| for each supported machine.
+
+.. tabularcolumns:: l | l | l
+.. table:: Default Linux kernel version for each supported machine
+
+ .. include:: linux-default.inc
+
+Bootloaders
+============
+
+|project_name| supports barebox and u-boot as bootloaders.
+
+.. tabularcolumns:: l | l | l
+.. include:: fsl-community-bsp-supported-bootloaders-descr.inc
+
+
+The following table shows the default bootloaders (and their
+versions) for the supported boards.
+
+.. tabularcolumns:: l | l | l
+.. table:: Default bootloader version for each supported machine
+
+ .. include:: bootloader-default.inc
+
+User Space Packages
+===================
+
+There is a huge number of user space packages provided by the Yocto Project.
+The following table shows some version for few highlighted packages.
+
+.. tabularcolumns:: l | c | l
+.. table:: Main user space package versions
+
+ .. include:: userspace-pkg.inc
+
+Freescale User Space Packages
+-----------------------------
+This section shows the version package for each board.
+Those packages provide hardware acceleration for GPU or VPU,
+hardware optimization or some hardware test tools.
+
+ * **Hardware acceleration** is achieved using a different core
+ for processing some specific task. In this case, GPU or VPU.
+
+ * **Hardware optimization** is achieved with some changes in source
+ code in order to get a better performance for a specific task
+ on a specific hardware. For example, audio decode made by software,
+ but with optimizations for ARM.
+
+ * **Hardware-specific** is applicable when the package was designed to
+ be executed on a specific hardware, and it does not make sense
+ on other hardware. For example, imx-test is a test package for
+ imx boards. It can be cross-compiled for any other core, although
+ it will only behave as expect if executed on imx boards.
+
+The package version and variety varies on :ref:`soc-hierarchy`.
+For example, machines with i.MX28 SoC does not have VPU, the recipe imx-vpu is not needed.
+There are differences, as well, in GPU support recipes.
+
+Version by :ref:`soc-hierarchy`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following table shows the version of each package depending on the :ref:`soc-hierarchy`.
+
+.. tabularcolumns:: L | C | C | C | C | C | C
+.. table:: User space package version by SoC hierarchy
+
+ .. include:: soc-pkg.inc
+
+
+Hardware relation by :ref:`soc-hierarchy`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following table shows how packages interact with hardware depending on the :ref:`soc-hierarchy`
+
+.. tabularcolumns:: L | C | C | C | C
+.. table:: Hardware dependant packages
+
+ .. include:: soc-pkg-optimization.inc
+
+PackageGroups and Images
+========================
+
+The |project_name| provides a list of PACKAGEGROUPS and images intended to ease
+the initial development of custom applications.
+
+The main goal is not to provide a production solution, on the contrary, it should
+be seen as an example of package set for a specific IP development, and an example
+of initial generic development and test images.
+
+PACKAGEGROUPS
+-------------
+
+The following list shows the current PACKAGEGROUPs available in |release_name|
+when using |project_name|.
+
+You can understand what a PACKAGEGROUPS is and learn how to use it in `Yocto Project Development Manual <http://www.yoctoproject.org/docs/1.6.1/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks>`_
+
+.. include:: packagegroups.inc
+
+Images
+------
+
+The following images are provided by |project_name| only. See the
+list of Yocto Project's reference images in `Yocto Project Reference Manual <http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#ref-images>`_
+
+.. include:: images.inc
diff --git a/release-notes/source/userspace-pkg.rst b/release-notes/source/userspace-pkg.rst
deleted file mode 100644
index fe46737..0000000
--- a/release-notes/source/userspace-pkg.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-User Space Packages
-===================
-
-There is a huge number of user space packages provided by the Yocto Project.
-The following table shows some version for few highlighted packages.
-
-.. tabularcolumns:: l | c | l
-.. table:: Main user space package versions
-
- .. include:: userspace-pkg.inc
--
1.9.1
More information about the meta-freescale
mailing list