summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNiels Thykier <niels@thykier.net>2015-05-20 22:14:14 +0200
committerNiels Thykier <niels@thykier.net>2015-05-20 22:14:14 +0200
commitbdb3a1f1e12b272dcff0f8d5fff3e2b499f19ec0 (patch)
tree7d4a530ba220d7d5c2daccbcd00038f825bff037 /doc
parent2932c0deffb3b6ef5142c1d43bd61848b6197a84 (diff)
downloaddebhelper-bdb3a1f1e12b272dcff0f8d5fff3e2b499f19ec0.tar.gz
Dh_Lib: Promote error_exitcode to an API sub
Signed-off-by: Niels Thykier <niels@thykier.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/PROGRAMMING6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index bca2312a..36eb88ea 100644
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -173,6 +173,12 @@ nonquiet_print($message)
error($errormsg)
Pass this command a string, it will output it to standard error and
exit.
+error_exitcode($cmd)
+ Pass this subroutine a string (representing a command line), it will
+ output a message describing that the command failed to standard error
+ and exit. Note that this relies on the value of $? to produce a
+ meaningful error message. Even if $? is 0, this /will/ still terminate
+ the program (although with a rather unhelpful message).
warning($message)
Pass this command a string, and it will output it to standard error
as a warning message.