From 05542e5ff0366fb2a7bdf9530cf716c530253fa1 Mon Sep 17 00:00:00 2001
From: Jason Kincl <kincljc@ornl.gov>
Date: Fri, 30 Aug 2013 14:35:51 -0400
Subject: doc: Updated Client Actions doc to include BoundActions and another
 example schemas: Fixed Action `when` attribute description

---
 doc/client/tools/actions.txt | 24 ++++++++++++++++++++----
 schemas/types.xsd            |  9 +++++----
 2 files changed, 25 insertions(+), 8 deletions(-)

diff --git a/doc/client/tools/actions.txt b/doc/client/tools/actions.txt
index 81486ecd1..e5fdb1f39 100644
--- a/doc/client/tools/actions.txt
+++ b/doc/client/tools/actions.txt
@@ -31,10 +31,11 @@ central reporting of action failure is desired, set this attribute to
 'check'. Also note that Action entries included in Base will not be
 executed.
 
-Actions cannot be completely defined inside of a bundle; they are a bound
-entry, much like Packages, Services or Paths. The Rules plugin can bind
-these entries. For example to include the above action in a bundle,
-first the Action entry must be included in the bundle:
+Actions may be completely defined inside of a bundle with the use of 
+:ref:`server-configurationentries`, much like Packages, Services or Paths. 
+The Rules plugin can also bind these entries. For example to include the 
+above action in a bundle, first the Action entry must be included in the 
+bundle:
 
 .. code-block:: xml
 
@@ -70,3 +71,18 @@ requires this key.
         <Action timing='post' name='apt-key-update' command='apt-key adv --recv-keys --keyserver hkp://pgp.mit.edu 0C5A2783' when='modified' status='check'/>
       </Group>
     </Rules>
+
+Example BoundAction (add RPM GPG keys)
+======================================
+
+This example will add the RPM-GPG-KEY-redhat-release key to the RPM
+GPG keyring **before** Package entries are handled on the client run.
+
+.. code-block:: xml
+
+    <Bundle name="rpm-gpg-keys">
+      <Group name='rhel'>
+        <Path name="/etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release"/>
+        <BoundAction timing="pre" name="install rpm key" command="rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release" when="modified" status="check"/>
+      </Group>
+    </Bundle>
diff --git a/schemas/types.xsd b/schemas/types.xsd
index 4e3dfd70f..17b7f05f0 100644
--- a/schemas/types.xsd
+++ b/schemas/types.xsd
@@ -122,7 +122,10 @@
     <xsd:attribute type='ActionTimingEnum' name='timing'>
       <xsd:annotation>
         <xsd:documentation>
-          When the action is run.
+          When the action is run. Actions with "pre" timing are run
+          after important entries have been installed and before
+          bundle entries are installed. Actions with "post" timing
+          are run after bundle entries are installed.
         </xsd:documentation>
       </xsd:annotation>
     </xsd:attribute>
@@ -130,9 +133,7 @@
       <xsd:annotation>
         <xsd:documentation>
           If the action is always run, or is only run when a bundle
-          has been modified.  Actions that run before bundle
-          installation ("pre" and "both") ignore the setting of
-          ``when`` and are always run regardless.
+          has been modified.  
         </xsd:documentation>
       </xsd:annotation>
     </xsd:attribute>
-- 
cgit v1.2.3-1-g7c22