diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-08-24 07:58:32 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-08-24 19:49:38 -0700 |
commit | d02e56fd14026e2f51665631a50901fc568c731a (patch) | |
tree | 8ba09da577f6c5cae8a637370ab0c7531bc54ade /documentation/poky-ref-manual/ref-variables.xml | |
parent | 88dfc936dc37b316acdbcd1b12d37f93fe65eea7 (diff) | |
download | poky-d02e56fd14026e2f51665631a50901fc568c731a.tar.gz |
documentation: Changes to Paul Eggleton's edits for various manuals.
Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them. However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2. After merging them to my yocto-docs/master
branch I fixed some issues.
(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 53 |
1 files changed, 30 insertions, 23 deletions
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 | ||