summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-02 09:47:06 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:07:48 -0800
commite71d0af563ba22f5be6c9740de418f4113334657 (patch)
tree2c26b5fee124cf060a8ef6d9d0866a8f6b962259 /documentation/poky-ref-manual
parent7a5fa3397401c80b56e8d878cc1416059287f2b3 (diff)
downloadpoky-e71d0af563ba22f5be6c9740de418f4113334657.tar.gz
documentation/poky-ref-manual/ref-variables.xml: CONFFILES and FILES edits
Final edits to the new CONFFILES entry and an updated more robust FILES entry in the glossary. These two entries are good examples of the depth of detail we should have for all glossary entries. Kudos to Paul Eggleton for tirelessly working with me to get the descriptions just right. Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com> (From yocto-docs rev: 88e9836a964a9057aaf6ac472b4fb09981a069ac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml19
1 files changed, 8 insertions, 11 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 0d9f0c696d..d526981a1e 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -235,28 +235,25 @@
235 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
236 want reset as part of the package update process. 236 want reset as part of the package update process.
237 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
238 package that wish to prevent PMS from overwriting during this update process. 238 package that you wish to prevent the PMS from overwriting during this update process.
239 The <filename>CONFFILES</filename> variable essentially tells the PMS about
240 files in the package that you do not want updated as part of the package
241 update process.
242 </para> 239 </para>
243 240
244 <para> 241 <para>
245 To use the <filename>CONFFILES</filename> variable, provide a package name 242 To use the <filename>CONFFILES</filename> variable, provide a package name
246 override that identifies the package. 243 override that identifies the package.
247 Then, provide a list of space-separated files that identify the 244 Then, provide a space-separated list of files.
248 editable files you want the PMS to exclude from the update process.
249 Here is an example: 245 Here is an example:
250 <literallayout class='monospaced'> 246 <literallayout class='monospaced'>
251 CONFFILES_${PN} += "${bindir}/file1 ${bindir}/file2" 247 CONFFILES_${PN} += "${sysconfdir}/file1 \
248 ${sysconfdir}/file2 ${sysconfdir}/file3"
252 </literallayout> 249 </literallayout>
253 </para> 250 </para>
254 251
255 <para> 252 <para>
256 A relationship exists between the <filename>CONFFILES</filename> and 253 A relationship exists between the <filename>CONFFILES</filename> and
257 <filename><link linkend='var-FILES'>FILES</link></filename> variables. 254 <filename><link linkend='var-FILES'>FILES</link></filename> variables.
258 The files listed with <filename>CONFFILES</filename> must be a subset of 255 The files listed within <filename>CONFFILES</filename> must be a subset of
259 the files listed with <filename>FILES</filename>. 256 the files listed within <filename>FILES</filename>.
260 Because the configuration files you provide with <filename>CONFFILES</filename> 257 Because the configuration files you provide with <filename>CONFFILES</filename>
261 are simply being identified so that the PMS will not overwrite them, 258 are simply being identified so that the PMS will not overwrite them,
262 it makes sense that 259 it makes sense that
@@ -538,7 +535,7 @@
538 <para> 535 <para>
539 To use the <filename>FILES</filename> variable, provide a package name 536 To use the <filename>FILES</filename> variable, provide a package name
540 override that identifies the package. 537 override that identifies the package.
541 Then, provide a list of space-separated files or paths that identify the 538 Then, provide a space-separated list of files or paths that identifies the
542 files you want included as part of the package. 539 files you want included as part of the package.
543 Here is an example: 540 Here is an example:
544 <literallayout class='monospaced'> 541 <literallayout class='monospaced'>
@@ -558,7 +555,7 @@
558 </note> 555 </note>
559 556
560 <para> 557 <para>
561 If some of files you provide with the <filename>FILES</filename> variable 558 If some of the files you provide with the <filename>FILES</filename> variable
562 are editable and you know they should not be 559 are editable and you know they should not be
563 overwritten during the package update process by the Package Management 560 overwritten during the package update process by the Package Management
564 System (PMS), you can identify these files so that the PMS will not 561 System (PMS), you can identify these files so that the PMS will not