diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-01-05 08:34:26 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-01-06 17:39:09 +0000 |
commit | 8b1909aa6f7a51a878dc3d4a9223403ad3e164a9 (patch) | |
tree | e1418f545ad6640afb5fde004696eef2a9e6e67b /documentation/dev-manual/building.rst | |
parent | ae280972ffba62d7ed839b692957f61b0955cbca (diff) | |
download | poky-8b1909aa6f7a51a878dc3d4a9223403ad3e164a9.tar.gz |
manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.
Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.
(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/building.rst')
-rw-r--r-- | documentation/dev-manual/building.rst | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index 3064974cc5..1f1642e846 100644 --- a/documentation/dev-manual/building.rst +++ b/documentation/dev-manual/building.rst | |||
@@ -295,8 +295,8 @@ Follow these steps to create an :term:`Initramfs` image: | |||
295 | recipe, you should use :term:`PACKAGE_INSTALL` rather than | 295 | recipe, you should use :term:`PACKAGE_INSTALL` rather than |
296 | :term:`IMAGE_INSTALL`. :term:`PACKAGE_INSTALL` gives more direct control of | 296 | :term:`IMAGE_INSTALL`. :term:`PACKAGE_INSTALL` gives more direct control of |
297 | what is added to the image as compared to the defaults you might not | 297 | what is added to the image as compared to the defaults you might not |
298 | necessarily want that are set by the :ref:`image <ref-classes-image>` | 298 | necessarily want that are set by the :ref:`ref-classes-image` |
299 | or :ref:`core-image <ref-classes-core-image>` classes. | 299 | or :ref:`ref-classes-core-image` classes. |
300 | 300 | ||
301 | #. *Build the Kernel Image and the Initramfs Image:* Build your kernel | 301 | #. *Build the Kernel Image and the Initramfs Image:* Build your kernel |
302 | image using BitBake. Because the :term:`Initramfs` image recipe is a | 302 | image using BitBake. Because the :term:`Initramfs` image recipe is a |
@@ -683,7 +683,7 @@ your tunings to best consider build times and package feed maintenance. | |||
683 | A recipe that just generates scripts can enable "all" architecture | 683 | A recipe that just generates scripts can enable "all" architecture |
684 | because there are no binaries to build. To specifically enable "all" | 684 | because there are no binaries to build. To specifically enable "all" |
685 | architecture, be sure your recipe inherits the | 685 | architecture, be sure your recipe inherits the |
686 | :ref:`allarch <ref-classes-allarch>` class. | 686 | :ref:`ref-classes-allarch` class. |
687 | This class is useful for "all" architectures because it configures | 687 | This class is useful for "all" architectures because it configures |
688 | many variables so packages can be used across multiple architectures. | 688 | many variables so packages can be used across multiple architectures. |
689 | 689 | ||
@@ -796,7 +796,7 @@ where the development occurs. You want the recipe's | |||
796 | the external directory and use it as is, not copy it. | 796 | the external directory and use it as is, not copy it. |
797 | 797 | ||
798 | To build from software that comes from an external source, all you need to do | 798 | To build from software that comes from an external source, all you need to do |
799 | is inherit the :ref:`externalsrc <ref-classes-externalsrc>` class and then set | 799 | is inherit the :ref:`ref-classes-externalsrc` class and then set |
800 | the :term:`EXTERNALSRC` variable to point to your external source code. Here | 800 | the :term:`EXTERNALSRC` variable to point to your external source code. Here |
801 | are the statements to put in your ``local.conf`` file:: | 801 | are the statements to put in your ``local.conf`` file:: |
802 | 802 | ||
@@ -812,8 +812,7 @@ This next example shows how to accomplish the same thing by setting | |||
812 | .. note:: | 812 | .. note:: |
813 | 813 | ||
814 | In order for these settings to take effect, you must globally or | 814 | In order for these settings to take effect, you must globally or |
815 | locally inherit the :ref:`externalsrc <ref-classes-externalsrc>` | 815 | locally inherit the :ref:`ref-classes-externalsrc` class. |
816 | class. | ||
817 | 816 | ||
818 | By default, :ref:`ref-classes-externalsrc` builds the source code in a | 817 | By default, :ref:`ref-classes-externalsrc` builds the source code in a |
819 | directory separate from the external source directory as specified by | 818 | directory separate from the external source directory as specified by |
@@ -881,14 +880,14 @@ directory: | |||
881 | 880 | ||
882 | #. *Using Local Files Only:* Inside your ``local.conf`` file, add the | 881 | #. *Using Local Files Only:* Inside your ``local.conf`` file, add the |
883 | :term:`SOURCE_MIRROR_URL` variable, inherit the | 882 | :term:`SOURCE_MIRROR_URL` variable, inherit the |
884 | :ref:`own-mirrors <ref-classes-own-mirrors>` class, and use the | 883 | :ref:`ref-classes-own-mirrors` class, and use the |
885 | :term:`BB_NO_NETWORK` variable to your ``local.conf``:: | 884 | :term:`BB_NO_NETWORK` variable to your ``local.conf``:: |
886 | 885 | ||
887 | SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" | 886 | SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" |
888 | INHERIT += "own-mirrors" | 887 | INHERIT += "own-mirrors" |
889 | BB_NO_NETWORK = "1" | 888 | BB_NO_NETWORK = "1" |
890 | 889 | ||
891 | The :term:`SOURCE_MIRROR_URL` and :ref:`own-mirrors <ref-classes-own-mirrors>` | 890 | The :term:`SOURCE_MIRROR_URL` and :ref:`ref-classes-own-mirrors` |
892 | class set up the system to use the downloads directory as your "own | 891 | class set up the system to use the downloads directory as your "own |
893 | mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that | 892 | mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that |
894 | BitBake's fetching process in step 3 stays local, which means files | 893 | BitBake's fetching process in step 3 stays local, which means files |