diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 177 |
1 files changed, 92 insertions, 85 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 4702ae94e3..74375c89bf 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -1,5 +1,6 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
3 | 4 | ||
4 | <chapter id='extendpoky'> | 5 | <chapter id='extendpoky'> |
5 | 6 | ||
@@ -60,8 +61,8 @@ | |||
60 | and then explore that folder, you will discover many BSP layers within the | 61 | and then explore that folder, you will discover many BSP layers within the |
61 | <filename>meta-intel</filename> layer. | 62 | <filename>meta-intel</filename> layer. |
62 | For more information on BSP layers, see the | 63 | For more information on BSP layers, see the |
63 | "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>" | 64 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" |
64 | section in the Yocto Project Development Manual. | 65 | section in the Yocto Project Board Support Package (BSP) Developer's Guide. |
65 | </para> | 66 | </para> |
66 | </section> | 67 | </section> |
67 | 68 | ||
@@ -76,7 +77,7 @@ | |||
76 | you should be sure someone has not already created a layer containing the metadata | 77 | you should be sure someone has not already created a layer containing the metadata |
77 | you need. | 78 | you need. |
78 | You can see the | 79 | You can see the |
79 | <ulink url='http://www.openembedded.org/wiki/LayerIndex'><filename>LayerIndex</filename></ulink> | 80 | <ulink url='&OE_HOME_URL;/wiki/LayerIndex'><filename>LayerIndex</filename></ulink> |
80 | for a list of layers from the OpenEmbedded community that can be used in the | 81 | for a list of layers from the OpenEmbedded community that can be used in the |
81 | Yocto Project.</para></listitem> | 82 | Yocto Project.</para></listitem> |
82 | <listitem><para><emphasis>Create a Directory:</emphasis> Create the directory | 83 | <listitem><para><emphasis>Create a Directory:</emphasis> Create the directory |
@@ -108,24 +109,24 @@ | |||
108 | BBFILE_PRIORITY_yocto = "5" | 109 | BBFILE_PRIORITY_yocto = "5" |
109 | </literallayout></para> | 110 | </literallayout></para> |
110 | <para>In the previous example, the recipes for the layers are added to | 111 | <para>In the previous example, the recipes for the layers are added to |
111 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILES'>BBFILES</ulink></filename>. | 112 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'>BBFILES</ulink></filename>. |
112 | The | 113 | The |
113 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename> | 114 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename> |
114 | variable is then appended with the layer name. | 115 | variable is then appended with the layer name. |
115 | The | 116 | The |
116 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_PATTERN'>BBFILE_PATTERN</ulink></filename> | 117 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PATTERN'>BBFILE_PATTERN</ulink></filename> |
117 | variable is set to a regular expression and is used to match files | 118 | variable is set to a regular expression and is used to match files |
118 | from <filename>BBFILES</filename> into a particular layer. | 119 | from <filename>BBFILES</filename> into a particular layer. |
119 | In this case, immediate expansion of | 120 | In this case, immediate expansion of |
120 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-LAYERDIR'>LAYERDIR</ulink></filename> | 121 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename> |
121 | sets <filename>BBFILES_PATTERN</filename> to the layer's path. | 122 | sets <filename>BBFILES_PATTERN</filename> to the layer's path. |
122 | The | 123 | The |
123 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename> | 124 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename> |
124 | variable then assigns a priority to the layer. | 125 | variable then assigns a priority to the layer. |
125 | Applying priorities is useful in situations where the same package might appear in multiple | 126 | Applying priorities is useful in situations where the same package might appear in multiple |
126 | layers and allows you to choose what layer should take precedence.</para> | 127 | layers and allows you to choose what layer should take precedence.</para> |
127 | <para>Note the use of the | 128 | <para>Note the use of the |
128 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-LAYERDIR'>LAYERDIR</ulink></filename> | 129 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename> |
129 | variable with the immediate expansion operator. | 130 | variable with the immediate expansion operator. |
130 | The <filename>LAYERDIR</filename> variable expands to the directory of the current layer and | 131 | The <filename>LAYERDIR</filename> variable expands to the directory of the current layer and |
131 | requires the immediate expansion operator so that BitBake does not wait to expand the variable | 132 | requires the immediate expansion operator so that BitBake does not wait to expand the variable |
@@ -199,7 +200,7 @@ | |||
199 | <para> | 200 | <para> |
200 | Before the Yocto Project build system can use your new layer, you need to enable it. | 201 | Before the Yocto Project build system can use your new layer, you need to enable it. |
201 | To enable your layer, simply add your layer's path to the | 202 | To enable your layer, simply add your layer's path to the |
202 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBLAYERS'>BBLAYERS</ulink></filename> | 203 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename> |
203 | variable in your <filename>conf/bblayers.conf</filename> file, which is found in the | 204 | variable in your <filename>conf/bblayers.conf</filename> file, which is found in the |
204 | <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>. | 205 | <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>. |
205 | The following example shows how to enable a layer named <filename>meta-mylayer</filename>: | 206 | The following example shows how to enable a layer named <filename>meta-mylayer</filename>: |
@@ -290,12 +291,12 @@ | |||
290 | PRINC = "1" | 291 | PRINC = "1" |
291 | </literallayout> | 292 | </literallayout> |
292 | This example adds or overrides files in | 293 | This example adds or overrides files in |
293 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'><filename>SRC_URI</filename></ulink> | 294 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> |
294 | within a bbappend by extending the path BitBake uses to search for files. | 295 | within a bbappend by extending the path BitBake uses to search for files. |
295 | The most reliable way to do this is by prepending the | 296 | The most reliable way to do this is by prepending the |
296 | <filename>FILESEXTRAPATHS</filename> variable. | 297 | <filename>FILESEXTRAPATHS</filename> variable. |
297 | For example, if you have your files in a directory that is named the same as your package | 298 | For example, if you have your files in a directory that is named the same as your package |
298 | (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'><filename>PN</filename></ulink>), | 299 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>), |
299 | you can add this directory by adding the following to your bbappend file: | 300 | you can add this directory by adding the following to your bbappend file: |
300 | <literallayout class='monospaced'> | 301 | <literallayout class='monospaced'> |
301 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" | 302 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" |
@@ -328,7 +329,7 @@ | |||
328 | 329 | ||
329 | <para> | 330 | <para> |
330 | To specify the layer's priority manually, use the | 331 | To specify the layer's priority manually, use the |
331 | <ulink url='http://yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBFILE_PRIORITY'><filename>BBFILE_PRIORITY</filename></ulink> | 332 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'><filename>BBFILE_PRIORITY</filename></ulink> |
332 | variable. | 333 | variable. |
333 | For example: | 334 | For example: |
334 | <literallayout class='monospaced'> | 335 | <literallayout class='monospaced'> |
@@ -338,7 +339,7 @@ | |||
338 | 339 | ||
339 | <note> | 340 | <note> |
340 | <para>It is possible for a recipe with a lower version number | 341 | <para>It is possible for a recipe with a lower version number |
341 | <ulink url='http://yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'><filename>PV</filename></ulink> | 342 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> |
342 | in a layer that has a higher priority to take precedence.</para> | 343 | in a layer that has a higher priority to take precedence.</para> |
343 | <para>Also, the layer priority does not currently affect the precedence order of | 344 | <para>Also, the layer priority does not currently affect the precedence order of |
344 | <filename>.conf</filename> or <filename>.bbclass</filename> files. | 345 | <filename>.conf</filename> or <filename>.bbclass</filename> files. |
@@ -409,7 +410,8 @@ | |||
409 | variables. | 410 | variables. |
410 | For information on variables that are useful for recipes and for information about recipe naming | 411 | For information on variables that are useful for recipes and for information about recipe naming |
411 | issues, see the | 412 | issues, see the |
412 | "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-varlocality-recipe-required'>Required</ulink>" section of the Yocto Project Reference Manual. | 413 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-varlocality-recipe-required'>Required</ulink>" |
414 | section of the Yocto Project Reference Manual. | ||
413 | </para> | 415 | </para> |
414 | 416 | ||
415 | <para> | 417 | <para> |
@@ -434,12 +436,14 @@ | |||
434 | Building an application from a single file that is stored locally (e.g. under | 436 | Building an application from a single file that is stored locally (e.g. under |
435 | <filename>files/</filename>) requires a recipe that has the file listed in | 437 | <filename>files/</filename>) requires a recipe that has the file listed in |
436 | the | 438 | the |
437 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> variable. | 439 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> |
440 | variable. | ||
438 | Additionally, you need to manually write the <filename>do_compile</filename> and | 441 | Additionally, you need to manually write the <filename>do_compile</filename> and |
439 | <filename>do_install</filename> tasks. | 442 | <filename>do_install</filename> tasks. |
440 | The <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> variable defines the | 443 | The <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> |
444 | variable defines the | ||
441 | directory containing the source code, which is set to | 445 | directory containing the source code, which is set to |
442 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'> | 446 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'> |
443 | WORKDIR</ulink></filename> in this case - the directory BitBake uses for the build. | 447 | WORKDIR</ulink></filename> in this case - the directory BitBake uses for the build. |
444 | <literallayout class='monospaced'> | 448 | <literallayout class='monospaced'> |
445 | DESCRIPTION = "Simple helloworld application" | 449 | DESCRIPTION = "Simple helloworld application" |
@@ -477,7 +481,7 @@ | |||
477 | <para> | 481 | <para> |
478 | Applications that use Autotools such as <filename>autoconf</filename> and | 482 | Applications that use Autotools such as <filename>autoconf</filename> and |
479 | <filename>automake</filename> require a recipe that has a source archive listed in | 483 | <filename>automake</filename> require a recipe that has a source archive listed in |
480 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> and | 484 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> and |
481 | also inherits Autotools, which instructs BitBake to use the | 485 | also inherits Autotools, which instructs BitBake to use the |
482 | <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps | 486 | <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps |
483 | needed to build an Autotool-based application. | 487 | needed to build an Autotool-based application. |
@@ -500,9 +504,9 @@ | |||
500 | 504 | ||
501 | <para> | 505 | <para> |
502 | The variable | 506 | The variable |
503 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> | 507 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> |
504 | is used to track source license changes as described in the | 508 | is used to track source license changes as described in the |
505 | "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-configuring-LIC_FILES_CHKSUM'>Track License Change</ulink>" section. | 509 | "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Track License Change</ulink>" section. |
506 | You can quickly create Autotool-based recipes in a manner similar to the previous example. | 510 | You can quickly create Autotool-based recipes in a manner similar to the previous example. |
507 | </para> | 511 | </para> |
508 | </section> | 512 | </section> |
@@ -512,11 +516,13 @@ | |||
512 | 516 | ||
513 | <para> | 517 | <para> |
514 | Applications that use GNU <filename>make</filename> also require a recipe that has | 518 | Applications that use GNU <filename>make</filename> also require a recipe that has |
515 | the source archive listed in <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename>. | 519 | the source archive listed in |
520 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>. | ||
516 | You do not need to add a <filename>do_compile</filename> step since by default BitBake | 521 | You do not need to add a <filename>do_compile</filename> step since by default BitBake |
517 | starts the <filename>make</filename> command to compile the application. | 522 | starts the <filename>make</filename> command to compile the application. |
518 | If you need additional <filename>make</filename> options you should store them in the | 523 | If you need additional <filename>make</filename> options you should store them in the |
519 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-EXTRA_OEMAKE'>EXTRA_OEMAKE</ulink></filename> variable. | 524 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'>EXTRA_OEMAKE</ulink></filename> |
525 | variable. | ||
520 | BitBake passes these options into the <filename>make</filename> GNU invocation. | 526 | BitBake passes these options into the <filename>make</filename> GNU invocation. |
521 | Note that a <filename>do_install</filename> task is still required. | 527 | Note that a <filename>do_install</filename> task is still required. |
522 | Otherwise BitBake runs an empty <filename>do_install</filename> task by default. | 528 | Otherwise BitBake runs an empty <filename>do_install</filename> task by default. |
@@ -526,7 +532,7 @@ | |||
526 | Some applications might require extra parameters to be passed to the compiler. | 532 | Some applications might require extra parameters to be passed to the compiler. |
527 | For example, the application might need an additional header path. | 533 | For example, the application might need an additional header path. |
528 | You can accomplish this by adding to the | 534 | You can accomplish this by adding to the |
529 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-CFLAGS'>CFLAGS</ulink></filename> variable. | 535 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink></filename> variable. |
530 | The following example shows this: | 536 | The following example shows this: |
531 | <literallayout class='monospaced'> | 537 | <literallayout class='monospaced'> |
532 | CFLAGS_prepend = "-I ${S}/include " | 538 | CFLAGS_prepend = "-I ${S}/include " |
@@ -568,9 +574,9 @@ | |||
568 | 574 | ||
569 | <para> | 575 | <para> |
570 | You can use the variables | 576 | You can use the variables |
571 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGES'>PACKAGES</ulink></filename> and | 577 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> and |
572 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-FILES'>FILES</ulink></filename> to split an application into | 578 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink></filename> |
573 | multiple packages. | 579 | to split an application into multiple packages. |
574 | </para> | 580 | </para> |
575 | 581 | ||
576 | <para> | 582 | <para> |
@@ -600,17 +606,17 @@ | |||
600 | In the previous example, we want to ship the <filename>sxpm</filename> | 606 | In the previous example, we want to ship the <filename>sxpm</filename> |
601 | and <filename>cxpm</filename> binaries in separate packages. | 607 | and <filename>cxpm</filename> binaries in separate packages. |
602 | Since <filename>bindir</filename> would be packaged into the main | 608 | Since <filename>bindir</filename> would be packaged into the main |
603 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'>PN</ulink></filename> | 609 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> |
604 | package by default, we prepend the | 610 | package by default, we prepend the |
605 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGES'>PACKAGES</ulink> | 611 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink> |
606 | </filename> variable so additional package names are added to the start of list. | 612 | </filename> variable so additional package names are added to the start of list. |
607 | This results in the extra | 613 | This results in the extra |
608 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-FILES'>FILES</ulink></filename>_* | 614 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink>_*</filename> |
609 | variables then containing information that define which files and | 615 | variables then containing information that define which files and |
610 | directories go into which packages. | 616 | directories go into which packages. |
611 | Files included by earlier packages are skipped by latter packages. | 617 | Files included by earlier packages are skipped by latter packages. |
612 | Thus, the main | 618 | Thus, the main |
613 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'>PN</ulink></filename> package | 619 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> package |
614 | does not include the above listed files. | 620 | does not include the above listed files. |
615 | </para> | 621 | </para> |
616 | </section> | 622 | </section> |
@@ -677,7 +683,7 @@ | |||
677 | <filename>PACKAGENAME</filename> as the name of the package you want to attach to the | 683 | <filename>PACKAGENAME</filename> as the name of the package you want to attach to the |
678 | <filename>postinst</filename> script. | 684 | <filename>postinst</filename> script. |
679 | Normally | 685 | Normally |
680 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'>PN</ulink></filename> | 686 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> |
681 | can be used, which automatically expands to PACKAGENAME. | 687 | can be used, which automatically expands to PACKAGENAME. |
682 | A post-installation function has the following structure: | 688 | A post-installation function has the following structure: |
683 | <literallayout class='monospaced'> | 689 | <literallayout class='monospaced'> |
@@ -716,7 +722,7 @@ | |||
716 | 722 | ||
717 | <para> | 723 | <para> |
718 | The previous example delays execution until the image boots again because the | 724 | The previous example delays execution until the image boots again because the |
719 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-D'>D</ulink></filename> | 725 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'>D</ulink></filename> |
720 | variable points | 726 | variable points |
721 | to the directory containing the image when the root filesystem is created at build time but | 727 | to the directory containing the image when the root filesystem is created at build time but |
722 | is unset when executed on the first boot. | 728 | is unset when executed on the first boot. |
@@ -749,7 +755,8 @@ | |||
749 | By creating a custom image, a developer has total control | 755 | By creating a custom image, a developer has total control |
750 | over the contents of the image. | 756 | over the contents of the image. |
751 | It is important to use the correct names of packages in the | 757 | It is important to use the correct names of packages in the |
752 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> variable. | 758 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> |
759 | variable. | ||
753 | You must use the OpenEmbedded notation and not the Debian notation for the names | 760 | You must use the OpenEmbedded notation and not the Debian notation for the names |
754 | (e.g. <filename>eglibc-dev</filename> instead of <filename>libc6-dev</filename>). | 761 | (e.g. <filename>eglibc-dev</filename> instead of <filename>libc6-dev</filename>). |
755 | </para> | 762 | </para> |
@@ -775,13 +782,13 @@ | |||
775 | A good example of a tasks package is | 782 | A good example of a tasks package is |
776 | <filename>meta/recipes-sato/tasks/task-poky.bb</filename>. | 783 | <filename>meta/recipes-sato/tasks/task-poky.bb</filename>. |
777 | The | 784 | The |
778 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGES'>PACKAGES</ulink></filename> | 785 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> |
779 | variable lists the task packages to build along with the complementary | 786 | variable lists the task packages to build along with the complementary |
780 | <filename>-dbg</filename> and <filename>-dev</filename> packages. | 787 | <filename>-dbg</filename> and <filename>-dev</filename> packages. |
781 | For each package added, you can use | 788 | For each package added, you can use |
782 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-RDEPENDS'>RDEPENDS</ulink></filename> | 789 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename> |
783 | and | 790 | and |
784 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> | 791 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> |
785 | entries to provide a list of packages the parent task package should contain. | 792 | entries to provide a list of packages the parent task package should contain. |
786 | Following is an example: | 793 | Following is an example: |
787 | <literallayout class='monospaced'> | 794 | <literallayout class='monospaced'> |
@@ -819,7 +826,7 @@ | |||
819 | To build an image using these task packages, you need to add | 826 | To build an image using these task packages, you need to add |
820 | <filename>task-custom-apps</filename> and/or | 827 | <filename>task-custom-apps</filename> and/or |
821 | <filename>task-custom-tools</filename> to | 828 | <filename>task-custom-tools</filename> to |
822 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>. | 829 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>. |
823 | For other forms of image dependencies see the other areas of this section. | 830 | For other forms of image dependencies see the other areas of this section. |
824 | </para> | 831 | </para> |
825 | </section> | 832 | </section> |
@@ -831,7 +838,7 @@ | |||
831 | <para> | 838 | <para> |
832 | Ultimately users might want to add extra image features to the set used by | 839 | Ultimately users might want to add extra image features to the set used by |
833 | Yocto Project with the | 840 | Yocto Project with the |
834 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> | 841 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> |
835 | variable. | 842 | variable. |
836 | To create these features, the best reference is | 843 | To create these features, the best reference is |
837 | <filename>meta/classes/core-image.bbclass</filename>, which shows how the | 844 | <filename>meta/classes/core-image.bbclass</filename>, which shows how the |
@@ -840,12 +847,12 @@ | |||
840 | <filename>IMAGE_FEATURES</filename> | 847 | <filename>IMAGE_FEATURES</filename> |
841 | variable and then maps that into a set of tasks or packages. | 848 | variable and then maps that into a set of tasks or packages. |
842 | Based on this information the | 849 | Based on this information the |
843 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'> IMAGE_INSTALL</ulink></filename> | 850 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'> IMAGE_INSTALL</ulink></filename> |
844 | variable is generated automatically. | 851 | variable is generated automatically. |
845 | Users can add extra features by extending the class or creating a custom class for use | 852 | Users can add extra features by extending the class or creating a custom class for use |
846 | with specialized image <filename>.bb</filename> files. | 853 | with specialized image <filename>.bb</filename> files. |
847 | You can also add more features by configuring the | 854 | You can also add more features by configuring the |
848 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename> | 855 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename> |
849 | variable in the <filename>local.conf</filename> file found in the Yocto Project | 856 | variable in the <filename>local.conf</filename> file found in the Yocto Project |
850 | files located in the build directory. | 857 | files located in the build directory. |
851 | </para> | 858 | </para> |
@@ -882,7 +889,7 @@ | |||
882 | 889 | ||
883 | <para> | 890 | <para> |
884 | The simplest way to add extra packages to all images is by using the | 891 | The simplest way to add extra packages to all images is by using the |
885 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> | 892 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> |
886 | variable with the <filename>_append</filename> operator: | 893 | variable with the <filename>_append</filename> operator: |
887 | <literallayout class='monospaced'> | 894 | <literallayout class='monospaced'> |
888 | IMAGE_INSTALL_append = " strace" | 895 | IMAGE_INSTALL_append = " strace" |
@@ -917,7 +924,7 @@ | |||
917 | 924 | ||
918 | <para> | 925 | <para> |
919 | You can add packages using a similar approach through the | 926 | You can add packages using a similar approach through the |
920 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-POKY_EXTRA_INSTALL'>POKY_EXTRA_INSTALL</ulink></filename> | 927 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-POKY_EXTRA_INSTALL'>POKY_EXTRA_INSTALL</ulink></filename> |
921 | variable. | 928 | variable. |
922 | If you use this variable, only <filename>core-image-*</filename> images are affected. | 929 | If you use this variable, only <filename>core-image-*</filename> images are affected. |
923 | </para> | 930 | </para> |
@@ -930,7 +937,7 @@ | |||
930 | It is possible to filter or mask out recipe and recipe append files such that | 937 | It is possible to filter or mask out recipe and recipe append files such that |
931 | BitBake ignores them. | 938 | BitBake ignores them. |
932 | You can do this by providing an expression with the | 939 | You can do this by providing an expression with the |
933 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BBMASK'>BBMASK</ulink></filename> | 940 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename> |
934 | variable. | 941 | variable. |
935 | Here is an example: | 942 | Here is an example: |
936 | <literallayout class='monospaced'> | 943 | <literallayout class='monospaced'> |
@@ -1006,7 +1013,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1006 | <para> | 1013 | <para> |
1007 | For a complete example that shows how to add a new machine to the Yocto Project, | 1014 | For a complete example that shows how to add a new machine to the Yocto Project, |
1008 | see the | 1015 | see the |
1009 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>BSP Development Example</ulink>" | 1016 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-bsp-appendix'>BSP Development Example</ulink>" |
1010 | in Appendix A. | 1017 | in Appendix A. |
1011 | </para> | 1018 | </para> |
1012 | 1019 | ||
@@ -1022,11 +1029,11 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1022 | <para> | 1029 | <para> |
1023 | The most important variables to set in this file are as follows: | 1030 | The most important variables to set in this file are as follows: |
1024 | <itemizedlist> | 1031 | <itemizedlist> |
1025 | <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TARGET_ARCH'> | 1032 | <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_ARCH'> |
1026 | TARGET_ARCH</ulink></filename> (e.g. "arm")</para></listitem> | 1033 | TARGET_ARCH</ulink></filename> (e.g. "arm")</para></listitem> |
1027 | <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PREFERRED_PROVIDER'> | 1034 | <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER'> |
1028 | PREFERRED_PROVIDER</ulink></filename>_virtual/kernel (see below)</para></listitem> | 1035 | PREFERRED_PROVIDER</ulink></filename>_virtual/kernel (see below)</para></listitem> |
1029 | <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE_FEATURES'> | 1036 | <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_FEATURES'> |
1030 | MACHINE_FEATURES</ulink></filename> (e.g. "kernel26 apm screen wifi")</para></listitem> | 1037 | MACHINE_FEATURES</ulink></filename> (e.g. "kernel26 apm screen wifi")</para></listitem> |
1031 | </itemizedlist> | 1038 | </itemizedlist> |
1032 | </para> | 1039 | </para> |
@@ -1034,11 +1041,11 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1034 | <para> | 1041 | <para> |
1035 | You might also need these variables: | 1042 | You might also need these variables: |
1036 | <itemizedlist> | 1043 | <itemizedlist> |
1037 | <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SERIAL_CONSOLE'> | 1044 | <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SERIAL_CONSOLE'> |
1038 | SERIAL_CONSOLE</ulink></filename> (e.g. "115200 ttyS0")</para></listitem> | 1045 | SERIAL_CONSOLE</ulink></filename> (e.g. "115200 ttyS0")</para></listitem> |
1039 | <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-KERNEL_IMAGETYPE'> | 1046 | <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'> |
1040 | KERNEL_IMAGETYPE</ulink></filename> (e.g. "zImage")</para></listitem> | 1047 | KERNEL_IMAGETYPE</ulink></filename> (e.g. "zImage")</para></listitem> |
1041 | <listitem><para><filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-IMAGE_FSTYPES'> | 1048 | <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'> |
1042 | IMAGE_FSTYPES</ulink></filename> (e.g. "tar.gz jffs2")</para></listitem> | 1049 | IMAGE_FSTYPES</ulink></filename> (e.g. "tar.gz jffs2")</para></listitem> |
1043 | </itemizedlist> | 1050 | </itemizedlist> |
1044 | </para> | 1051 | </para> |
@@ -1065,9 +1072,9 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1065 | <para> | 1072 | <para> |
1066 | If you are creating a new recipe, normal recipe-writing rules apply for setting | 1073 | If you are creating a new recipe, normal recipe-writing rules apply for setting |
1067 | up a | 1074 | up a |
1068 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename>. | 1075 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>. |
1069 | Thus, you need to specify any necessary patches and set | 1076 | Thus, you need to specify any necessary patches and set |
1070 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> to point at the source code. | 1077 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> to point at the source code. |
1071 | You need to create a <filename>configure</filename> task that configures the | 1078 | You need to create a <filename>configure</filename> task that configures the |
1072 | unpacked kernel with a defconfig. | 1079 | unpacked kernel with a defconfig. |
1073 | You can do this by using a <filename>make defconfig</filename> command or, | 1080 | You can do this by using a <filename>make defconfig</filename> command or, |
@@ -1085,7 +1092,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1085 | used for other machines in a given kernel. | 1092 | used for other machines in a given kernel. |
1086 | A possible way to do this is by listing the file in the | 1093 | A possible way to do this is by listing the file in the |
1087 | <filename>SRC_URI</filename> and adding the machine to the expression in | 1094 | <filename>SRC_URI</filename> and adding the machine to the expression in |
1088 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-COMPATIBLE_MACHINE'>COMPATIBLE_MACHINE</ulink></filename>: | 1095 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'>COMPATIBLE_MACHINE</ulink></filename>: |
1089 | <literallayout class='monospaced'> | 1096 | <literallayout class='monospaced'> |
1090 | COMPATIBLE_MACHINE = '(qemux86|qemumips)' | 1097 | COMPATIBLE_MACHINE = '(qemux86|qemumips)' |
1091 | </literallayout> | 1098 | </literallayout> |
@@ -1159,7 +1166,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1159 | During a build, the unpacked temporary source code used by recipes | 1166 | During a build, the unpacked temporary source code used by recipes |
1160 | to build packages is available in the Yocto Project Build Directory as | 1167 | to build packages is available in the Yocto Project Build Directory as |
1161 | defined by the | 1168 | defined by the |
1162 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> variable. | 1169 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable. |
1163 | Below is the default value for the <filename>S</filename> variable as defined in the | 1170 | Below is the default value for the <filename>S</filename> variable as defined in the |
1164 | <filename>meta/conf/bitbake.conf</filename> configuration file in the | 1171 | <filename>meta/conf/bitbake.conf</filename> configuration file in the |
1165 | <link linkend='yocto-project-files'>Yocto Project Files</link>: | 1172 | <link linkend='yocto-project-files'>Yocto Project Files</link>: |
@@ -1180,7 +1187,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1180 | 1187 | ||
1181 | <para> | 1188 | <para> |
1182 | The path to the work directory for the recipe | 1189 | The path to the work directory for the recipe |
1183 | (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends | 1190 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends |
1184 | on the package name and the architecture of the target device. | 1191 | on the package name and the architecture of the target device. |
1185 | For example, here is the work directory for packages whose targets are not device-dependent: | 1192 | For example, here is the work directory for packages whose targets are not device-dependent: |
1186 | <literallayout class='monospaced'> | 1193 | <literallayout class='monospaced'> |
@@ -1212,15 +1219,15 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1212 | <note> | 1219 | <note> |
1213 | To better understand how the Yocto Project build system resolves directories during the | 1220 | To better understand how the Yocto Project build system resolves directories during the |
1214 | build process, see the glossary entries for the | 1221 | build process, see the glossary entries for the |
1215 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink>, | 1222 | <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>, |
1216 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TMPDIR'><filename>TMPDIR</filename></ulink>, | 1223 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>, |
1217 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TOPDIR'><filename>TOPDIR</filename></ulink>, | 1224 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink>, |
1218 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>, | 1225 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>, |
1219 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TARGET_OS'><filename>TARGET_OS</filename></ulink>, | 1226 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink>, |
1220 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'><filename>PN</filename></ulink>, | 1227 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>, |
1221 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'><filename>PV</filename></ulink>, | 1228 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, |
1222 | and | 1229 | and |
1223 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'><filename>PR</filename></ulink> | 1230 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> |
1224 | variables in the Yocto Project Reference Manual. | 1231 | variables in the Yocto Project Reference Manual. |
1225 | </note> | 1232 | </note> |
1226 | 1233 | ||
@@ -1255,7 +1262,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1255 | <listitem><para><emphasis>Change Your Working Directory:</emphasis> | 1262 | <listitem><para><emphasis>Change Your Working Directory:</emphasis> |
1256 | You need to be in the directory that has the temporary source code. | 1263 | You need to be in the directory that has the temporary source code. |
1257 | That directory is defined by the | 1264 | That directory is defined by the |
1258 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink> | 1265 | <ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink> |
1259 | variable.</para></listitem> | 1266 | variable.</para></listitem> |
1260 | <listitem><para><emphasis>Create a New Patch:</emphasis> | 1267 | <listitem><para><emphasis>Create a New Patch:</emphasis> |
1261 | Before modifying source code, you need to create a new patch. | 1268 | Before modifying source code, you need to create a new patch. |
@@ -1287,7 +1294,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1287 | <filename>-c cleanall</filename> with BitBake for the package. | 1294 | <filename>-c cleanall</filename> with BitBake for the package. |
1288 | Modifications will also disappear if you use the <filename>rm_work</filename> | 1295 | Modifications will also disappear if you use the <filename>rm_work</filename> |
1289 | feature as described in the | 1296 | feature as described in the |
1290 | "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" | 1297 | "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" |
1291 | section of the Yocto Project Quick Start. | 1298 | section of the Yocto Project Quick Start. |
1292 | </note></para></listitem> | 1299 | </note></para></listitem> |
1293 | <listitem><para><emphasis>Generate the Patch:</emphasis> | 1300 | <listitem><para><emphasis>Generate the Patch:</emphasis> |
@@ -1307,7 +1314,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1307 | Placing the patch here guarantees that the Yocto Project build system will find | 1314 | Placing the patch here guarantees that the Yocto Project build system will find |
1308 | the patch. | 1315 | the patch. |
1309 | Next, add the patch into the | 1316 | Next, add the patch into the |
1310 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> | 1317 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> |
1311 | of the recipe. | 1318 | of the recipe. |
1312 | Here is an example: | 1319 | Here is an example: |
1313 | <literallayout class='monospaced'> | 1320 | <literallayout class='monospaced'> |
@@ -1315,7 +1322,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1315 | </literallayout></para></listitem> | 1322 | </literallayout></para></listitem> |
1316 | <listitem><para><emphasis>Increment the Package Revision Number:</emphasis> | 1323 | <listitem><para><emphasis>Increment the Package Revision Number:</emphasis> |
1317 | Finally, don't forget to 'bump' the | 1324 | Finally, don't forget to 'bump' the |
1318 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'>PR</ulink></filename> | 1325 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> |
1319 | value in the same recipe since the resulting packages have changed.</para></listitem> | 1326 | value in the same recipe since the resulting packages have changed.</para></listitem> |
1320 | </orderedlist> | 1327 | </orderedlist> |
1321 | </para> | 1328 | </para> |
@@ -1351,7 +1358,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1351 | <listitem><para><emphasis>Change Your Working Directory:</emphasis> | 1358 | <listitem><para><emphasis>Change Your Working Directory:</emphasis> |
1352 | You need to be in the directory that has the temporary source code. | 1359 | You need to be in the directory that has the temporary source code. |
1353 | That directory is defined by the | 1360 | That directory is defined by the |
1354 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink> | 1361 | <ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink> |
1355 | variable.</para></listitem> | 1362 | variable.</para></listitem> |
1356 | <listitem><para><emphasis>Initialize a Git Repository:</emphasis> | 1363 | <listitem><para><emphasis>Initialize a Git Repository:</emphasis> |
1357 | Use the <filename>git init</filename> command to initialize a new local repository | 1364 | Use the <filename>git init</filename> command to initialize a new local repository |
@@ -1390,7 +1397,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1390 | <filename>-c cleanall</filename> with BitBake for the package. | 1397 | <filename>-c cleanall</filename> with BitBake for the package. |
1391 | Modifications will also disappear if you use the <filename>rm_work</filename> | 1398 | Modifications will also disappear if you use the <filename>rm_work</filename> |
1392 | feature as described in the | 1399 | feature as described in the |
1393 | "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" | 1400 | "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" |
1394 | section of the Yocto Project Quick Start. | 1401 | section of the Yocto Project Quick Start. |
1395 | </note></para></listitem> | 1402 | </note></para></listitem> |
1396 | <listitem><para><emphasis>See the List of Files You Changed:</emphasis> | 1403 | <listitem><para><emphasis>See the List of Files You Changed:</emphasis> |
@@ -1435,7 +1442,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1435 | Placing the patch here guarantees that the Yocto Project build system will find | 1442 | Placing the patch here guarantees that the Yocto Project build system will find |
1436 | the patch. | 1443 | the patch. |
1437 | Next, add the patch into the | 1444 | Next, add the patch into the |
1438 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'>SRC_URI</ulink></filename> | 1445 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> |
1439 | of the recipe. | 1446 | of the recipe. |
1440 | Here is an example: | 1447 | Here is an example: |
1441 | <literallayout class='monospaced'> | 1448 | <literallayout class='monospaced'> |
@@ -1443,7 +1450,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1443 | </literallayout></para></listitem> | 1450 | </literallayout></para></listitem> |
1444 | <listitem><para><emphasis>Increment the Package Revision Number:</emphasis> | 1451 | <listitem><para><emphasis>Increment the Package Revision Number:</emphasis> |
1445 | Finally, don't forget to 'bump' the | 1452 | Finally, don't forget to 'bump' the |
1446 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'>PR</ulink></filename> | 1453 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> |
1447 | value in the same recipe since the resulting packages have changed.</para></listitem> | 1454 | value in the same recipe since the resulting packages have changed.</para></listitem> |
1448 | </orderedlist> | 1455 | </orderedlist> |
1449 | </para> | 1456 | </para> |
@@ -1481,7 +1488,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1481 | <para> | 1488 | <para> |
1482 | This section overviews the Multilib process only. | 1489 | This section overviews the Multilib process only. |
1483 | For more details on how to implement Multilib, see the | 1490 | For more details on how to implement Multilib, see the |
1484 | <ulink url='https://wiki.yoctoproject.org/wiki/Multilib'>Multilib</ulink> wiki | 1491 | <ulink url='&YOCTO_WIKI_URL;/wiki/Multilib'>Multilib</ulink> wiki |
1485 | page. | 1492 | page. |
1486 | </para> | 1493 | </para> |
1487 | 1494 | ||
@@ -1630,7 +1637,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1630 | 1637 | ||
1631 | <para> | 1638 | <para> |
1632 | For concepts on kernel configuration, see the | 1639 | For concepts on kernel configuration, see the |
1633 | "<ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html#kernel-configuration'>Kernel Configuration</ulink>" | 1640 | "<ulink url='&YOCTO_DOCS_KERNEL_URL;#kernel-configuration'>Kernel Configuration</ulink>" |
1634 | section in the Yocto Project Kernel Architecture and Use Manual. | 1641 | section in the Yocto Project Kernel Architecture and Use Manual. |
1635 | </para> | 1642 | </para> |
1636 | 1643 | ||
@@ -1804,7 +1811,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1804 | <para> | 1811 | <para> |
1805 | If a committed change results in changing the package output, | 1812 | If a committed change results in changing the package output, |
1806 | then the value of the | 1813 | then the value of the |
1807 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'>PR</ulink></filename> | 1814 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> |
1808 | variable needs to be increased | 1815 | variable needs to be increased |
1809 | (or "bumped") as part of that commit. | 1816 | (or "bumped") as part of that commit. |
1810 | This means that for new recipes you must be sure to add the <filename>PR</filename> | 1817 | This means that for new recipes you must be sure to add the <filename>PR</filename> |
@@ -1817,7 +1824,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1817 | <para> | 1824 | <para> |
1818 | If you are sharing a common <filename>.inc</filename> file with multiple recipes, | 1825 | If you are sharing a common <filename>.inc</filename> file with multiple recipes, |
1819 | you can also use the | 1826 | you can also use the |
1820 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-INC_PR'>INC_PR</ulink></filename> | 1827 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-INC_PR'>INC_PR</ulink></filename> |
1821 | variable to ensure that | 1828 | variable to ensure that |
1822 | the recipes sharing the <filename>.inc</filename> file are rebuilt when the | 1829 | the recipes sharing the <filename>.inc</filename> file are rebuilt when the |
1823 | <filename>.inc</filename> file itself is changed. | 1830 | <filename>.inc</filename> file itself is changed. |
@@ -1830,7 +1837,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1830 | 1837 | ||
1831 | <para> | 1838 | <para> |
1832 | When upgrading the version of a package, assuming the | 1839 | When upgrading the version of a package, assuming the |
1833 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'>PV</ulink></filename> | 1840 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'>PV</ulink></filename> |
1834 | changes, the <filename>PR</filename> variable should be reset to "r0" | 1841 | changes, the <filename>PR</filename> variable should be reset to "r0" |
1835 | (or "$(INC_PR).0" if you are using <filename>INC_PR</filename>). | 1842 | (or "$(INC_PR).0" if you are using <filename>INC_PR</filename>). |
1836 | </para> | 1843 | </para> |
@@ -1839,7 +1846,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1839 | Usually, version increases occur only to packages. | 1846 | Usually, version increases occur only to packages. |
1840 | However, if for some reason <filename>PV</filename> changes but does not | 1847 | However, if for some reason <filename>PV</filename> changes but does not |
1841 | increase, you can increase the | 1848 | increase, you can increase the |
1842 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PE'>PE</ulink></filename> | 1849 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PE'>PE</ulink></filename> |
1843 | variable (Package Epoch). | 1850 | variable (Package Epoch). |
1844 | The <filename>PE</filename> variable defaults to "0". | 1851 | The <filename>PE</filename> variable defaults to "0". |
1845 | </para> | 1852 | </para> |
@@ -1876,7 +1883,7 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1876 | If the package exists under a different name in a different distribution, you get a | 1883 | If the package exists under a different name in a different distribution, you get a |
1877 | <filename>distro_check</filename> mismatch. | 1884 | <filename>distro_check</filename> mismatch. |
1878 | You can resolve this problem by defining a per-distro recipe name alias using the | 1885 | You can resolve this problem by defining a per-distro recipe name alias using the |
1879 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> | 1886 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> |
1880 | variable. | 1887 | variable. |
1881 | </para> | 1888 | </para> |
1882 | 1889 | ||
@@ -1928,16 +1935,16 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1928 | In this case, you want a kernel source directory on the development machine where the | 1935 | In this case, you want a kernel source directory on the development machine where the |
1929 | development occurs. | 1936 | development occurs. |
1930 | You want the recipe's | 1937 | You want the recipe's |
1931 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-SRC_URI'><filename>SRC_URI</filename></ulink> | 1938 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> |
1932 | variable to point to the external directory and use it as is, not copy it. | 1939 | variable to point to the external directory and use it as is, not copy it. |
1933 | </para> | 1940 | </para> |
1934 | 1941 | ||
1935 | <para> | 1942 | <para> |
1936 | To build from software that comes from an external source, all you need to do is | 1943 | To build from software that comes from an external source, all you need to do is |
1937 | change your recipe so that it inherits the | 1944 | change your recipe so that it inherits the |
1938 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink> | 1945 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink> |
1939 | class and then sets the | 1946 | class and then sets the |
1940 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'><filename>S</filename></ulink> | 1947 | <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> |
1941 | variable to point to your external source code. | 1948 | variable to point to your external source code. |
1942 | Here are the statements to put in your recipe: | 1949 | Here are the statements to put in your recipe: |
1943 | <literallayout class='monospaced'> | 1950 | <literallayout class='monospaced'> |
@@ -1949,11 +1956,11 @@ so that there are some definite steps on how to do this. I need more detail her | |||
1949 | <para> | 1956 | <para> |
1950 | It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the | 1957 | It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the |
1951 | source directory <filename>S</filename> and the build directory | 1958 | source directory <filename>S</filename> and the build directory |
1952 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-B'><filename>B</filename></ulink> | 1959 | <ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink> |
1953 | are different even though by default these directories are the same. | 1960 | are different even though by default these directories are the same. |
1954 | This assumption is important because it supports building different variants of the recipe | 1961 | This assumption is important because it supports building different variants of the recipe |
1955 | by using the | 1962 | by using the |
1956 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink> | 1963 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink> |
1957 | variable. | 1964 | variable. |
1958 | You could allow the build directory to be the same as the source directory but you would | 1965 | You could allow the build directory to be the same as the source directory but you would |
1959 | not be able to build more than one variant of the recipe. | 1966 | not be able to build more than one variant of the recipe. |