summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-05-12 11:32:35 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-05-22 12:16:41 +0100
commit5871eeea6e10844b8e7141cf24efa26d1412c5c7 (patch)
tree6270fbf680a1c559226e4b88225e919be8906d1f /documentation
parent31f1d4d331993d830e2bb8c8e718bb409a2624f0 (diff)
downloadpoky-5871eeea6e10844b8e7141cf24efa26d1412c5c7.tar.gz
manuals: simplify style
(From yocto-docs rev: 3332ee547cde0f2f8718f83d526b21339b0a8901) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/README2
-rw-r--r--documentation/brief-yoctoprojectqs/index.rst10
-rw-r--r--documentation/bsp-guide/bsp.rst36
-rw-r--r--documentation/toaster-manual/reference.rst6
4 files changed, 26 insertions, 28 deletions
diff --git a/documentation/README b/documentation/README
index fddf4e706d..3ad23a902d 100644
--- a/documentation/README
+++ b/documentation/README
@@ -32,7 +32,7 @@ these instances.
32Manual Organization 32Manual Organization
33=================== 33===================
34 34
35Folders exist for individual manuals as follows: 35Here the folders corresponding to individual manuals:
36 36
37* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide. 37* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide.
38* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide 38* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 6a12b19ca0..7ae4526c42 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -297,7 +297,7 @@ modular development and makes it easier to reuse the layer metadata.
297 297
298Follow these steps to add a hardware layer: 298Follow these steps to add a hardware layer:
299 299
300#. **Find a Layer:** Lots of hardware layers exist. The Yocto Project 300#. **Find a Layer:** Many hardware layers are available. The Yocto Project
301 :yocto_git:`Source Repositories <>` has many hardware layers. 301 :yocto_git:`Source Repositories <>` has many hardware layers.
302 This example adds the 302 This example adds the
303 `meta-altera <https://github.com/kraj/meta-altera>`__ hardware layer. 303 `meta-altera <https://github.com/kraj/meta-altera>`__ hardware layer.
@@ -318,8 +318,8 @@ Follow these steps to add a hardware layer:
318 Resolving deltas: 100% (13385/13385), done. 318 Resolving deltas: 100% (13385/13385), done.
319 Checking connectivity... done. 319 Checking connectivity... done.
320 320
321 The hardware layer now exists 321 The hardware layer is now available
322 with other layers inside the Poky reference repository on your build 322 next to other layers inside the Poky reference repository on your build
323 host as ``meta-altera`` and contains all the metadata needed to 323 host as ``meta-altera`` and contains all the metadata needed to
324 support hardware from Altera, which is owned by Intel. 324 support hardware from Altera, which is owned by Intel.
325 325
@@ -431,8 +431,8 @@ information including the website, wiki pages, and user manuals:
431 information. 431 information.
432 432
433- **Yocto Project Mailing Lists:** Related mailing lists provide a forum 433- **Yocto Project Mailing Lists:** Related mailing lists provide a forum
434 for discussion, patch submission and announcements. Several mailing 434 for discussion, patch submission and announcements. There are several
435 lists exist and are grouped according to areas of concern. See the 435 mailing lists grouped by topic. See the
436 :ref:`ref-manual/resources:mailing lists` 436 :ref:`ref-manual/resources:mailing lists`
437 section in the Yocto Project Reference Manual for a complete list of 437 section in the Yocto Project Reference Manual for a complete list of
438 Yocto Project mailing lists. 438 Yocto Project mailing lists.
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 0b0b52d904..b46773dedd 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -267,7 +267,7 @@ maintain the distinction that the BSP layer, a build system, and tools
267are separate components that could be combined in certain end products. 267are separate components that could be combined in certain end products.
268 268
269Before looking at the recommended form for the directory structure 269Before looking at the recommended form for the directory structure
270inside a BSP layer, you should be aware that some requirements do exist 270inside a BSP layer, you should be aware that there are some requirements
271in order for a BSP layer to be considered compliant with the Yocto 271in order for a BSP layer to be considered compliant with the Yocto
272Project. For that list of requirements, see the 272Project. For that list of requirements, see the
273":ref:`bsp-guide/bsp:released bsp requirements`" section. 273":ref:`bsp-guide/bsp:released bsp requirements`" section.
@@ -763,8 +763,8 @@ workflow.
763 763
764 .. note:: 764 .. note::
765 765
766 - Four hardware reference BSPs exist that are part of the Yocto 766 - There are four hardware reference BSPs in the Yocto
767 Project release and are located in the ``poky/meta-yocto-bsp`` 767 Project release, located in the ``poky/meta-yocto-bsp``
768 BSP layer: 768 BSP layer:
769 769
770 - Texas Instruments Beaglebone (``beaglebone-yocto``) 770 - Texas Instruments Beaglebone (``beaglebone-yocto``)
@@ -773,8 +773,8 @@ workflow.
773 773
774 - Two general IA platforms (``genericx86`` and ``genericx86-64``) 774 - Two general IA platforms (``genericx86`` and ``genericx86-64``)
775 775
776 - Three core Intel BSPs exist as part of the Yocto Project 776 - There are three core Intel BSPs in the Yocto Project
777 release in the ``meta-intel`` layer: 777 release, in the ``meta-intel`` layer:
778 778
779 - ``intel-core2-32``, which is a BSP optimized for the Core2 779 - ``intel-core2-32``, which is a BSP optimized for the Core2
780 family of CPUs as well as all CPUs prior to the Silvermont 780 family of CPUs as well as all CPUs prior to the Silvermont
@@ -832,10 +832,8 @@ workflow.
832Requirements and Recommendations for Released BSPs 832Requirements and Recommendations for Released BSPs
833================================================== 833==================================================
834 834
835Certain requirements exist for a released BSP to be considered compliant 835This section describes requirements and recommendations for a released
836with the Yocto Project. Additionally, recommendations also exist. This 836BSP to be considered compliant with the Yocto Project.
837section describes the requirements and recommendations for released
838BSPs.
839 837
840Released BSP Requirements 838Released BSP Requirements
841------------------------- 839-------------------------
@@ -864,7 +862,7 @@ Before looking at BSP requirements, you should consider the following:
864 862
865- It is not required that specific packages or package modifications 863- It is not required that specific packages or package modifications
866 exist in the BSP layer, beyond the requirements for general 864 exist in the BSP layer, beyond the requirements for general
867 compliance with the Yocto Project. For example, no requirement exists 865 compliance with the Yocto Project. For example, there is no requirement
868 dictating that a specific kernel or kernel version be used in a given 866 dictating that a specific kernel or kernel version be used in a given
869 BSP. 867 BSP.
870 868
@@ -900,7 +898,7 @@ Yocto Project:
900- *License File:* You must include a license file in the 898- *License File:* You must include a license file in the
901 ``meta-bsp_root_name`` directory. This license covers the BSP 899 ``meta-bsp_root_name`` directory. This license covers the BSP
902 Metadata as a whole. You must specify which license to use since no 900 Metadata as a whole. You must specify which license to use since no
903 default license exists when one is not specified. See the 901 default license exists. See the
904 :yocto_git:`COPYING.MIT </meta-raspberrypi/tree/COPYING.MIT>` 902 :yocto_git:`COPYING.MIT </meta-raspberrypi/tree/COPYING.MIT>`
905 file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer 903 file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer
906 as an example. 904 as an example.
@@ -1107,7 +1105,7 @@ system requirements.
1107 unsuitable functionality or quality, you can use an encumbered 1105 unsuitable functionality or quality, you can use an encumbered
1108 version. 1106 version.
1109 1107
1110A couple different methods exist within the OpenEmbedded build system to 1108There are two different methods within the OpenEmbedded build system to
1111satisfy the licensing requirements for an encumbered BSP. The following 1109satisfy the licensing requirements for an encumbered BSP. The following
1112list describes them in order of preference: 1110list describes them in order of preference:
1113 1111
@@ -1186,11 +1184,11 @@ Use these steps to create a BSP layer:
1186- *Create a Machine Configuration File:* Create a 1184- *Create a Machine Configuration File:* Create a
1187 ``conf/machine/bsp_root_name.conf`` file. See 1185 ``conf/machine/bsp_root_name.conf`` file. See
1188 :yocto_git:`meta-yocto-bsp/conf/machine </poky/tree/meta-yocto-bsp/conf/machine>` 1186 :yocto_git:`meta-yocto-bsp/conf/machine </poky/tree/meta-yocto-bsp/conf/machine>`
1189 for sample ``bsp_root_name.conf`` files. Other samples such as 1187 for sample ``bsp_root_name.conf`` files. There are other samples such as
1190 :yocto_git:`meta-ti </meta-ti/tree/conf/machine>` 1188 :yocto_git:`meta-ti </meta-ti/tree/conf/machine>`
1191 and 1189 and
1192 :yocto_git:`meta-freescale </meta-freescale/tree/conf/machine>` 1190 :yocto_git:`meta-freescale </meta-freescale/tree/conf/machine>`
1193 exist from other vendors that have more specific machine and tuning 1191 from other vendors that have more specific machine and tuning
1194 examples. 1192 examples.
1195 1193
1196- *Create a Kernel Recipe:* Create a kernel recipe in 1194- *Create a Kernel Recipe:* Create a kernel recipe in
@@ -1241,7 +1239,7 @@ As mentioned earlier in this section, the existence of a machine
1241configuration file is what makes a layer a BSP layer as compared to a 1239configuration file is what makes a layer a BSP layer as compared to a
1242general or kernel layer. 1240general or kernel layer.
1243 1241
1244One or more machine configuration files exist in the 1242There are one or more machine configuration files in the
1245``bsp_layer/conf/machine/`` directory of the layer:: 1243``bsp_layer/conf/machine/`` directory of the layer::
1246 1244
1247 bsp_layer/conf/machine/machine1\.conf 1245 bsp_layer/conf/machine/machine1\.conf
@@ -1311,7 +1309,7 @@ Project Reference Manual.
1311- :term:`PREFERRED_PROVIDER_virtual/xserver <PREFERRED_PROVIDER>`: 1309- :term:`PREFERRED_PROVIDER_virtual/xserver <PREFERRED_PROVIDER>`:
1312 The recipe that provides "virtual/xserver" when more than one 1310 The recipe that provides "virtual/xserver" when more than one
1313 provider is found. In this case, the recipe that provides 1311 provider is found. In this case, the recipe that provides
1314 "virtual/xserver" is "xserver-xorg", which exists in 1312 "virtual/xserver" is "xserver-xorg", available in
1315 ``poky/meta/recipes-graphics/xorg-xserver``. 1313 ``poky/meta/recipes-graphics/xorg-xserver``.
1316 1314
1317- :term:`XSERVER`: The packages that 1315- :term:`XSERVER`: The packages that
@@ -1326,7 +1324,7 @@ Project Reference Manual.
1326 1324
1327 .. tip:: 1325 .. tip::
1328 1326
1329 Many ``MACHINE*`` variables exist that help you configure a particular piece 1327 There are many ``MACHINE*`` variables that help you configure a particular piece
1330 of hardware. 1328 of hardware.
1331 1329
1332- :term:`EXTRA_IMAGEDEPENDS`: 1330- :term:`EXTRA_IMAGEDEPENDS`:
@@ -1339,9 +1337,9 @@ Project Reference Manual.
1339- :term:`DEFAULTTUNE`: Machines 1337- :term:`DEFAULTTUNE`: Machines
1340 use tunings to optimize machine, CPU, and application performance. 1338 use tunings to optimize machine, CPU, and application performance.
1341 These features, which are collectively known as "tuning features", 1339 These features, which are collectively known as "tuning features",
1342 exist in the :term:`OpenEmbedded-Core (OE-Core)` layer (e.g. 1340 are set in the :term:`OpenEmbedded-Core (OE-Core)` layer (e.g.
1343 ``poky/meta/conf/machine/include``). In this example, the default 1341 ``poky/meta/conf/machine/include``). In this example, the default
1344 tuning file is "cortexa8hf-neon". 1342 tuning file is ``cortexa8hf-neon``.
1345 1343
1346 .. note:: 1344 .. note::
1347 1345
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index 988a262188..c0d02ff9ab 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -9,8 +9,8 @@ concepts and have some basic command reference material available. This
9final chapter provides conceptual information on layer sources, 9final chapter provides conceptual information on layer sources,
10releases, and JSON configuration files. Also provided is a quick look at 10releases, and JSON configuration files. Also provided is a quick look at
11some useful ``manage.py`` commands that are Toaster-specific. 11some useful ``manage.py`` commands that are Toaster-specific.
12Information on ``manage.py`` commands does exist across the Web and the 12Information on ``manage.py`` commands is available across the Web and
13information in this manual by no means attempts to provide a command 13this manual by no means attempts to provide a command
14comprehensive reference. 14comprehensive reference.
15 15
16Layer Source 16Layer Source
@@ -508,7 +508,7 @@ Useful Commands
508=============== 508===============
509 509
510In addition to the web user interface and the scripts that start and 510In addition to the web user interface and the scripts that start and
511stop Toaster, command-line commands exist through the ``manage.py`` 511stop Toaster, command-line commands are available through the ``manage.py``
512management script. You can find general documentation on ``manage.py`` 512management script. You can find general documentation on ``manage.py``
513at the 513at the
514`Django <https://docs.djangoproject.com/en/2.2/topics/settings/>`__ 514`Django <https://docs.djangoproject.com/en/2.2/topics/settings/>`__