diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-04-15 17:58:45 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-23 16:39:03 +0100 |
commit | 773536c333248214f8f41eff698d8bfd3c687249 (patch) | |
tree | 526a86685e2d035455505f8ba45450bc70060e4b /documentation/bsp-guide | |
parent | 21b42cc54f37fcbfdfa3ea69694b4f2003433d02 (diff) | |
download | poky-773536c333248214f8f41eff698d8bfd3c687249.tar.gz |
manuals: simplify code insertion
This replaces instances of ": ::" by "::", which
generates identical HTML output
(From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/bsp-guide')
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 89f1564422..0b0b52d904 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -26,7 +26,7 @@ A BSP consists of a file structure inside a base directory. | |||
26 | Collectively, you can think of the base directory, its file structure, | 26 | Collectively, you can think of the base directory, its file structure, |
27 | and the contents as a BSP layer. Although not a strict requirement, BSP | 27 | and the contents as a BSP layer. Although not a strict requirement, BSP |
28 | layers in the Yocto Project use the following well-established naming | 28 | layers in the Yocto Project use the following well-established naming |
29 | convention: :: | 29 | convention:: |
30 | 30 | ||
31 | meta-bsp_root_name | 31 | meta-bsp_root_name |
32 | 32 | ||
@@ -58,7 +58,7 @@ Each repository is a BSP layer supported by the Yocto Project (e.g. | |||
58 | ``meta-raspberrypi`` and ``meta-intel``). Each of these layers is a | 58 | ``meta-raspberrypi`` and ``meta-intel``). Each of these layers is a |
59 | repository unto itself and clicking on the layer name displays two URLs | 59 | repository unto itself and clicking on the layer name displays two URLs |
60 | from which you can clone the layer's repository to your local system. | 60 | from which you can clone the layer's repository to your local system. |
61 | Here is an example that clones the Raspberry Pi BSP layer: :: | 61 | Here is an example that clones the Raspberry Pi BSP layer:: |
62 | 62 | ||
63 | $ git clone git://git.yoctoproject.org/meta-raspberrypi | 63 | $ git clone git://git.yoctoproject.org/meta-raspberrypi |
64 | 64 | ||
@@ -84,7 +84,7 @@ established after you run the OpenEmbedded build environment setup | |||
84 | script (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). | 84 | script (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). |
85 | Adding the root directory allows the :term:`OpenEmbedded Build System` | 85 | Adding the root directory allows the :term:`OpenEmbedded Build System` |
86 | to recognize the BSP | 86 | to recognize the BSP |
87 | layer and from it build an image. Here is an example: :: | 87 | layer and from it build an image. Here is an example:: |
88 | 88 | ||
89 | BBLAYERS ?= " \ | 89 | BBLAYERS ?= " \ |
90 | /usr/local/src/yocto/meta \ | 90 | /usr/local/src/yocto/meta \ |
@@ -113,7 +113,7 @@ this type of layer is OpenEmbedded's | |||
113 | `meta-openembedded <https://github.com/openembedded/meta-openembedded>`__ | 113 | `meta-openembedded <https://github.com/openembedded/meta-openembedded>`__ |
114 | layer. The ``meta-openembedded`` layer contains many ``meta-*`` layers. | 114 | layer. The ``meta-openembedded`` layer contains many ``meta-*`` layers. |
115 | In cases like this, you need to include the names of the actual layers | 115 | In cases like this, you need to include the names of the actual layers |
116 | you want to work with, such as: :: | 116 | you want to work with, such as:: |
117 | 117 | ||
118 | BBLAYERS ?= " \ | 118 | BBLAYERS ?= " \ |
119 | /usr/local/src/yocto/meta \ | 119 | /usr/local/src/yocto/meta \ |
@@ -193,7 +193,7 @@ section. | |||
193 | 193 | ||
194 | #. *Check Out the Proper Branch:* The branch you check out for | 194 | #. *Check Out the Proper Branch:* The branch you check out for |
195 | ``meta-intel`` must match the same branch you are using for the | 195 | ``meta-intel`` must match the same branch you are using for the |
196 | Yocto Project release (e.g. ``&DISTRO_NAME_NO_CAP;``): :: | 196 | Yocto Project release (e.g. ``&DISTRO_NAME_NO_CAP;``):: |
197 | 197 | ||
198 | $ cd meta-intel | 198 | $ cd meta-intel |
199 | $ git checkout -b &DISTRO_NAME_NO_CAP; remotes/origin/&DISTRO_NAME_NO_CAP; | 199 | $ git checkout -b &DISTRO_NAME_NO_CAP; remotes/origin/&DISTRO_NAME_NO_CAP; |
@@ -216,7 +216,7 @@ section. | |||
216 | The process is identical to the process used for the ``meta-intel`` | 216 | The process is identical to the process used for the ``meta-intel`` |
217 | layer except for the layer's name. For example, if you determine that | 217 | layer except for the layer's name. For example, if you determine that |
218 | your hardware most closely matches the ``meta-raspberrypi``, clone | 218 | your hardware most closely matches the ``meta-raspberrypi``, clone |
219 | that layer: :: | 219 | that layer:: |
220 | 220 | ||
221 | $ git clone git://git.yoctoproject.org/meta-raspberrypi | 221 | $ git clone git://git.yoctoproject.org/meta-raspberrypi |
222 | Cloning into 'meta-raspberrypi'... | 222 | Cloning into 'meta-raspberrypi'... |
@@ -451,7 +451,7 @@ The following sections describe each part of the proposed BSP format. | |||
451 | License Files | 451 | License Files |
452 | ------------- | 452 | ------------- |
453 | 453 | ||
454 | You can find these files in the BSP Layer at: :: | 454 | You can find these files in the BSP Layer at:: |
455 | 455 | ||
456 | meta-bsp_root_name/bsp_license_file | 456 | meta-bsp_root_name/bsp_license_file |
457 | 457 | ||
@@ -469,7 +469,7 @@ section in the Yocto Project Development Tasks Manual. | |||
469 | README File | 469 | README File |
470 | ----------- | 470 | ----------- |
471 | 471 | ||
472 | You can find this file in the BSP Layer at: :: | 472 | You can find this file in the BSP Layer at:: |
473 | 473 | ||
474 | meta-bsp_root_name/README | 474 | meta-bsp_root_name/README |
475 | 475 | ||
@@ -484,7 +484,7 @@ name of the BSP maintainer with his or her contact information. | |||
484 | README.sources File | 484 | README.sources File |
485 | ------------------- | 485 | ------------------- |
486 | 486 | ||
487 | You can find this file in the BSP Layer at: :: | 487 | You can find this file in the BSP Layer at:: |
488 | 488 | ||
489 | meta-bsp_root_name/README.sources | 489 | meta-bsp_root_name/README.sources |
490 | 490 | ||
@@ -503,7 +503,7 @@ used to generate the images that ship with the BSP. | |||
503 | Pre-built User Binaries | 503 | Pre-built User Binaries |
504 | ----------------------- | 504 | ----------------------- |
505 | 505 | ||
506 | You can find these files in the BSP Layer at: :: | 506 | You can find these files in the BSP Layer at:: |
507 | 507 | ||
508 | meta-bsp_root_name/binary/bootable_images | 508 | meta-bsp_root_name/binary/bootable_images |
509 | 509 | ||
@@ -526,7 +526,7 @@ information on the Metadata. | |||
526 | Layer Configuration File | 526 | Layer Configuration File |
527 | ------------------------ | 527 | ------------------------ |
528 | 528 | ||
529 | You can find this file in the BSP Layer at: :: | 529 | You can find this file in the BSP Layer at:: |
530 | 530 | ||
531 | meta-bsp_root_name/conf/layer.conf | 531 | meta-bsp_root_name/conf/layer.conf |
532 | 532 | ||
@@ -550,7 +550,7 @@ template). :: | |||
550 | LAYERDEPENDS_bsp = "intel" | 550 | LAYERDEPENDS_bsp = "intel" |
551 | 551 | ||
552 | To illustrate the string substitutions, here are the corresponding | 552 | To illustrate the string substitutions, here are the corresponding |
553 | statements from the Raspberry Pi ``conf/layer.conf`` file: :: | 553 | statements from the Raspberry Pi ``conf/layer.conf`` file:: |
554 | 554 | ||
555 | # We have a conf and classes directory, append to BBPATH | 555 | # We have a conf and classes directory, append to BBPATH |
556 | BBPATH .= ":${LAYERDIR}" | 556 | BBPATH .= ":${LAYERDIR}" |
@@ -576,7 +576,7 @@ recognize the BSP. | |||
576 | Hardware Configuration Options | 576 | Hardware Configuration Options |
577 | ------------------------------ | 577 | ------------------------------ |
578 | 578 | ||
579 | You can find these files in the BSP Layer at: :: | 579 | You can find these files in the BSP Layer at:: |
580 | 580 | ||
581 | meta-bsp_root_name/conf/machine/*.conf | 581 | meta-bsp_root_name/conf/machine/*.conf |
582 | 582 | ||
@@ -607,14 +607,14 @@ For example, many ``tune-*`` files (e.g. ``tune-arm1136jf-s.inc``, | |||
607 | 607 | ||
608 | To use an include file, you simply include them in the machine | 608 | To use an include file, you simply include them in the machine |
609 | configuration file. For example, the Raspberry Pi BSP | 609 | configuration file. For example, the Raspberry Pi BSP |
610 | ``raspberrypi3.conf`` contains the following statement: :: | 610 | ``raspberrypi3.conf`` contains the following statement:: |
611 | 611 | ||
612 | include conf/machine/include/rpi-base.inc | 612 | include conf/machine/include/rpi-base.inc |
613 | 613 | ||
614 | Miscellaneous BSP-Specific Recipe Files | 614 | Miscellaneous BSP-Specific Recipe Files |
615 | --------------------------------------- | 615 | --------------------------------------- |
616 | 616 | ||
617 | You can find these files in the BSP Layer at: :: | 617 | You can find these files in the BSP Layer at:: |
618 | 618 | ||
619 | meta-bsp_root_name/recipes-bsp/* | 619 | meta-bsp_root_name/recipes-bsp/* |
620 | 620 | ||
@@ -624,7 +624,7 @@ Raspberry Pi BSP, there is the ``formfactor_0.0.bbappend`` file, which | |||
624 | is an append file used to augment the recipe that starts the build. | 624 | is an append file used to augment the recipe that starts the build. |
625 | Furthermore, there are machine-specific settings used during the build | 625 | Furthermore, there are machine-specific settings used during the build |
626 | that are defined by the ``machconfig`` file further down in the | 626 | that are defined by the ``machconfig`` file further down in the |
627 | directory. Here is the ``machconfig`` file for the Raspberry Pi BSP: :: | 627 | directory. Here is the ``machconfig`` file for the Raspberry Pi BSP:: |
628 | 628 | ||
629 | HAVE_TOUCHSCREEN=0 | 629 | HAVE_TOUCHSCREEN=0 |
630 | HAVE_KEYBOARD=1 | 630 | HAVE_KEYBOARD=1 |
@@ -644,7 +644,7 @@ directory. Here is the ``machconfig`` file for the Raspberry Pi BSP: :: | |||
644 | Display Support Files | 644 | Display Support Files |
645 | --------------------- | 645 | --------------------- |
646 | 646 | ||
647 | You can find these files in the BSP Layer at: :: | 647 | You can find these files in the BSP Layer at:: |
648 | 648 | ||
649 | meta-bsp_root_name/recipes-graphics/* | 649 | meta-bsp_root_name/recipes-graphics/* |
650 | 650 | ||
@@ -655,7 +655,7 @@ to support a display are kept here. | |||
655 | Linux Kernel Configuration | 655 | Linux Kernel Configuration |
656 | -------------------------- | 656 | -------------------------- |
657 | 657 | ||
658 | You can find these files in the BSP Layer at: :: | 658 | You can find these files in the BSP Layer at:: |
659 | 659 | ||
660 | meta-bsp_root_name/recipes-kernel/linux/linux*.bbappend | 660 | meta-bsp_root_name/recipes-kernel/linux/linux*.bbappend |
661 | meta-bsp_root_name/recipes-kernel/linux/*.bb | 661 | meta-bsp_root_name/recipes-kernel/linux/*.bb |
@@ -678,7 +678,7 @@ Suppose you are using the ``linux-yocto_4.4.bb`` recipe to build the | |||
678 | kernel. In other words, you have selected the kernel in your | 678 | kernel. In other words, you have selected the kernel in your |
679 | ``"bsp_root_name".conf`` file by adding | 679 | ``"bsp_root_name".conf`` file by adding |
680 | :term:`PREFERRED_PROVIDER` and :term:`PREFERRED_VERSION` | 680 | :term:`PREFERRED_PROVIDER` and :term:`PREFERRED_VERSION` |
681 | statements as follows: :: | 681 | statements as follows:: |
682 | 682 | ||
683 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" | 683 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" |
684 | PREFERRED_VERSION_linux-yocto ?= "4.4%" | 684 | PREFERRED_VERSION_linux-yocto ?= "4.4%" |
@@ -698,7 +698,7 @@ in the Yocto Project Linux Kernel Development Manual. | |||
698 | 698 | ||
699 | An alternate scenario is when you create your own kernel recipe for the | 699 | An alternate scenario is when you create your own kernel recipe for the |
700 | BSP. A good example of this is the Raspberry Pi BSP. If you examine the | 700 | BSP. A good example of this is the Raspberry Pi BSP. If you examine the |
701 | ``recipes-kernel/linux`` directory you see the following: :: | 701 | ``recipes-kernel/linux`` directory you see the following:: |
702 | 702 | ||
703 | linux-raspberrypi-dev.bb | 703 | linux-raspberrypi-dev.bb |
704 | linux-raspberrypi.inc | 704 | linux-raspberrypi.inc |
@@ -1042,7 +1042,7 @@ BSP-specific configuration file named ``interfaces`` to the | |||
1042 | also supports several other machines: | 1042 | also supports several other machines: |
1043 | 1043 | ||
1044 | #. Edit the ``init-ifupdown_1.0.bbappend`` file so that it contains the | 1044 | #. Edit the ``init-ifupdown_1.0.bbappend`` file so that it contains the |
1045 | following: :: | 1045 | following:: |
1046 | 1046 | ||
1047 | FILESEXTRAPATHS_prepend := "${THISDIR}/files:" | 1047 | FILESEXTRAPATHS_prepend := "${THISDIR}/files:" |
1048 | 1048 | ||
@@ -1050,14 +1050,14 @@ also supports several other machines: | |||
1050 | directory. | 1050 | directory. |
1051 | 1051 | ||
1052 | #. Create and place the new ``interfaces`` configuration file in the | 1052 | #. Create and place the new ``interfaces`` configuration file in the |
1053 | BSP's layer here: :: | 1053 | BSP's layer here:: |
1054 | 1054 | ||
1055 | meta-xyz/recipes-core/init-ifupdown/files/xyz-machine-one/interfaces | 1055 | meta-xyz/recipes-core/init-ifupdown/files/xyz-machine-one/interfaces |
1056 | 1056 | ||
1057 | .. note:: | 1057 | .. note:: |
1058 | 1058 | ||
1059 | If the ``meta-xyz`` layer did not support multiple machines, you would place | 1059 | If the ``meta-xyz`` layer did not support multiple machines, you would place |
1060 | the interfaces configuration file in the layer here: :: | 1060 | the interfaces configuration file in the layer here:: |
1061 | 1061 | ||
1062 | meta-xyz/recipes-core/init-ifupdown/files/interfaces | 1062 | meta-xyz/recipes-core/init-ifupdown/files/interfaces |
1063 | 1063 | ||
@@ -1210,7 +1210,7 @@ BSP Layer Configuration Example | |||
1210 | ------------------------------- | 1210 | ------------------------------- |
1211 | 1211 | ||
1212 | The layer's ``conf`` directory contains the ``layer.conf`` configuration | 1212 | The layer's ``conf`` directory contains the ``layer.conf`` configuration |
1213 | file. In this example, the ``conf/layer.conf`` is the following: :: | 1213 | file. In this example, the ``conf/layer.conf`` is the following:: |
1214 | 1214 | ||
1215 | # We have a conf and classes directory, add to BBPATH | 1215 | # We have a conf and classes directory, add to BBPATH |
1216 | BBPATH .= ":${LAYERDIR}" | 1216 | BBPATH .= ":${LAYERDIR}" |
@@ -1242,7 +1242,7 @@ configuration file is what makes a layer a BSP layer as compared to a | |||
1242 | general or kernel layer. | 1242 | general or kernel layer. |
1243 | 1243 | ||
1244 | One or more machine configuration files exist in the | 1244 | One or more machine configuration files exist in the |
1245 | ``bsp_layer/conf/machine/`` directory of the layer: :: | 1245 | ``bsp_layer/conf/machine/`` directory of the layer:: |
1246 | 1246 | ||
1247 | bsp_layer/conf/machine/machine1\.conf | 1247 | bsp_layer/conf/machine/machine1\.conf |
1248 | bsp_layer/conf/machine/machine2\.conf | 1248 | bsp_layer/conf/machine/machine2\.conf |
@@ -1252,7 +1252,7 @@ One or more machine configuration files exist in the | |||
1252 | For example, the machine configuration file for the `BeagleBone and | 1252 | For example, the machine configuration file for the `BeagleBone and |
1253 | BeagleBone Black development boards <https://beagleboard.org/bone>`__ is | 1253 | BeagleBone Black development boards <https://beagleboard.org/bone>`__ is |
1254 | located in the layer ``poky/meta-yocto-bsp/conf/machine`` and is named | 1254 | located in the layer ``poky/meta-yocto-bsp/conf/machine`` and is named |
1255 | ``beaglebone-yocto.conf``: :: | 1255 | ``beaglebone-yocto.conf``:: |
1256 | 1256 | ||
1257 | #@TYPE: Machine | 1257 | #@TYPE: Machine |
1258 | #@NAME: Beaglebone-yocto machine | 1258 | #@NAME: Beaglebone-yocto machine |
@@ -1447,7 +1447,7 @@ BSP Kernel Recipe Example | |||
1447 | ------------------------- | 1447 | ------------------------- |
1448 | 1448 | ||
1449 | The kernel recipe used to build the kernel image for the BeagleBone | 1449 | The kernel recipe used to build the kernel image for the BeagleBone |
1450 | device was established in the machine configuration: :: | 1450 | device was established in the machine configuration:: |
1451 | 1451 | ||
1452 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" | 1452 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" |
1453 | PREFERRED_VERSION_linux-yocto ?= "5.0%" | 1453 | PREFERRED_VERSION_linux-yocto ?= "5.0%" |
@@ -1458,7 +1458,7 @@ metadata used to build the kernel. In this case, a kernel append file | |||
1458 | kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in | 1458 | kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in |
1459 | :yocto_git:`/poky/tree/meta/recipes-kernel/linux`. | 1459 | :yocto_git:`/poky/tree/meta/recipes-kernel/linux`. |
1460 | 1460 | ||
1461 | Following is the contents of the append file: :: | 1461 | Following is the contents of the append file:: |
1462 | 1462 | ||
1463 | KBRANCH_genericx86 = "v5.0/standard/base" | 1463 | KBRANCH_genericx86 = "v5.0/standard/base" |
1464 | KBRANCH_genericx86-64 = "v5.0/standard/base" | 1464 | KBRANCH_genericx86-64 = "v5.0/standard/base" |