summaryrefslogtreecommitdiffstats
path: root/doc/client/tools/actions.txt
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-12-10 17:19:54 -0600
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-12-10 17:22:38 -0600
commit9d6e6241954d001a5b49e4ea9a48c10e2a792958 (patch)
tree270309c0e04eacf2ce1e0d6cc6d61f1485899c0a /doc/client/tools/actions.txt
parent7dcb468f09781bacf79823748ef12bfbd1faeb21 (diff)
downloadbcfg2-9d6e6241954d001a5b49e4ea9a48c10e2a792958.tar.gz
bcfg2-9d6e6241954d001a5b49e4ea9a48c10e2a792958.tar.bz2
bcfg2-9d6e6241954d001a5b49e4ea9a48c10e2a792958.zip
generate XML schema docs from XML schemas themselves
Diffstat (limited to 'doc/client/tools/actions.txt')
-rw-r--r--doc/client/tools/actions.txt22
1 files changed, 3 insertions, 19 deletions
diff --git a/doc/client/tools/actions.txt b/doc/client/tools/actions.txt
index 49488dfbe..81486ecd1 100644
--- a/doc/client/tools/actions.txt
+++ b/doc/client/tools/actions.txt
@@ -23,24 +23,7 @@ so they can be centrally observed. Actions look like:
status='ignore|check'
build='true|false'/>
-+-----------+------------------+-------------------------------------------+
-| Attribute | Values | Meaning |
-+===========+==================+===========================================+
-| timing | pre, post, both | When the action is run |
-+-----------+------------------+-------------------------------------------+
-| name | freeform | action name |
-+-----------+------------------+-------------------------------------------+
-| command | freeform | command text |
-+-----------+------------------+-------------------------------------------+
-| when | always, modified | If the action is always run, or only when |
-| | | a bundle should be or has been modified |
-+-----------+------------------+-------------------------------------------+
-| status | ignore, check | If the return code of the action |
-| | | should be reported or not |
-+-----------+------------------+-------------------------------------------+
-| build | true, false | Also execute the action in build mode |
-| | | (default: true) |
-+-----------+------------------+-------------------------------------------+
+.. xml:type:: ActionType
Note that the status attribute tells the bcfg2 client to ignore
return status, causing failures to still not be centrally reported. If
@@ -65,7 +48,8 @@ Then a corresponding entry must be included in the Rules directory, like:
.. code-block:: xml
<Rules priority='0'>
- <Action timing='post' when='modified' name='action_name' command='/path/to/command arg1 arg2' status='ignore'/>
+ <Action timing='post' when='modified' name='action_name'
+ command='/path/to/command arg1 arg2' status='ignore'/>
</Rules>
This allows different clients to get different actions as a part of the