summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorFather Chrysostomos <sprout@cpan.org>2012-07-03 13:55:47 -0700
committerFather Chrysostomos <sprout@cpan.org>2012-07-03 14:01:06 -0700
commitf7e029ab097e17f08984143868ba5b33f51ec9d7 (patch)
tree1248b23a04f16ef41c1e41e7e7ca992f32b8a4df /sv.h
parent8c2f25b1be8766a42e2af6baa3f19e83fb74005c (diff)
downloadperl-f7e029ab097e17f08984143868ba5b33f51ec9d7.tar.gz
sv.h: Improve docs of Sv[GS]ETMAGIC
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/sv.h b/sv.h
index c708ae5ec6..1eeda1cc5d 100644
--- a/sv.h
+++ b/sv.h
@@ -1923,11 +1923,14 @@ incremented.
=head1 Magical Functions
=for apidoc Am|void|SvGETMAGIC|SV* sv
-Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
+Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
+will call C<FETCH> on a tied variable. This macro evaluates its
argument more than once.
=for apidoc Am|void|SvSETMAGIC|SV* sv
-Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
+Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
+after modifying a scalar, in case it is a magical variable like C<$|>
+or a tied variable (it calls C<STORE>). This macro evaluates its
argument more than once.
=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv