diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/adt-manual/adt-manual.xml | 2 | ||||
-rw-r--r-- | documentation/adt-manual/figures/adt-title.png | bin | 14349 -> 17398 bytes | |||
-rw-r--r-- | documentation/bsp-guide/bsp-guide.xml | 2 | ||||
-rw-r--r-- | documentation/bsp-guide/figures/bsp-title.png | bin | 14940 -> 17710 bytes | |||
-rw-r--r-- | documentation/dev-manual/dev-manual.xml | 2 | ||||
-rw-r--r-- | documentation/poky-ref-manual/extendpoky.xml | 15 | ||||
-rw-r--r-- | documentation/poky-ref-manual/poky-ref-manual.xml | 2 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-classes.xml | 2 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-images.xml | 13 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-structure.xml | 3 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 53 |
11 files changed, 53 insertions, 41 deletions
diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml index 7fef091dcd..a920d9f43e 100644 --- a/documentation/adt-manual/adt-manual.xml +++ b/documentation/adt-manual/adt-manual.xml | |||
@@ -15,7 +15,7 @@ | |||
15 | </imageobject> | 15 | </imageobject> |
16 | </mediaobject> | 16 | </mediaobject> |
17 | 17 | ||
18 | <title>Yocto Application Development Tookit (ADT) User's Guide</title> | 18 | <title></title> |
19 | 19 | ||
20 | <authorgroup> | 20 | <authorgroup> |
21 | <author> | 21 | <author> |
diff --git a/documentation/adt-manual/figures/adt-title.png b/documentation/adt-manual/figures/adt-title.png index fe6ed26dc4..c924de61f9 100644 --- a/documentation/adt-manual/figures/adt-title.png +++ b/documentation/adt-manual/figures/adt-title.png | |||
Binary files differ | |||
diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 08feb5d810..75fa7fe64c 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml | |||
@@ -15,7 +15,7 @@ | |||
15 | </imageobject> | 15 | </imageobject> |
16 | </mediaobject> | 16 | </mediaobject> |
17 | 17 | ||
18 | <title>Yocto Board Support Package (BSP) Development Guide</title> | 18 | <title></title> |
19 | 19 | ||
20 | <authorgroup> | 20 | <authorgroup> |
21 | <author> | 21 | <author> |
diff --git a/documentation/bsp-guide/figures/bsp-title.png b/documentation/bsp-guide/figures/bsp-title.png index ee383141f0..da60362fbe 100644 --- a/documentation/bsp-guide/figures/bsp-title.png +++ b/documentation/bsp-guide/figures/bsp-title.png | |||
Binary files differ | |||
diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml index 1be8e20b3f..baddc1ce3d 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml | |||
@@ -15,7 +15,7 @@ | |||
15 | </imageobject> | 15 | </imageobject> |
16 | </mediaobject> | 16 | </mediaobject> |
17 | 17 | ||
18 | <title>Yocto Project Development Manual</title> | 18 | <title></title> |
19 | 19 | ||
20 | <authorgroup> | 20 | <authorgroup> |
21 | <author> | 21 | <author> |
diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml index fdccbacd68..db15fc6178 100644 --- a/documentation/poky-ref-manual/extendpoky.xml +++ b/documentation/poky-ref-manual/extendpoky.xml | |||
@@ -1004,7 +1004,7 @@ | |||
1004 | 1004 | ||
1005 | <para> | 1005 | <para> |
1006 | Finally, don't forget to 'bump' the | 1006 | Finally, don't forget to 'bump' the |
1007 | <glossterm><link linkend='var-PR'>PR</link></glossterm> value in the same recipe since | 1007 | <filename><link linkend='var-PR'>PR</link></filename> value in the same recipe since |
1008 | the resulting packages have changed. | 1008 | the resulting packages have changed. |
1009 | </para> | 1009 | </para> |
1010 | </section> | 1010 | </section> |
@@ -1015,7 +1015,7 @@ | |||
1015 | <para> | 1015 | <para> |
1016 | The license of an upstream project might change in the future. In order to prevent these changes | 1016 | The license of an upstream project might change in the future. In order to prevent these changes |
1017 | going unnoticed, the Yocto Project provides a | 1017 | going unnoticed, the Yocto Project provides a |
1018 | <glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm> | 1018 | <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename> |
1019 | variable to track changes to the license text. The checksums are validated at the end of the | 1019 | variable to track changes to the license text. The checksums are validated at the end of the |
1020 | configure step, and if the checksums do not match, the build will fail. | 1020 | configure step, and if the checksums do not match, the build will fail. |
1021 | </para> | 1021 | </para> |
@@ -1060,8 +1060,8 @@ | |||
1060 | of <filename>S</filename>. | 1060 | of <filename>S</filename>. |
1061 | </para> | 1061 | </para> |
1062 | <para> | 1062 | <para> |
1063 | Note that this variable is mandatory for all recipes, unless the LICENSE variable is set to | 1063 | Note that this variable is mandatory for all recipes, unless the |
1064 | "CLOSED". | 1064 | <filename>LICENSE</filename> variable is set to "CLOSED". |
1065 | </para> | 1065 | </para> |
1066 | </section> | 1066 | </section> |
1067 | 1067 | ||
@@ -1073,12 +1073,13 @@ | |||
1073 | important files that contain the license text for the source code. | 1073 | important files that contain the license text for the source code. |
1074 | It is possible to specify a checksum for an entire file, or a specific section of a | 1074 | It is possible to specify a checksum for an entire file, or a specific section of a |
1075 | file (specified by beginning and ending line numbers with the "beginline" and "endline" | 1075 | file (specified by beginning and ending line numbers with the "beginline" and "endline" |
1076 | parameters respectively). The latter is useful for source files with license notice header, | 1076 | parameters respectively). |
1077 | README documents, etc. | 1077 | The latter is useful for source files with a license notice header, |
1078 | README documents, and so forth. | ||
1078 | If you do not use the "beginline" parameter, then it is assumed that the text begins on the | 1079 | If you do not use the "beginline" parameter, then it is assumed that the text begins on the |
1079 | first line of the file. | 1080 | first line of the file. |
1080 | Similarly, if you do not use the "endline" parameter, it is assumed that the license text | 1081 | Similarly, if you do not use the "endline" parameter, it is assumed that the license text |
1081 | ends as the last line of the file. | 1082 | ends with the last line of the file. |
1082 | </para> | 1083 | </para> |
1083 | 1084 | ||
1084 | <para> | 1085 | <para> |
diff --git a/documentation/poky-ref-manual/poky-ref-manual.xml b/documentation/poky-ref-manual/poky-ref-manual.xml index 599cfdc938..a95436723f 100644 --- a/documentation/poky-ref-manual/poky-ref-manual.xml +++ b/documentation/poky-ref-manual/poky-ref-manual.xml | |||
@@ -15,7 +15,7 @@ | |||
15 | </imageobject> | 15 | </imageobject> |
16 | </mediaobject> | 16 | </mediaobject> |
17 | 17 | ||
18 | <title>Yocto Project Reference Manual</title> | 18 | <title></title> |
19 | 19 | ||
20 | <authorgroup> | 20 | <authorgroup> |
21 | <author> | 21 | <author> |
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml index 4530754249..cf396800df 100644 --- a/documentation/poky-ref-manual/ref-classes.xml +++ b/documentation/poky-ref-manual/ref-classes.xml | |||
@@ -81,7 +81,7 @@ | |||
81 | <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> | 81 | <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> |
82 | 82 | ||
83 | <para> | 83 | <para> |
84 | Several programs can fulfil the same or similar function and be installed with the same name. | 84 | Several programs can fulfill the same or similar function and be installed with the same name. |
85 | For example, the <filename>ar</filename> command is available from the | 85 | For example, the <filename>ar</filename> command is available from the |
86 | <filename>busybox</filename>, <filename>binutils</filename> and | 86 | <filename>busybox</filename>, <filename>binutils</filename> and |
87 | <filename>elfutils</filename> packages. | 87 | <filename>elfutils</filename> packages. |
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml index 8c240fca6d..4e7b029ea7 100644 --- a/documentation/poky-ref-manual/ref-images.xml +++ b/documentation/poky-ref-manual/ref-images.xml | |||
@@ -95,11 +95,14 @@ | |||
95 | </itemizedlist> | 95 | </itemizedlist> |
96 | 96 | ||
97 | <tip> | 97 | <tip> |
98 | From Yocto release 1.1 onwards, -live and -directdisk images have been replaced by a "live" | 98 | From the Yocto Project release 1.1 onwards, <filename>-live</filename> and |
99 | option in IMAGE_FSTYPES that will work with any image to produce an image file that can be | 99 | <filename>-directdisk</filename> images have been replaced by a "live" |
100 | copied directly to a CD or USB device and run as is. To build a live image, simply add | 100 | option in <filename>IMAGE_FSTYPES</filename> that will work with any image to produce an |
101 | "live" to IMAGE_FSTYPES within local.conf or whereever appropriate and then build the desired | 101 | image file that can be |
102 | image as normal. | 102 | copied directly to a CD or USB device and run as is. |
103 | To build a live image, simply add | ||
104 | "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename> | ||
105 | file or wherever appropriate and then build the desired image as normal. | ||
103 | </tip> | 106 | </tip> |
104 | </appendix> | 107 | </appendix> |
105 | <!-- | 108 | <!-- |
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index be81faf586..907343cd34 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml | |||
@@ -468,7 +468,8 @@ | |||
468 | Any distribution-specific configuration is controlled from this directory. | 468 | Any distribution-specific configuration is controlled from this directory. |
469 | The Yocto Project only contains the Yocto Project distribution so | 469 | The Yocto Project only contains the Yocto Project distribution so |
470 | <filename>defaultsetup.conf</filename> is the main file here. | 470 | <filename>defaultsetup.conf</filename> is the main file here. |
471 | This directory includes the versions and SRCDATEs for applications that are configured here. | 471 | This directory includes the versions and the |
472 | <filename>SRCDATE</filename> variables for applications that are configured here. | ||
472 | An example of an alternative configuration is <filename>poky-bleeding.conf</filename> | 473 | An example of an alternative configuration is <filename>poky-bleeding.conf</filename> |
473 | although this file mainly inherits its configuration from the Yocto Project itself. | 474 | although this file mainly inherits its configuration from the Yocto Project itself. |
474 | </para> | 475 | </para> |
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index f942cc7319..7f51fc9885 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -74,8 +74,10 @@ | |||
74 | 74 | ||
75 | <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> | 75 | <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> |
76 | <glossdef> | 76 | <glossdef> |
77 | <para>Lists the names of configured layers. These names are used to find the other BBFILE_* | 77 | <para>Lists the names of configured layers. |
78 | variables. Typically each layer will append its name to this variable in its | 78 | These names are used to find the other <filename>BBFILE_*</filename> |
79 | variables. | ||
80 | Typically, each layer will append its name to this variable in its | ||
79 | <filename>conf/layer.conf</filename> file. | 81 | <filename>conf/layer.conf</filename> file. |
80 | </para> | 82 | </para> |
81 | </glossdef> | 83 | </glossdef> |
@@ -105,14 +107,16 @@ | |||
105 | lower precedence.</para> | 107 | lower precedence.</para> |
106 | <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher | 108 | <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher |
107 | precedence. | 109 | precedence. |
108 | For example, the value 6 has a higher precedence than the | 110 | For example, the value 6 has a higher precedence than the value 5. |
109 | value 5. | 111 | If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer |
110 | If not specified, the BBFILE_PRIORITY variable is set based on layer | 112 | dependencies (see the |
111 | dependencies (see LAYERDEPENDS below). Tdefault priority if unspecified | 113 | <filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for |
112 | for a layer with no dependencies is the lowest defined priority + 1 | 114 | more information. |
115 | The default priority, if unspecified | ||
116 | for a layer with no dependencies, is the lowest defined priority + 1 | ||
113 | (or 1 if no priorities are defined).</para> | 117 | (or 1 if no priorities are defined).</para> |
114 | <tip> | 118 | <tip> |
115 | You can use the command "bitbake-layers show_layers" to list | 119 | You can use the command <filename>bitbake-layers show_layers</filename> to list |
116 | all configured layers along with their priorities. | 120 | all configured layers along with their priorities. |
117 | </tip> | 121 | </tip> |
118 | </glossdef> | 122 | </glossdef> |
@@ -552,14 +556,14 @@ | |||
552 | <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> | 556 | <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> |
553 | <glossdef> | 557 | <glossdef> |
554 | <para>Lists the layers that this recipe depends upon, separated by spaces. | 558 | <para>Lists the layers that this recipe depends upon, separated by spaces. |
555 | Optionally a specific layer version may be specified for a dependency | 559 | Optionally, you can specify a specific layer version for a dependency |
556 | by adding it to the end of the layer name with a colon, e.g. "anotherlayer:3" | 560 | by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" |
557 | (to be compared against LAYERVERSION_anotherlayer in this example). | 561 | to be compared against <filename>LAYERVERSION_anotherlayer</filename> in this case). |
558 | An error will be produced if any dependency is missing or | 562 | An error will be produced if any dependency is missing or |
559 | the version numbers do not match exactly (if specified). | 563 | the version numbers do not match exactly (if specified). |
560 | This variable is used in the <filename>conf/layer.conf</filename> file | 564 | This variable is used in the <filename>conf/layer.conf</filename> file |
561 | and must be suffixed with the name of the specific layer (e.g. | 565 | and must be suffixed with the name of the specific layer (e.g. |
562 | LAYERDEPENDS_mylayer).</para> | 566 | <filename>LAYERDEPENDS_mylayer</filename>).</para> |
563 | </glossdef> | 567 | </glossdef> |
564 | </glossentry> | 568 | </glossentry> |
565 | 569 | ||
@@ -577,11 +581,11 @@ | |||
577 | <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> | 581 | <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> |
578 | <glossdef> | 582 | <glossdef> |
579 | <para>Optionally specifies the version of a layer as a single number. | 583 | <para>Optionally specifies the version of a layer as a single number. |
580 | This may be used within LAYERDEPENDS for another layer in order to | 584 | You can use this within <filename>LAYERDEPENDS</filename> for another layer in order to |
581 | depend on a specific version of the layer. | 585 | depend on a specific version of the layer. |
582 | This variable is used in the <filename>conf/layer.conf</filename> file | 586 | This variable is used in the <filename>conf/layer.conf</filename> file |
583 | and must be suffixed with the name of the specific layer (e.g. | 587 | and must be suffixed with the name of the specific layer (e.g. |
584 | LAYERVERSION_mylayer).</para> | 588 | <filename>LAYERVERSION_mylayer</filename>).</para> |
585 | </glossdef> | 589 | </glossdef> |
586 | </glossentry> | 590 | </glossentry> |
587 | 591 | ||
@@ -600,7 +604,7 @@ | |||
600 | failure, which gives the developer an opportunity to review any | 604 | failure, which gives the developer an opportunity to review any |
601 | license change.</para> | 605 | license change.</para> |
602 | <para> | 606 | <para> |
603 | This variable must be defined for all recipes (unless LICENSE | 607 | This variable must be defined for all recipes (unless <filename>LICENSE</filename> |
604 | is set to "CLOSED")</para> | 608 | is set to "CLOSED")</para> |
605 | <para>For more information, see the | 609 | <para>For more information, see the |
606 | <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> | 610 | <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> |
@@ -970,10 +974,11 @@ | |||
970 | <para> | 974 | <para> |
971 | The revision of the source code used to build the package. | 975 | The revision of the source code used to build the package. |
972 | This variable applies to Subversion, Git, Mercurial and Bazaar | 976 | This variable applies to Subversion, Git, Mercurial and Bazaar |
973 | only. Note that if you wish to build a fixed revision and you wish | 977 | only. |
978 | Note that if you wish to build a fixed revision and you wish | ||
974 | to avoid performing a query on the remote repository every time | 979 | to avoid performing a query on the remote repository every time |
975 | BitBake parses your recipe, you should specify a SRCREV that is a | 980 | BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a |
976 | full revision identifier (and not just a tag). | 981 | full revision identifier and not just a tag. |
977 | </para> | 982 | </para> |
978 | </glossdef> | 983 | </glossdef> |
979 | </glossentry> | 984 | </glossentry> |
@@ -1070,14 +1075,16 @@ | |||
1070 | By default, the variable is set to "xterm" but it can | 1075 | By default, the variable is set to "xterm" but it can |
1071 | be any X11 terminal application or a terminal multiplexer such as screen. | 1076 | be any X11 terminal application or a terminal multiplexer such as screen. |
1072 | </para> | 1077 | </para> |
1073 | <para> | 1078 | <note> |
1074 | NOTE: whilst KONSOLE_TERMCMD and KONSOLE_TERMCMDRUN are provided | 1079 | While <filename>KONSOLE_TERMCMD</filename> and |
1080 | <filename>KONSOLE_TERMCMDRUN</filename> are provided | ||
1075 | and will work with KDE's Konsole terminal application Konsole from KDE 3, | 1081 | and will work with KDE's Konsole terminal application Konsole from KDE 3, |
1076 | Konsole in KDE 4.0 and later will no longer work here due to the fact | 1082 | Konsole in KDE 4.0 and later versions will no longer work here due to the fact |
1077 | that it now launches in the background by default, and it is not practically | 1083 | that it now launches in the background by default, and it is not practically |
1078 | possible to wait until it has terminated. It is hoped that this can be fixed | 1084 | possible to wait until it has terminated. |
1085 | It is hoped that this can be fixed | ||
1079 | in a future version. | 1086 | in a future version. |
1080 | </para> | 1087 | </note> |
1081 | </glossdef> | 1088 | </glossdef> |
1082 | </glossentry> | 1089 | </glossentry> |
1083 | 1090 | ||