summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRichard Maw <richard.maw@gmail.com>2017-01-08 13:53:23 +0000
committerRichard Maw <richard.maw@gmail.com>2017-01-08 13:53:23 +0000
commit945647abcd428ae2cb355da0dbaee492b5c3fac1 (patch)
treef54e18f8d05a34cf2981da081ab613362cce4edf /doc
parent8839f3fd6eb916dcec43193551134b1c797f71c4 (diff)
downloadgitano-945647abcd428ae2cb355da0dbaee492b5c3fac1.tar.gz
admin-doc: Fill in variables table
Diffstat (limited to 'doc')
-rw-r--r--doc/admin/000.mdwn38
1 files changed, 32 insertions, 6 deletions
diff --git a/doc/admin/000.mdwn b/doc/admin/000.mdwn
index e4b7064..e6643ed 100644
--- a/doc/admin/000.mdwn
+++ b/doc/admin/000.mdwn
@@ -301,12 +301,38 @@ complete a table.
Table: Gitano variables
---------- -------- -------------------------------------------
-operation variable description
-all user Current Gitano user
-all group Current Gitano group
-most repository Which repository is being operated on
---------- -------- -------------------------------------------
+------------ ------------------- -----------------------------------------------------------------------
+operations variable description
+all operation The current operation being run.
+all source Protocol used to interact with Gitano. ("ssh" or "git").
+all user Current Gitano user or "gitano/anonymous".
+all config/\* Any set config key with "." replaced with "/".
+all as\_user Username of user invoking `as otheruser`.
+all keytag Name of SSH key user authorised with, or "" via HTTP.
+most repository Which repository is being operated on.
+most repository/$N Component N of the repository path when split by "/".
+most repository/basename Last component of the repository split by "/".
+most repository/dirname Components of repository split by "/" except for the last one.
+config key The key being modified or inspected.
+config set value The value to assign to the key.
+user modify targetuser User being created, renamed, deleted or modified.
+group modify targetgroup Group being modified
+group modify targetgroup/$N Component N of group when name is split by "-".
+group modify targetgroup/suffix Last component of group when name is split by "-".
+group modify targetgroup/prefix All but the last component of group when name is split by "-".
+group modify member User or group being added or removed from `targetgroup`.
+group modify member/$N Component N of user or group when name is split by "-".
+group modify member/suffix Last component of user or group when name is split by "-".
+group modify member/prefix All but the last component of user or group when name is split by "-".
+graveyard target Name of destination when restoring. Name of entry when purging.
+keyring list keyring Name of the keyring to be listed
+keyring keyringname Name of keyring being manipluated for everything except `keyring list`.
+ref update ref Name of the ref being updated.
+ref update newtype Object type of the new tip of the ref (i.e. "tag" or "commit").
+ref update oldtype Object type of the tip of the ref before the update.
+ref update newsha SHA1 Object ID of the new tip of the ref
+ref update oldsha SHA1 Object ID of the tip of the ref before the update.
+------------ ------------------- -----------------------------------------------------------------------
## Include statements in rulesets