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

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,
 };