[meta-freescale] [Documentation][PATCH] RN: Reallocate description of kernel provider
Daiane Angolini
daiane.list at gmail.com
Thu Nov 20 09:11:35 PST 2014
From: Daiane Angolini <daiane.angolini at freescale.com>
Reallocate the description of where to get help regarding each kernel provider
feature list and official support channel.
In addition, break some long lines to fit 80 columns.
Signed-off-by: Daiane Angolini <daiane.angolini at freescale.com>
---
release-notes/source/bsp-scope.rst | 59 +++++++++++++++++++-----------------
release-notes/source/source-code.rst | 36 ++++++++++++++++------
2 files changed, 58 insertions(+), 37 deletions(-)
diff --git a/release-notes/source/bsp-scope.rst b/release-notes/source/bsp-scope.rst
index 152e6cf..13d9c7c 100644
--- a/release-notes/source/bsp-scope.rst
+++ b/release-notes/source/bsp-scope.rst
@@ -9,22 +9,25 @@ The scope of the |project_name| includes the meta layers:
* `meta-fsl-arm-extra <https://github.com/Freescale/meta-fsl-arm-extra/tree/dizzy>`_:
provides support for 3rd party and partner boards;
* `meta-fsl-demos <https://github.com/Freescale/meta-fsl-demos/tree/dizzy>`_:
- provides images recipes, demo recipes, and packagegroups used to easy the development with Yocto Project.
- * `Documentation <https://github.com/Freescale/Documentation/tree/dizzy>`_
- provides the source code for |project_name| Release Notes (RN), User Guide (UG) and
- Frequently Asked Questions (FAQ)
+ provides images recipes, demo recipes, and packagegroups used to easy the
+ development with Yocto Project.
+ * `Documentation <https://github.com/Freescale/Documentation/tree/dizzy>`_:
+ provides the source code for |project_name| Release Notes (RN), User Guide
+ (UG) and Frequently Asked Questions (FAQ)
+
+.. _kernel_release_notes:
Kernel Release Notes
====================
The |project_name| includes support for several kernel providers. Each machine
may have a different Linux Kernel provider.
-For the **linux-imx** provider, Freescale has a release notes document for each
-version released. This document has a list of known issues, new features, list
-of kernel arguments, and the linux-imx kernel scope for each Freescale Reference
-Board. This document is present into the Document Bundle provided by Freescale.
+The |project_name| is not responsible for the content of those kernels.
+Although we *as community* should feel empowered to submit bug fixes and new
+features for those projects.
-See the respective Linux Kernel provider for your machine in section :ref:`linux-providers`
+See the respective Linux Kernel provider for your machine in section
+:ref:`linux-providers`.
Different Product SoC Families
==============================
@@ -32,8 +35,9 @@ Currently, the |project_name| includes the following Product SoC Families:
* **i.MX Application Processors (imx)**: Regarding the `i.MX Freescale Page
<http://www.freescale.com/webapp/sps/site/homepage.jsp?code=IMX_HOME>`_:
- *i.MX applications processors are multicore ARM®-based solutions for multimedia and display
- applications with scalability, high performance, and low power capabilities.*
+ *i.MX applications processors are multicore ARM®-based solutions for
+ multimedia and display applications with scalability, high performance, and
+ low power capabilities.*
* **Vybrid Controller Solutions based on ARM® Cores (vybrid)**: Regarding the
`Vybrid Freescale Page <http://www.freescale.com/webapp/sps/site/homepage.jsp?code=VYBRID>`_:
@@ -47,17 +51,17 @@ Currently, the |project_name| includes the following Product SoC Families:
networks of tomorrow.*
Freescale groups a set of SoCs which target different markets in product
-families. Those are grouped according to their SoC features and internal hardware
-capabilities.
+families. Those are grouped according to their SoC features and internal
+hardware capabilities.
The Yocto Project's tools have the required capabilities to differentiate the
-architectures and BSP components for the different SoC families. In this perspective,
-the |project_name| can support a wide range of architectures and product lines
-which go across several markets.
+architectures and BSP components for the different SoC families. In this
+perspective, the |project_name| can support a wide range of architectures and
+product lines which go across several markets.
-For the |project_name|, the different SoCs, from all product lines manufactured by
-Freescale, can be seen as different machines, thus easing the use of same architecture
-across different markets.
+For the |project_name|, the different SoCs, from all product lines manufactured
+by Freescale, can be seen as different machines, thus easing the use of same
+architecture across different markets.
.. _supported-boards:
@@ -73,9 +77,9 @@ Please, see the next table for the complete supported board list.
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.
+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.
@@ -84,15 +88,16 @@ 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.
+ * 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.
+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
^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/release-notes/source/source-code.rst b/release-notes/source/source-code.rst
index 5d1e91e..8500c5b 100644
--- a/release-notes/source/source-code.rst
+++ b/release-notes/source/source-code.rst
@@ -24,6 +24,17 @@ Linux Kernel
.. tabularcolumns:: l | l | l
.. include:: fsl-community-bsp-supported-kernels.inc
+As stated in :ref:`kernel_release_notes`, |project_name| is not responsible for
+the Linux Kernel content in any kernel provider. If you are looking for the
+feature list, supported devices, official way to get a support channel or how to
+report bug, please, see above where to get help, for each kernel provider.
+
+ * **linux-imx**: provider, Freescale has a release notes document for each
+ version released. This document has a list of known issues, new features,
+ list of kernel arguments, and the linux-imx kernel scope for each Freescale
+ Reference Board. This document is present into the Document Bundle provided
+ by Freescale.
+
Default Linux Providers
-----------------------
@@ -84,13 +95,14 @@ hardware optimization or some hardware test tools.
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.
+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`.
+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
@@ -101,7 +113,8 @@ The following table shows the version of each package depending on the :ref:`soc
Hardware relation by :ref:`soc-hierarchy`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The following table shows how packages interact with hardware depending on the :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
@@ -114,9 +127,9 @@ 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.
+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
-------------
@@ -124,14 +137,17 @@ 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>`_
+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>`_
+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
--
1.9.1
More information about the meta-freescale
mailing list