| 1 |
commit: fac405678163d6b19db1c4a230724e663474f619 |
| 2 |
Author: André Erdmann <dywi <AT> mailerd <DOT> de> |
| 3 |
AuthorDate: Tue Apr 1 16:35:12 2014 +0000 |
| 4 |
Commit: André Erdmann <dywi <AT> mailerd <DOT> de> |
| 5 |
CommitDate: Tue Apr 1 16:36:37 2014 +0000 |
| 6 |
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=fac40567 |
| 7 |
|
| 8 |
doc/html: update |
| 9 |
|
| 10 |
--- |
| 11 |
doc/html/usage.html | 16 ++++++++++++++-- |
| 12 |
1 file changed, 14 insertions(+), 2 deletions(-) |
| 13 |
|
| 14 |
diff --git a/doc/html/usage.html b/doc/html/usage.html |
| 15 |
index ffc3d5f..2892bcb 100644 |
| 16 |
--- a/doc/html/usage.html |
| 17 |
+++ b/doc/html/usage.html |
| 18 |
@@ -2946,12 +2946,21 @@ when included in the hook script, most of the enviroment variables readonly.</p> |
| 19 |
<tr><td>DEVNULL</td> |
| 20 |
<td><em>/dev/null</em> target (could also be a file)</td> |
| 21 |
</tr> |
| 22 |
+<tr><td>EX_OK</td> |
| 23 |
+<td><em>success</em> exit code</td> |
| 24 |
+</tr> |
| 25 |
<tr><td>EX_ERR</td> |
| 26 |
<td>default error exit code</td> |
| 27 |
</tr> |
| 28 |
<tr><td>EX_ARG_ERR</td> |
| 29 |
<td>default exit code for arg errors</td> |
| 30 |
</tr> |
| 31 |
+<tr><td>EX_CANNOT_RUN</td> |
| 32 |
+<td><p class="first">default exit code when a hook cannot run, |
| 33 |
+e.g. if an essential program is missing</p> |
| 34 |
+<p class="last">Defaults to <tt class="docutils literal">$EX_OK</tt>.</p> |
| 35 |
+</td> |
| 36 |
+</tr> |
| 37 |
<tr><td>EX_GIT_ERR |
| 38 |
EX_GIT_ADD_ERR |
| 39 |
EX_GIT_COMMIT_ERR |
| 40 |
@@ -2999,6 +3008,9 @@ function files</td> |
| 41 |
# @noreturn die ( [message], [exit_code] ), raises exit() |
| 42 |
# Lets the script die with the given message/exit code. |
| 43 |
# |
| 44 |
+# @noreturn die_cannot_run ( [reason] ), raises die (**EX_CANNOT_RUN) |
| 45 |
+# Lets the script die due to missing preconditions. |
| 46 |
+# |
| 47 |
# @noreturn OUT_OF_BOUNDS(), raises die() |
| 48 |
# Lets the script die due to insufficient arg count. |
| 49 |
# |
| 50 |
@@ -3023,7 +3035,7 @@ function files</td> |
| 51 |
# Returns 0 if $word is in the given list, else 1. |
| 52 |
# |
| 53 |
# int qwhich ( *command ) |
| 54 |
-# Returns 0 if all listed commands are found by "which", else 1. |
| 55 |
+# Returns 0 if all listed commands could be found, else 1. |
| 56 |
# |
| 57 |
# int sync_allowed ( action_name, [msg_nosync], [msg_sync] ) |
| 58 |
# Returns 0 if syncing for the given action is allowed, else 1. |
| 59 |
@@ -5038,7 +5050,7 @@ becomes "loop until resolver closes".</p> |
| 60 |
</div> |
| 61 |
<div class="footer"> |
| 62 |
<hr class="footer" /> |
| 63 |
-Generated on: 2014-02-21. |
| 64 |
+Generated on: 2014-04-01. |
| 65 |
|
| 66 |
</div> |
| 67 |
</body> |
Archives