path: root/funcs/func_lock.c
diff options
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2007-07-31 18:50:06 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2007-07-31 18:50:06 +0000
commitb835899f3017076bbdc98650b08ac0ba46afad45 (patch)
tree2a574126c6c2bbaf246aaaf2e18546178ef39e40 /funcs/func_lock.c
parent38dc225767b6ebb7ac99bccd99514403e98d7ffa (diff)
Add some documentation detailing an aspect of dialplan functions, as requested by Russell
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@77838 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'funcs/func_lock.c')
1 files changed, 3 insertions, 2 deletions
diff --git a/funcs/func_lock.c b/funcs/func_lock.c
index 477f1c1aa..e9ac0651b 100644
--- a/funcs/func_lock.c
+++ b/funcs/func_lock.c
@@ -200,8 +200,9 @@ static struct ast_custom_function unlock_function = {
.name = "UNLOCK",
.synopsis = "Unlocks a named mutex",
.desc =
-"Unlocks a previously locked mutex. Returns 1 if the channel had a lock\n"
-"or 0 otherwise.\n",
+"Unlocks a previously locked mutex. Note that it is generally unnecessary to\n"
+"unlock in a hangup routine, as any lock held is automatically freed when the\n"
+"channel is destroyed. Returns 1 if the channel had a lock or 0 otherwise.\n",
.syntax = "UNLOCK()",
.read = unlock_read,