diff options
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 51 |
1 files changed, 30 insertions, 21 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 8da49b2793..81d3f2e8fc 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -228,9 +228,10 @@ | |||
228 | <glossdef> | 228 | <glossdef> |
229 | <para> | 229 | <para> |
230 | Identifies editable or configurable files that are part of a package. | 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 | 231 | If the Package Management System (PMS) is being used to update |
232 | the final image packaging, it is possible that files you want unchanged | 232 | packages on the target system, it is possible that |
233 | get overwritten. | 233 | configuration files you have changed after the original installation |
234 | and that you now want to remain unchanged are overwritten. | ||
234 | In other words, editable files might exist in the package that you do not | 235 | 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 | 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 | You can use the <filename>CONFFILES</filename> variable to list the files in the |
@@ -243,11 +244,11 @@ | |||
243 | <para> | 244 | <para> |
244 | To use the <filename>CONFFILES</filename> variable, provide a package name | 245 | To use the <filename>CONFFILES</filename> variable, provide a package name |
245 | override that identifies the package. | 246 | override that identifies the package. |
246 | Then, provide a list of space-separated files or paths that identify the | 247 | Then, provide a list of space-separated files that identify the |
247 | editable files you want the PMS to exclude from the update process. | 248 | editable files you want the PMS to exclude from the update process. |
248 | Here is an example: | 249 | Here is an example: |
249 | <literallayout class='monospaced'> | 250 | <literallayout class='monospaced'> |
250 | CONFFILES_${PN} += "/dir1/" "dir2/" "file1" "file2" | 251 | CONFFILES_${PN} += "${bindir}/file1 ${bindir}/file2" |
251 | </literallayout> | 252 | </literallayout> |
252 | </para> | 253 | </para> |
253 | 254 | ||
@@ -256,17 +257,19 @@ | |||
256 | <filename><link linkend='var-FILES'>FILES</link></filename> variables. | 257 | <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>CONFFILES</filename> must be a subset of |
258 | the files listed with <filename>FILES</filename>. | 259 | the files listed with <filename>FILES</filename>. |
259 | Because the files you provide with <filename>CONFFILES</filename> are simply | 260 | Because the configuration files you provide with <filename>CONFFILES</filename> |
260 | being identified so that the PMS will not overwrite them, it makes sense that | 261 | are simply being identified so that the PMS will not overwrite them, |
262 | it makes sense that | ||
261 | the files must already be included as part of the package through the | 263 | the files must already be included as part of the package through the |
262 | <filename>FILES</filename> variable. | 264 | <filename>FILES</filename> variable. |
263 | </para> | 265 | </para> |
264 | 266 | ||
265 | <note> | 267 | <note> |
266 | When specifying paths as part of the <filename>CONFFILES</filename> variable, | 268 | When specifying paths as part of the <filename>CONFFILES</filename> variable, |
267 | it is good practice to use the base, architecture-dependant, and | 269 | it is good practice to use appropriate path variables. |
268 | architecture-independant variables in the pathnames | 270 | For example, <filename>${sysconfdir}</filename> rather than |
269 | rather than hard-coding the pathnames. | 271 | <filename>/etc</filename> or <filename>${bindir}</filename> rather |
272 | than <filename>/usr/bin</filename>. | ||
270 | You can find a list of these variables at the top of the | 273 | 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 | 274 | <filename>/meta/conf/bitbake.conf</filename> file in the Yocto Project |
272 | files directory. | 275 | files directory. |
@@ -536,34 +539,40 @@ | |||
536 | <glossdef> | 539 | <glossdef> |
537 | <para> | 540 | <para> |
538 | The list of directories or files that are placed in packages. | 541 | 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> | 542 | </para> |
546 | 543 | ||
547 | <para> | 544 | <para> |
548 | To use the <filename>FILES</filename> variable, provide a package name | 545 | To use the <filename>FILES</filename> variable, provide a package name |
549 | override that identifies the package. | 546 | override that identifies the package. |
550 | Then, provide a list of space-separated files or paths that identify the | 547 | Then, provide a list of space-separated files or paths that identify the |
551 | files you want included as part of the package. | 548 | files you want included as part of the package. |
552 | Here is an example: | 549 | Here is an example: |
553 | <literallayout class='monospaced'> | 550 | <literallayout class='monospaced'> |
554 | FILES_${PN} += "/dir1/" "dir2/" "file1" "file2" | 551 | FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" |
555 | </literallayout> | 552 | </literallayout> |
556 | </para> | 553 | </para> |
557 | 554 | ||
558 | <note> | 555 | <note> |
559 | When specifying paths as part of the <filename>FILES</filename> variable, | 556 | When specifying paths as part of the <filename>FILES</filename> variable, |
560 | it is good practice to use the base, architecture-dependant, and | 557 | it is good practice to use appropriate path variables. |
561 | architecture-independant variables in the pathnames | 558 | For example, <filename>${sysconfdir}</filename> rather than |
562 | rather than hard-coding the pathnames. | 559 | <filename>/etc</filename> or <filename>${bindir}</filename> rather |
560 | than <filename>/usr/bin</filename>. | ||
563 | You can find a list of these variables at the top of the | 561 | 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 | 562 | <filename>/meta/conf/bitbake.conf</filename> file in the Yocto Project |
565 | files directory. | 563 | files directory. |
566 | </note> | 564 | </note> |
565 | |||
566 | <para> | ||
567 | If some of files you provide with the <filename>FILES</filename> variable | ||
568 | are editable and you know they should not be | ||
569 | overwritten during the package update process by the Package Management | ||
570 | System (PMS), you can identify these files so that the PMS will not | ||
571 | overwrite them. | ||
572 | See the <filename><link linkend='var-CONFFILES'>CONFFILES</link></filename> | ||
573 | variable for information on how to identify these files to the PMS. | ||
574 | </para> | ||
575 | |||
567 | </glossdef> | 576 | </glossdef> |
568 | </glossentry> | 577 | </glossentry> |
569 | 578 | ||