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 @@ + CONFFILES + + + Identifies editable or configurable files that are part of a package. + If the Package Management System (PMS) is updating packages as part of + the final image packaging, it is possible that files you want unchanged + get overwritten. + In other words, editable files might exist in the package that you do not + want reset as part of the package update process. + You can use the CONFFILES variable to list the files in the + package that wish to prevent PMS from overwriting during this update process. + The CONFFILES variable essentially tells the PMS about + files in the package that you do not want updated as part of the package + update process. + + + + To use the CONFFILES variable, provide a package name + override that identifies the package. + Then, provide a list of space-separated files or paths that identify the + editable files you want the PMS to exclude from the update process. + Here is an example: + + CONFFILES_${PN} += "/dir1/" "dir2/" "file1" "file2" + + + + + A relationship exists between the CONFFILES and + FILES variables. + The files listed with CONFFILES must be a subset of + the files listed with FILES. + Because the files you provide with CONFFILES are simply + being identified so that the PMS will not overwrite them, it makes sense that + the files must already be included as part of the package through the + FILES variable. + + + + When specifying paths as part of the CONFFILES variable, + it is good practice to use the base, architecture-dependant, and + architecture-independant variables in the pathnames + rather than hard-coding the pathnames. + You can find a list of these variables at the top of the + /meta/conf/bitbake.conf file in the Yocto Project + files directory. + + + + CONFIG_SITE @@ -484,7 +534,36 @@ FILES - The list of directories or files that are placed in packages. + + The list of directories or files that are placed in packages. + If some of these files are editable and you know they should not be + overwritten during the package update process by the Package Management + System (PMS), you can identify these files so that the PMS will not + overwrite them. + See the CONFFILES + variable for information on how to identify these files to the PMS. + + + + To use the FILES variable, provide a package name + override that identifies the package. + Then, provide a list of space-separated files or paths that identify the + files you want included as part of the package. + Here is an example: + + FILES_${PN} += "/dir1/" "dir2/" "file1" "file2" + + + + + When specifying paths as part of the FILES variable, + it is good practice to use the base, architecture-dependant, and + architecture-independant variables in the pathnames + rather than hard-coding the pathnames. + You can find a list of these variables at the top of the + /meta/conf/bitbake.conf file in the Yocto Project + files directory. +