From fac405678163d6b19db1c4a230724e663474f619 Mon Sep 17 00:00:00 2001 From: André Erdmann Date: Tue, 1 Apr 2014 18:35:12 +0200 Subject: doc/html: update --- doc/html/usage.html | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/html/usage.html b/doc/html/usage.html index ffc3d5f..2892bcb 100644 --- a/doc/html/usage.html +++ b/doc/html/usage.html @@ -2946,12 +2946,21 @@ when included in the hook script, most of the enviroment variables readonly.

DEVNULL /dev/null target (could also be a file) +EX_OK +success exit code + EX_ERR default error exit code EX_ARG_ERR default exit code for arg errors +EX_CANNOT_RUN +

default exit code when a hook cannot run, +e.g. if an essential program is missing

+

Defaults to $EX_OK.

+ + EX_GIT_ERR EX_GIT_ADD_ERR EX_GIT_COMMIT_ERR @@ -2999,6 +3008,9 @@ function files # @noreturn die ( [message], [exit_code] ), raises exit() # Lets the script die with the given message/exit code. # +# @noreturn die_cannot_run ( [reason] ), raises die (**EX_CANNOT_RUN) +# Lets the script die due to missing preconditions. +# # @noreturn OUT_OF_BOUNDS(), raises die() # Lets the script die due to insufficient arg count. # @@ -3023,7 +3035,7 @@ function files # Returns 0 if $word is in the given list, else 1. # # int qwhich ( *command ) -# Returns 0 if all listed commands are found by "which", else 1. +# Returns 0 if all listed commands could be found, else 1. # # int sync_allowed ( action_name, [msg_nosync], [msg_sync] ) # Returns 0 if syncing for the given action is allowed, else 1. @@ -5038,7 +5050,7 @@ becomes "loop until resolver closes".

-Generated on: 2014-02-21. +Generated on: 2014-04-01.
-- cgit v1.2.3-65-gdbad