Browse Source

[3720] Updates per review comments

Shawn Routhier 10 years ago
parent
commit
8c46266761
2 changed files with 13 additions and 11 deletions
  1. 6 5
      doc/guide/lfc.xml
  2. 7 6
      src/bin/lfc/kea-lfc.xml

+ 6 - 5
doc/guide/lfc.xml

@@ -14,8 +14,9 @@
       for the memfile data base backend. This service is written to run as a
       for the memfile data base backend. This service is written to run as a
       stand alone process.  
       stand alone process.  
       </para>
       </para>
-      <para>While <command>kea-lfc</command> can be started externally it should
-      be started by the Kea DHCP servers.
+      <para>While <command>kea-lfc</command> can be started externally, there is
+      usually no need to do this.  <command>kea-lfc</command> is run on a periodic
+      basis by the Kea DHCP servers.
       </para>
       </para>
       <para>The process operates on a set of files, using them for input and output
       <para>The process operates on a set of files, using them for input and output
       of the lease entries and to indicate where it is in the process in case of an
       of the lease entries and to indicate where it is in the process in case of an
@@ -44,8 +45,8 @@ kea-lfc [-4 | -6] -c config-file -p pid-file -x previous-file -i copy-file -o ou
       <para>The <command>-p</command> argument specifies the PID file. When the
       <para>The <command>-p</command> argument specifies the PID file. When the
       <command>kea-lfc</command> process starts it attempts to determine if another
       <command>kea-lfc</command> process starts it attempts to determine if another
       instance of the process is already running by examining the pid file.  If one
       instance of the process is already running by examining the pid file.  If one
-      is running it aborts the new process.  If one isn't running it writes its
-      pid into the pid file.
+      is already running the new process is terminated.  If one isn't running it writes
+      its pid into the pid file.
       </para>
       </para>
 
 
       <para>The other filenames specify where the <command>kea-lfc</command> process
       <para>The other filenames specify where the <command>kea-lfc</command> process
@@ -64,7 +65,7 @@ kea-lfc [-4 | -6] -c config-file -p pid-file -x previous-file -i copy-file -o ou
           <listitem><simpara>
           <listitem><simpara>
             <command>input</command> &mdash;
             <command>input</command> &mdash;
             Before the DHCP server invokes <command>kea-lfc</command> it will
             Before the DHCP server invokes <command>kea-lfc</command> it will
-            copy the current lease file here and then call <command>kea-lfc</command>
+            move the current lease file here and then call <command>kea-lfc</command>
             with this file.
             with this file.
           </simpara></listitem>
           </simpara></listitem>
 
 

+ 7 - 6
src/bin/lfc/kea-lfc.xml

@@ -64,8 +64,9 @@
       The <command>kea-lfc</command> service process removes redundant
       The <command>kea-lfc</command> service process removes redundant
       information from the files used to provide persistent storage for
       information from the files used to provide persistent storage for
       the memfile data base backend.  The service is written to run as
       the memfile data base backend.  The service is written to run as
-      a stand alone process.  While it can be started externally it
-      should be started by the Kea DHCP servers as desired and required.
+      a stand alone process.  While it can be started externally, there
+      is usually no need to do this.  It will be run on a periodic basis
+      by the Kea DHCP servers.
     </para>
     </para>
   </refsect1>
   </refsect1>
 
 
@@ -129,9 +130,9 @@
         <listitem><para>
         <listitem><para>
           PID file - When the <command>kea-lfc</command> process starts
           PID file - When the <command>kea-lfc</command> process starts
           it attempts to determine if another instance of the process is
           it attempts to determine if another instance of the process is
-          already running by examining the pid file.  If one is running
-          it aborts the new process.  If one isn't running it writes its
-          pid into the pid file.
+          already running by examining the pid file.  If one is already
+          running the new process is terminated.  If one isn't running it
+          writes its pid into the pid file.
         </para></listitem>
         </para></listitem>
       </varlistentry>
       </varlistentry>
 
 
@@ -150,7 +151,7 @@
         <term><option>-i</option></term>
         <term><option>-i</option></term>
         <listitem><para>
         <listitem><para>
           Input or copy of lease file - Before the DHCP server invokes
           Input or copy of lease file - Before the DHCP server invokes
-          <command>kea-lfc</command> it will copy the current lease file
+          <command>kea-lfc</command> it will move the current lease file
           here and then call <command>kea-lfc</command> with this file.
           here and then call <command>kea-lfc</command> with this file.
         </para></listitem>
         </para></listitem>
       </varlistentry>
       </varlistentry>