From d721bae443fe020bf755d0440684a17b75de970f Mon Sep 17 00:00:00 2001 From: Allan McRae Date: Mon, 14 Dec 2015 20:23:26 +1000 Subject: 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 --- doc/alpm-hooks.5.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc') 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 = (Required, Repeatable) [Action] (Required) +Description = ... (Optional) When = PreTransaction|PostTransaction (Required) Exec = (Required) Depends = (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 to run. Command arguments are split on whitespace. Values containing whitespace should be enclosed in quotes. Required. -- cgit v1.2.3-24-g4f1b