diff options
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 81 |
1 files changed, 80 insertions, 1 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index b4964b3935..5b23076533 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -224,6 +224,56 @@ | |||
224 | </glossdef> | 224 | </glossdef> |
225 | </glossentry> | 225 | </glossentry> |
226 | 226 | ||
227 | <glossentry id='var-CONFFILES'><glossterm>CONFFILES</glossterm> | ||
228 | <glossdef> | ||
229 | <para> | ||
230 | Identifies editable or configurable files that are part of a package. | ||
231 | If the Package Management System (PMS) is updating packages as part of | ||
232 | the final image packaging, it is possible that files you want unchanged | ||
233 | get overwritten. | ||
234 | In other words, editable files might exist in the package that you do not | ||
235 | want reset as part of the package update process. | ||
236 | You can use the <filename>CONFFILES</filename> variable to list the files in the | ||
237 | package that wish to prevent PMS from overwriting during this update process. | ||
238 | The <filename>CONFFILES</filename> variable essentially tells the PMS about | ||
239 | files in the package that you do not want updated as part of the package | ||
240 | update process. | ||
241 | </para> | ||
242 | |||
243 | <para> | ||
244 | To use the <filename>CONFFILES</filename> variable, provide a package name | ||
245 | override that identifies the package. | ||
246 | Then, provide a list of space-separated files or paths that identify the | ||
247 | editable files you want the PMS to exclude from the update process. | ||
248 | Here is an example: | ||
249 | <literallayout class='monospaced'> | ||
250 | CONFFILES_${PN} += "/dir1/" "dir2/" "file1" "file2" | ||
251 | </literallayout> | ||
252 | </para> | ||
253 | |||
254 | <para> | ||
255 | A relationship exists between the <filename>CONFFILES</filename> and | ||
256 | <filename><link linkend='var-FILES'>FILES</link></filename> variables. | ||
257 | The files listed with <filename>CONFFILES</filename> must be a subset of | ||
258 | the files listed with <filename>FILES</filename>. | ||
259 | Because the files you provide with <filename>CONFFILES</filename> are simply | ||
260 | being identified so that the PMS will not overwrite them, it makes sense that | ||
261 | the files must already be included as part of the package through the | ||
262 | <filename>FILES</filename> variable. | ||
263 | </para> | ||
264 | |||
265 | <note> | ||
266 | When specifying paths as part of the <filename>CONFFILES</filename> variable, | ||
267 | it is good practice to use the base, architecture-dependant, and | ||
268 | architecture-independant variables in the pathnames | ||
269 | rather than hard-coding the pathnames. | ||
270 | You can find a list of these variables at the top of the | ||
271 | <filename>/meta/conf/bitbake.conf</filename> file in the Yocto Project | ||
272 | files directory. | ||
273 | </note> | ||
274 | </glossdef> | ||
275 | </glossentry> | ||
276 | |||
227 | <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> | 277 | <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> |
228 | <glossdef> | 278 | <glossdef> |
229 | <para> | 279 | <para> |
@@ -484,7 +534,36 @@ | |||
484 | 534 | ||
485 | <glossentry id='var-FILES'><glossterm>FILES</glossterm> | 535 | <glossentry id='var-FILES'><glossterm>FILES</glossterm> |
486 | <glossdef> | 536 | <glossdef> |
487 | <para>The list of directories or files that are placed in packages.</para> | 537 | <para> |
538 | The list of directories or files that are placed in packages. | ||
539 | If some of these files are editable and you know they should not be | ||
540 | overwritten during the package update process by the Package Management | ||
541 | System (PMS), you can identify these files so that the PMS will not | ||
542 | overwrite them. | ||
543 | See the <filename><link linkend='var-CONFFILES'>CONFFILES</link></filename> | ||
544 | variable for information on how to identify these files to the PMS. | ||
545 | </para> | ||
546 | |||
547 | <para> | ||
548 | To use the <filename>FILES</filename> variable, provide a package name | ||
549 | override that identifies the package. | ||
550 | Then, provide a list of space-separated files or paths that identify the | ||
551 | files you want included as part of the package. | ||
552 | Here is an example: | ||
553 | <literallayout class='monospaced'> | ||
554 | FILES_${PN} += "/dir1/" "dir2/" "file1" "file2" | ||
555 | </literallayout> | ||
556 | </para> | ||
557 | |||
558 | <note> | ||
559 | When specifying paths as part of the <filename>FILES</filename> variable, | ||
560 | it is good practice to use the base, architecture-dependant, and | ||
561 | architecture-independant variables in the pathnames | ||
562 | rather than hard-coding the pathnames. | ||
563 | You can find a list of these variables at the top of the | ||
564 | <filename>/meta/conf/bitbake.conf</filename> file in the Yocto Project | ||
565 | files directory. | ||
566 | </note> | ||
488 | </glossdef> | 567 | </glossdef> |
489 | </glossentry> | 568 | </glossentry> |
490 | 569 | ||