diff options
author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-14 22:48:44 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:35 +0100 |
commit | 292598164a304a3da3288e6fb8963f13045d1e7f (patch) | |
tree | efedbbdc16cb2e0978a4d40e6a6294e32b0e496f /documentation/ref-manual/ref-terms.rst | |
parent | d313d972bf592de77f2af13cb3fc4226247cb1a1 (diff) | |
download | poky-292598164a304a3da3288e6fb8963f13045d1e7f.tar.gz |
sphinx: ref-manual links fixes and many other cleanups to import
(From yocto-docs rev: d079e418d5a81610e1f06a7a6ca45dd040c1402e)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-terms.rst')
-rw-r--r-- | documentation/ref-manual/ref-terms.rst | 28 |
1 files changed, 17 insertions, 11 deletions
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index 24eff62bcd..312fc12ef0 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst | |||
@@ -26,7 +26,12 @@ universal, the list includes them just in case: | |||
26 | 26 | ||
27 | When you name an append file, you can use the "``%``" wildcard character | 27 | When you name an append file, you can use the "``%``" wildcard character |
28 | to allow for matching recipe names. For example, suppose you have an | 28 | to allow for matching recipe names. For example, suppose you have an |
29 | append file named as follows: busybox_1.21.%.bbappend That append file | 29 | append file named as follows: |
30 | :: | ||
31 | |||
32 | busybox_1.21.%.bbappend | ||
33 | |||
34 | That append file | ||
30 | would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So, | 35 | would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So, |
31 | the append file would match any of the following recipe names: | 36 | the append file would match any of the following recipe names: |
32 | 37 | ||
@@ -68,11 +73,11 @@ universal, the list includes them just in case: | |||
68 | examples assume your :term:`Source Directory` is named ``poky``: | 73 | examples assume your :term:`Source Directory` is named ``poky``: |
69 | 74 | ||
70 | - Create the Build Directory inside your Source Directory and let | 75 | - Create the Build Directory inside your Source Directory and let |
71 | the name of the Build Directory default to ``build``: | 76 | the name of the Build Directory default to ``build``: |
72 | 77 | ||
73 | .. code-block:: shell | 78 | .. code-block:: shell |
74 | 79 | ||
75 | $ cd $HOME/poky | 80 | $ cd $HOME/poky |
76 | $ source oe-init-build-env | 81 | $ source oe-init-build-env |
77 | 82 | ||
78 | - Create the Build Directory inside your home directory and | 83 | - Create the Build Directory inside your home directory and |
@@ -80,18 +85,18 @@ universal, the list includes them just in case: | |||
80 | 85 | ||
81 | .. code-block:: shell | 86 | .. code-block:: shell |
82 | 87 | ||
83 | $ cd $HOME | 88 | $ cd $HOME |
84 | $ source poky/oe-init-build-env test-builds | 89 | $ source poky/oe-init-build-env test-builds |
85 | 90 | ||
86 | - Provide a directory path and specifically name the Build | 91 | - Provide a directory path and specifically name the Build |
87 | Directory. Any intermediate folders in the pathname must exist. | 92 | Directory. Any intermediate folders in the pathname must exist. |
88 | This next example creates a Build Directory named | 93 | This next example creates a Build Directory named |
89 | ``YP-POKYVERSION`` in your home directory within the existing | 94 | ``YP-POKYVERSION`` in your home directory within the existing |
90 | directory ``mybuilds``: | 95 | directory ``mybuilds``: |
91 | 96 | ||
92 | .. code-block:: shell | 97 | .. code-block:: shell |
93 | 98 | ||
94 | $ cd $HOME | 99 | $ cd $HOME |
95 | $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION | 100 | $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION |
96 | 101 | ||
97 | .. note:: | 102 | .. note:: |
@@ -349,8 +354,9 @@ universal, the list includes them just in case: | |||
349 | While it is not recommended that you use tarball expansion to set up | 354 | While it is not recommended that you use tarball expansion to set up |
350 | the Source Directory, if you do, the top-level directory name of the | 355 | the Source Directory, if you do, the top-level directory name of the |
351 | Source Directory is derived from the Yocto Project release tarball. | 356 | Source Directory is derived from the Yocto Project release tarball. |
352 | For example, downloading and unpacking ```` results in a Source | 357 | For example, downloading and unpacking |
353 | Directory whose root folder is named ````. | 358 | :yocto_dl:`releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` |
359 | results in a Source Directory whose root folder is named ``poky``. | ||
354 | 360 | ||
355 | It is important to understand the differences between the Source | 361 | It is important to understand the differences between the Source |
356 | Directory created by unpacking a released tarball as compared to | 362 | Directory created by unpacking a released tarball as compared to |
@@ -366,8 +372,8 @@ universal, the list includes them just in case: | |||
366 | repository. | 372 | repository. |
367 | 373 | ||
368 | For more information on concepts related to Git repositories, | 374 | For more information on concepts related to Git repositories, |
369 | branches, and tags, see the "`Repositories, Tags, and | 375 | branches, and tags, see the |
370 | Branches <&YOCTO_DOCS_OM_URL;#repositories-tags-and-branches>`__" | 376 | ":ref:`overview-manual/overview-manual-development-environment:repositories, tags, and branches`" |
371 | section in the Yocto Project Overview and Concepts Manual. | 377 | section in the Yocto Project Overview and Concepts Manual. |
372 | 378 | ||
373 | Task | 379 | Task |
@@ -381,7 +387,7 @@ universal, the list includes them just in case: | |||
381 | The interface enables you to | 387 | The interface enables you to |
382 | configure and run your builds. Information about builds is collected | 388 | configure and run your builds. Information about builds is collected |
383 | and stored in a database. For information on Toaster, see the | 389 | and stored in a database. For information on Toaster, see the |
384 | `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__. | 390 | :doc:`../toaster-manual/toaster-manual`. |
385 | 391 | ||
386 | Upstream | 392 | Upstream |
387 | A reference to source code or repositories that are not | 393 | A reference to source code or repositories that are not |