From 8769a255d767d6f2151246570789ec80fa3cfc53 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 1 Feb 2012 12:46:08 -0600 Subject: documentation/poky-ref-manual/ref-variables.xml: Edits to CONFFILES and FILES Second editing pass to these glossary entries based on Paul Eggleton's review. Reported-by: Paul Eggleton (From yocto-docs rev: 690043a7b239479c948e1219dcb44751570cc624) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-variables.xml | 51 +++++++++++++++---------- 1 file changed, 30 insertions(+), 21 deletions(-) (limited to 'documentation/poky-ref-manual/ref-variables.xml') 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 @@ 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. + If the Package Management System (PMS) is being used to update + packages on the target system, it is possible that + configuration files you have changed after the original installation + and that you now want to remain unchanged are 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 @@ -243,11 +244,11 @@ 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 + Then, provide a list of space-separated files 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" + CONFFILES_${PN} += "${bindir}/file1 ${bindir}/file2" @@ -256,17 +257,19 @@ 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 + Because the configuration 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. + it is good practice to use appropriate path variables. + For example, ${sysconfdir} rather than + /etc or ${bindir} rather + than /usr/bin. You can find a list of these variables at the top of the /meta/conf/bitbake.conf file in the Yocto Project files directory. @@ -536,34 +539,40 @@ 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" + FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" 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. + it is good practice to use appropriate path variables. + For example, ${sysconfdir} rather than + /etc or ${bindir} rather + than /usr/bin. You can find a list of these variables at the top of the /meta/conf/bitbake.conf file in the Yocto Project files directory. + + + If some of files you provide with the FILES variable + 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. + + -- cgit v1.2.3-54-g00ecf