summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAllan McRae <allan@archlinux.org>2015-12-14 20:23:26 +1000
committerAllan McRae <allan@archlinux.org>2015-12-15 20:15:02 +1000
commitd721bae443fe020bf755d0440684a17b75de970f (patch)
tree971187b77dedb5d02c535ca5237be5b19fa9a388 /doc
parent760bea543211673884c254b7e0c44e0f70fe2257 (diff)
alpm-hooks: add Description field
The "Description" field allows a hook to provide a some text for frontends to use in describing what the hook is doing. For example: Description = updating info page directory Signed-off-by: Allan McRae <allan@archlinux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/alpm-hooks.5.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/alpm-hooks.5.txt b/doc/alpm-hooks.5.txt
index 3729387c..f33ff8cd 100644
--- a/doc/alpm-hooks.5.txt
+++ b/doc/alpm-hooks.5.txt
@@ -19,6 +19,7 @@ Type = File|Package (Required)
Target = <Path|PkgName> (Required, Repeatable)
[Action] (Required)
+Description = ... (Optional)
When = PreTransaction|PostTransaction (Required)
Exec = <Command> (Required)
Depends = <PkgName> (Optional)
@@ -63,6 +64,10 @@ defined the hook will run if the transaction matches *any* of the triggers.
ACTIONS
-------
+* Description =* ...::
+ An optional description that describes the action being taken by the
+ hook for use in front-end output.
+
*Exec =* <command>::
Command to run. Command arguments are split on whitespace. Values
containing whitespace should be enclosed in quotes. Required.