diff options
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 48 |
1 files changed, 20 insertions, 28 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index d54b5bcdfc..5b56765cdd 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -1104,40 +1104,32 @@ Core layer for images cannot be removed | |||
1104 | <para> | 1104 | <para> |
1105 | Extends the search path the OpenEmbedded build system uses | 1105 | Extends the search path the OpenEmbedded build system uses |
1106 | when looking for files and patches as it processes recipes. | 1106 | when looking for files and patches as it processes recipes. |
1107 | The directories BitBake uses when it processes recipes are | 1107 | Best practices dictate that you accomplish this by using the |
1108 | defined by the | 1108 | variable from within a <filename>.bbappend</filename> file |
1109 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable. | 1109 | and that you prepend paths as follows: |
1110 | You can add directories to the search path by defining the | ||
1111 | <filename>FILESEXTRAPATHS</filename> variable. | ||
1112 | </para> | ||
1113 | |||
1114 | <para> | ||
1115 | To add paths to the front of the search order, prepend | ||
1116 | them and use the immediate expansion | ||
1117 | (<filename>:=</filename>) operator. | ||
1118 | Provide a list of directories and separate | ||
1119 | each path using a colon character as follows: | ||
1120 | <literallayout class='monospaced'> | ||
1121 | FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" | ||
1122 | </literallayout> | ||
1123 | You can add paths to the end of the search order by simply | ||
1124 | adding them as follows: | ||
1125 | <literallayout class='monospaced'> | 1110 | <literallayout class='monospaced'> |
1126 | FILESEXTRAPATHS := "path_1:path_2:path_3:" | 1111 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" |
1127 | </literallayout> | 1112 | </literallayout> |
1128 | To maintain the integrity of the | ||
1129 | <filename>FILESPATH</filename> variable, you must include | ||
1130 | the appropriate beginning or ending (as needed) colon | ||
1131 | character. | ||
1132 | </para> | 1113 | </para> |
1133 | 1114 | ||
1134 | <para> | 1115 | <para> |
1135 | The <filename>FILESEXTRAPATHS</filename> variable is | 1116 | The directories BitBake uses when it processes recipes |
1136 | intended for use in <filename>.bbappend</filename> files | 1117 | are defined by the |
1137 | to include any additional files provided in that layer. | 1118 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> |
1138 | You typically accomplish this with the following: | 1119 | variable, and can be extended using |
1120 | <filename>FILESEXTRAPATHS</filename>. | ||
1121 | By prepending paths in <filename>.bbappend</filename> | ||
1122 | files, you allow multiple append files that reside in | ||
1123 | different layers but are used for the same recipe to | ||
1124 | correctly extend the path. | ||
1125 | <note> | ||
1126 | Be sure to use the immediate expansion | ||
1127 | (<filename>:=</filename>) operator and include | ||
1128 | the trailing separating colon character. | ||
1129 | </note> | ||
1130 | Here is another example that specifically adds three paths: | ||
1139 | <literallayout class='monospaced'> | 1131 | <literallayout class='monospaced'> |
1140 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" | 1132 | FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" |
1141 | </literallayout> | 1133 | </literallayout> |
1142 | </para> | 1134 | </para> |
1143 | </glossdef> | 1135 | </glossdef> |