diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-04-23 18:06:47 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-26 15:26:14 +0100 |
| commit | 91aacf4ed312a6bbb07a3ccabf76618575b0e637 (patch) | |
| tree | 6a0ef8345df063fe4d45761bd9d8b452c42d0120 /bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst | |
| parent | a836bd6fc042f144e02be33cc69378dbaabd345c (diff) | |
| download | poky-91aacf4ed312a6bbb07a3ccabf76618575b0e637.tar.gz | |
bitbake: doc: bitbake-user-manual: simplify colon usage
- This replaces instances of ": ::" by "::", which
generates identical HTML output
(Bitbake rev: fd8ce4dcaff3aae395f9945fb0a3be54905e1727)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst')
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst index 6f9d392935..b3cea61fff 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst | |||
| @@ -248,13 +248,13 @@ underlying, similarly-named recipe files. | |||
| 248 | 248 | ||
| 249 | When you name an append file, you can use the "``%``" wildcard character | 249 | When you name an append file, you can use the "``%``" wildcard character |
| 250 | to allow for matching recipe names. For example, suppose you have an | 250 | to allow for matching recipe names. For example, suppose you have an |
| 251 | append file named as follows: :: | 251 | append file named as follows:: |
| 252 | 252 | ||
| 253 | busybox_1.21.%.bbappend | 253 | busybox_1.21.%.bbappend |
| 254 | 254 | ||
| 255 | That append file | 255 | That append file |
| 256 | would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So, | 256 | would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So, |
| 257 | the append file would match the following recipe names: :: | 257 | the append file would match the following recipe names:: |
| 258 | 258 | ||
| 259 | busybox_1.21.1.bb | 259 | busybox_1.21.1.bb |
| 260 | busybox_1.21.2.bb | 260 | busybox_1.21.2.bb |
| @@ -290,7 +290,7 @@ You can obtain BitBake several different ways: | |||
| 290 | are using. The metadata is generally backwards compatible but not | 290 | are using. The metadata is generally backwards compatible but not |
| 291 | forward compatible. | 291 | forward compatible. |
| 292 | 292 | ||
| 293 | Here is an example that clones the BitBake repository: :: | 293 | Here is an example that clones the BitBake repository:: |
| 294 | 294 | ||
| 295 | $ git clone git://git.openembedded.org/bitbake | 295 | $ git clone git://git.openembedded.org/bitbake |
| 296 | 296 | ||
| @@ -298,7 +298,7 @@ You can obtain BitBake several different ways: | |||
| 298 | Git repository into a directory called ``bitbake``. Alternatively, | 298 | Git repository into a directory called ``bitbake``. Alternatively, |
| 299 | you can designate a directory after the ``git clone`` command if you | 299 | you can designate a directory after the ``git clone`` command if you |
| 300 | want to call the new directory something other than ``bitbake``. Here | 300 | want to call the new directory something other than ``bitbake``. Here |
| 301 | is an example that names the directory ``bbdev``: :: | 301 | is an example that names the directory ``bbdev``:: |
| 302 | 302 | ||
| 303 | $ git clone git://git.openembedded.org/bitbake bbdev | 303 | $ git clone git://git.openembedded.org/bitbake bbdev |
| 304 | 304 | ||
| @@ -317,7 +317,7 @@ You can obtain BitBake several different ways: | |||
| 317 | method for getting BitBake. Cloning the repository makes it easier | 317 | method for getting BitBake. Cloning the repository makes it easier |
| 318 | to update as patches are added to the stable branches. | 318 | to update as patches are added to the stable branches. |
| 319 | 319 | ||
| 320 | The following example downloads a snapshot of BitBake version 1.17.0: :: | 320 | The following example downloads a snapshot of BitBake version 1.17.0:: |
| 321 | 321 | ||
| 322 | $ wget http://git.openembedded.org/bitbake/snapshot/bitbake-1.17.0.tar.gz | 322 | $ wget http://git.openembedded.org/bitbake/snapshot/bitbake-1.17.0.tar.gz |
| 323 | $ tar zxpvf bitbake-1.17.0.tar.gz | 323 | $ tar zxpvf bitbake-1.17.0.tar.gz |
| @@ -347,7 +347,7 @@ execution examples. | |||
| 347 | Usage and syntax | 347 | Usage and syntax |
| 348 | ---------------- | 348 | ---------------- |
| 349 | 349 | ||
| 350 | Following is the usage and syntax for BitBake: :: | 350 | Following is the usage and syntax for BitBake:: |
| 351 | 351 | ||
| 352 | $ bitbake -h | 352 | $ bitbake -h |
| 353 | Usage: bitbake [options] [recipename/target recipe:do_task ...] | 353 | Usage: bitbake [options] [recipename/target recipe:do_task ...] |
| @@ -469,11 +469,11 @@ default task, which is "build". BitBake obeys inter-task dependencies | |||
| 469 | when doing so. | 469 | when doing so. |
| 470 | 470 | ||
| 471 | The following command runs the build task, which is the default task, on | 471 | The following command runs the build task, which is the default task, on |
| 472 | the ``foo_1.0.bb`` recipe file: :: | 472 | the ``foo_1.0.bb`` recipe file:: |
| 473 | 473 | ||
| 474 | $ bitbake -b foo_1.0.bb | 474 | $ bitbake -b foo_1.0.bb |
| 475 | 475 | ||
| 476 | The following command runs the clean task on the ``foo.bb`` recipe file: :: | 476 | The following command runs the clean task on the ``foo.bb`` recipe file:: |
| 477 | 477 | ||
| 478 | $ bitbake -b foo.bb -c clean | 478 | $ bitbake -b foo.bb -c clean |
| 479 | 479 | ||
| @@ -497,13 +497,13 @@ functionality, or when there are multiple versions of a recipe. | |||
| 497 | The ``bitbake`` command, when not using "--buildfile" or "-b" only | 497 | The ``bitbake`` command, when not using "--buildfile" or "-b" only |
| 498 | accepts a "PROVIDES". You cannot provide anything else. By default, a | 498 | accepts a "PROVIDES". You cannot provide anything else. By default, a |
| 499 | recipe file generally "PROVIDES" its "packagename" as shown in the | 499 | recipe file generally "PROVIDES" its "packagename" as shown in the |
| 500 | following example: :: | 500 | following example:: |
| 501 | 501 | ||
| 502 | $ bitbake foo | 502 | $ bitbake foo |
| 503 | 503 | ||
| 504 | This next example "PROVIDES" the | 504 | This next example "PROVIDES" the |
| 505 | package name and also uses the "-c" option to tell BitBake to just | 505 | package name and also uses the "-c" option to tell BitBake to just |
| 506 | execute the ``do_clean`` task: :: | 506 | execute the ``do_clean`` task:: |
| 507 | 507 | ||
| 508 | $ bitbake -c clean foo | 508 | $ bitbake -c clean foo |
| 509 | 509 | ||
| @@ -514,7 +514,7 @@ The BitBake command line supports specifying different tasks for | |||
| 514 | individual targets when you specify multiple targets. For example, | 514 | individual targets when you specify multiple targets. For example, |
| 515 | suppose you had two targets (or recipes) ``myfirstrecipe`` and | 515 | suppose you had two targets (or recipes) ``myfirstrecipe`` and |
| 516 | ``mysecondrecipe`` and you needed BitBake to run ``taskA`` for the first | 516 | ``mysecondrecipe`` and you needed BitBake to run ``taskA`` for the first |
| 517 | recipe and ``taskB`` for the second recipe: :: | 517 | recipe and ``taskB`` for the second recipe:: |
| 518 | 518 | ||
| 519 | $ bitbake myfirstrecipe:do_taskA mysecondrecipe:do_taskB | 519 | $ bitbake myfirstrecipe:do_taskA mysecondrecipe:do_taskB |
| 520 | 520 | ||
| @@ -540,7 +540,7 @@ produce more readable graphs. This way, you can remove from the graph | |||
| 540 | ``DEPENDS`` from inherited classes such as ``base.bbclass``. | 540 | ``DEPENDS`` from inherited classes such as ``base.bbclass``. |
| 541 | 541 | ||
| 542 | Here are two examples that create dependency graphs. The second example | 542 | Here are two examples that create dependency graphs. The second example |
| 543 | omits depends common in OpenEmbedded from the graph: :: | 543 | omits depends common in OpenEmbedded from the graph:: |
| 544 | 544 | ||
| 545 | $ bitbake -g foo | 545 | $ bitbake -g foo |
| 546 | 546 | ||
| @@ -582,17 +582,17 @@ accomplished by setting the | |||
| 582 | configuration files for ``target1`` and ``target2`` defined in the build | 582 | configuration files for ``target1`` and ``target2`` defined in the build |
| 583 | directory. The following statement in the ``local.conf`` file both | 583 | directory. The following statement in the ``local.conf`` file both |
| 584 | enables BitBake to perform multiple configuration builds and specifies | 584 | enables BitBake to perform multiple configuration builds and specifies |
| 585 | the two extra multiconfigs: :: | 585 | the two extra multiconfigs:: |
| 586 | 586 | ||
| 587 | BBMULTICONFIG = "target1 target2" | 587 | BBMULTICONFIG = "target1 target2" |
| 588 | 588 | ||
| 589 | Once the target configuration files are in place and BitBake has been | 589 | Once the target configuration files are in place and BitBake has been |
| 590 | enabled to perform multiple configuration builds, use the following | 590 | enabled to perform multiple configuration builds, use the following |
| 591 | command form to start the builds: :: | 591 | command form to start the builds:: |
| 592 | 592 | ||
| 593 | $ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ] | 593 | $ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ] |
| 594 | 594 | ||
| 595 | Here is an example for two extra multiconfigs: ``target1`` and ``target2``: :: | 595 | Here is an example for two extra multiconfigs: ``target1`` and ``target2``:: |
| 596 | 596 | ||
| 597 | $ bitbake mc::target mc:target1:target mc:target2:target | 597 | $ bitbake mc::target mc:target1:target mc:target2:target |
| 598 | 598 | ||
| @@ -613,12 +613,12 @@ multiconfig. | |||
| 613 | 613 | ||
| 614 | To enable dependencies in a multiple configuration build, you must | 614 | To enable dependencies in a multiple configuration build, you must |
| 615 | declare the dependencies in the recipe using the following statement | 615 | declare the dependencies in the recipe using the following statement |
| 616 | form: :: | 616 | form:: |
| 617 | 617 | ||
| 618 | task_or_package[mcdepends] = "mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend" | 618 | task_or_package[mcdepends] = "mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend" |
| 619 | 619 | ||
| 620 | To better show how to use this statement, consider an example with two | 620 | To better show how to use this statement, consider an example with two |
| 621 | multiconfigs: ``target1`` and ``target2``: :: | 621 | multiconfigs: ``target1`` and ``target2``:: |
| 622 | 622 | ||
| 623 | image_task[mcdepends] = "mc:target1:target2:image2:rootfs_task" | 623 | image_task[mcdepends] = "mc:target1:target2:image2:rootfs_task" |
| 624 | 624 | ||
| @@ -629,7 +629,7 @@ completion of the rootfs_task used to build out image2, which is | |||
| 629 | associated with the "target2" multiconfig. | 629 | associated with the "target2" multiconfig. |
| 630 | 630 | ||
| 631 | Once you set up this dependency, you can build the "target1" multiconfig | 631 | Once you set up this dependency, you can build the "target1" multiconfig |
| 632 | using a BitBake command as follows: :: | 632 | using a BitBake command as follows:: |
| 633 | 633 | ||
| 634 | $ bitbake mc:target1:image1 | 634 | $ bitbake mc:target1:image1 |
| 635 | 635 | ||
| @@ -639,7 +639,7 @@ the ``rootfs_task`` for the "target2" multiconfig build. | |||
| 639 | 639 | ||
| 640 | Having a recipe depend on the root filesystem of another build might not | 640 | Having a recipe depend on the root filesystem of another build might not |
| 641 | seem that useful. Consider this change to the statement in the image1 | 641 | seem that useful. Consider this change to the statement in the image1 |
| 642 | recipe: :: | 642 | recipe:: |
| 643 | 643 | ||
| 644 | image_task[mcdepends] = "mc:target1:target2:image2:image_task" | 644 | image_task[mcdepends] = "mc:target1:target2:image2:image_task" |
| 645 | 645 | ||
