From e71d0af563ba22f5be6c9740de418f4113334657 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Thu, 2 Feb 2012 09:47:06 -0600
Subject: 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>
---
 documentation/poky-ref-manual/ref-variables.xml | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 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 0d9f0c696d..d526981a1e 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -235,28 +235,25 @@
                     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 <filename>CONFFILES</filename> variable to list the files in the 
-                    package that wish to prevent PMS from overwriting during this update process.
-                    The <filename>CONFFILES</filename> variable essentially tells the PMS about 
-                    files in the package that you do not want updated as part of the package 
-                    update process.
+                    package that you wish to prevent the PMS from overwriting during this update process.
                 </para>
 
                 <para>  
                     To use the <filename>CONFFILES</filename> variable, provide a package name
                     override that identifies the package.
-                    Then, provide a list of space-separated files that identify the 
-                    editable files you want the PMS to exclude from the update process.
+                    Then, provide a space-separated list of files.
                     Here is an example:
                     <literallayout class='monospaced'>                       
-  CONFFILES_${PN} += "${bindir}/file1 ${bindir}/file2"
+  CONFFILES_${PN} += "${sysconfdir}/file1 \
+     ${sysconfdir}/file2 ${sysconfdir}/file3"
                     </literallayout>
                 </para>
 
                 <para>
                     A relationship exists between the <filename>CONFFILES</filename> and 
                     <filename><link linkend='var-FILES'>FILES</link></filename> variables.
-                    The files listed with <filename>CONFFILES</filename> must be a subset of 
-                    the files listed with <filename>FILES</filename>.
+                    The files listed within <filename>CONFFILES</filename> must be a subset of 
+                    the files listed within <filename>FILES</filename>.
                     Because the configuration files you provide with <filename>CONFFILES</filename> 
                     are simply being identified so that the PMS will not overwrite them, 
                     it makes sense that
@@ -538,7 +535,7 @@
                 <para>
                     To use the <filename>FILES</filename> 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 space-separated list of files or paths that identifies the 
                     files you want included as part of the package.
                     Here is an example:
                     <literallayout class='monospaced'>                       
@@ -558,7 +555,7 @@
                 </note>
 
                 <para>
-                    If some of files you provide with the <filename>FILES</filename> variable
+                    If some of the files you provide with the <filename>FILES</filename> 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 
-- 
cgit v1.2.3-54-g00ecf