diff options
| author |   André Erdmann <dywi@mailerd.de> | 2014-04-01 18:35:12 +0200 |
|---|---|---|
| committer | André Erdmann <dywi@mailerd.de> | 2014-04-01 18:36:37 +0200 |
| commit | fac405678163d6b19db1c4a230724e663474f619 (patch) | |
| tree | e151f84e894983588142134e12288f8eeda4304b /doc | |
| parent | bin/scripts/genfiles: minor doc update (diff) | |
| download | R_overlay-fac405678163d6b19db1c4a230724e663474f619.tar.gz R_overlay-fac405678163d6b19db1c4a230724e663474f619.tar.bz2 R_overlay-fac405678163d6b19db1c4a230724e663474f619.zip | |
doc/html: update
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/usage.html | 16 |
1 files changed, 14 insertions, 2 deletions
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.</p> <tr><td>DEVNULL</td> <td><em>/dev/null</em> target (could also be a file)</td> </tr> +<tr><td>EX_OK</td> +<td><em>success</em> exit code</td> +</tr> <tr><td>EX_ERR</td> <td>default error exit code</td> </tr> <tr><td>EX_ARG_ERR</td> <td>default exit code for arg errors</td> </tr> +<tr><td>EX_CANNOT_RUN</td> +<td><p class="first">default exit code when a hook cannot run, +e.g. if an essential program is missing</p> +<p class="last">Defaults to <tt class="docutils literal">$EX_OK</tt>.</p> +</td> +</tr> <tr><td>EX_GIT_ERR EX_GIT_ADD_ERR EX_GIT_COMMIT_ERR @@ -2999,6 +3008,9 @@ function files</td> # @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</td> # 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".</p> </div> <div class="footer"> <hr class="footer" /> -Generated on: 2014-02-21. +Generated on: 2014-04-01. </div> </body> |