summaryrefslogtreecommitdiff
path: root/pod/perlfunc.pod
diff options
context:
space:
mode:
authorFather Chrysostomos <sprout@cpan.org>2011-07-20 23:57:04 -0700
committerFather Chrysostomos <sprout@cpan.org>2011-07-20 23:57:04 -0700
commit904028df2142182d347e16fc663545daf1b31fd8 (patch)
tree5f0d9a6610a89ef5718caabe18ccda93cc792824 /pod/perlfunc.pod
parentf4df43b5ee48f8f744bf0e51a622822865e03c4b (diff)
downloadperl-904028df2142182d347e16fc663545daf1b31fd8.tar.gz
Document lock’s retval
Diffstat (limited to 'pod/perlfunc.pod')
-rw-r--r--pod/perlfunc.pod3
1 files changed, 3 insertions, 0 deletions
diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index 936d1c0b93..94bc8d726c 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -3082,6 +3082,9 @@ X<lock>
This function places an advisory lock on a shared variable or referenced
object contained in I<THING> until the lock goes out of scope.
+The value returned is the scalar itself, if the argument is a scalar, or a
+reference, if the argument is a hash or array.
+
lock() is a "weak keyword" : this means that if you've defined a function
by this name (before any calls to it), that function will be called
instead. If you are not under C<use threads::shared> this does nothing.