Change: icktool.mdwn to document current actions and behaviour

1 files changed, 23 insertions, 6 deletions

diff --git a/icktool.mdwn b/icktool.mdwn
index 7224f65..95fbcf0 100644
--- a/icktool.mdwn
+++ b/icktool.mdwn
@@ -174,7 +174,8 @@ The worker manager defines (at least) the following actions:
 * `shell: snippet`
 
     Run `snippet` using the shell. The cwd is the workspace. The shell
-    function `params` outputs all parameters.
+    function `params` outputs all parameters as JSON. The `jq` tool
+    can be used to extract the value of a specific parameter.
 
 * `python: snippet`
 
@@ -214,16 +215,25 @@ The worker manager defines (at least) the following actions:
     underscore in the name. The artifact will be named using the value
     of the `debian_packages` project parameter.
 
+* `archive: systree`
+
+    This is identical to `archive: workspace`, except it archives the
+    system tree instead of the workspace.
+
 * `action: populate_systree`
 
-    Get the artifact named by `systree_name` and unpack it as the
-    systree. If the artifact is a valid operating system tree, later
-    actions can be run in containers.
+    Get an artifact, from the artifact store, and unpack it as the
+    systree. The artifact is assumed to be a compressed tar archive.
+    The name of the artifact comes from the `systree_name` parameter,
+    or the parameter named in the `name_from` field.
+
+    If the artifact does not exist, end the build with failure.
 
 * `action: populate_workspace`
 
-    Get the artifact named by `workspace_name` and unpack it into the
-    workspace. If no such artifact exists, do nothing.
+    Identical to `action: populate_systree`, except it unpacks to the
+    workspace. The default parameter name is `workspace_name`. If the
+    artifact does not exist, do nothing.
 
 * `action: git`
 
@@ -285,6 +295,13 @@ The worker manager defines (at least) the following actions:
     This should be run on the host, to have network access and use of
     the worker's ssh key.
 
+* `action: notify`
+
+    Use the notification service to send notifications of the current
+    state of the build. You usually don't need to use these actions
+    manually, the controller adds a notification action automatically
+    when a build ends.
+
 
 Notifications
 -----------------------------------------------------------------------------