summaryrefslogtreecommitdiff
path: root/av.h
diff options
context:
space:
mode:
authorRichard Leach <richardleach@users.noreply.github.com>2021-08-23 23:14:04 +0100
committerKarl Williamson <khw@cpan.org>2021-08-27 07:11:48 -0600
commit7073dfe33acab50441f1ffe4774e121e882e7277 (patch)
tree915f74385083fbc4efdf0c4f5a0e5892f980031e /av.h
parent4762e1f88cc9ef2d1223b060db61846ba24eff35 (diff)
downloadperl-7073dfe33acab50441f1ffe4774e121e882e7277.tar.gz
av.h: document that backrefs lists are fake AVs
Diffstat (limited to 'av.h')
-rw-r--r--av.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/av.h b/av.h
index 8c8d6ced49..23902b41e9 100644
--- a/av.h
+++ b/av.h
@@ -23,10 +23,11 @@ struct xpvav {
* Such AVs may be referred to as "real" AVs. Examples include regular
* perl arrays, tiedarrays (since v5.16), and padlist AVs.
*
- * Some things like "@_" (unless tied) and the scratchpad list do not set
- * SVpav_REAL, to indicate that they are cheating (for efficiency) by not
- * refcounting the AV's contents or ensuring that all elements are safe for
- * arbitrary access. This type of AV may be referred to as "fake" AVs.
+ * Some things do not set SVpav_REAL, to indicate that they are cheating
+ * (for efficiency) by not refcounting the AV's contents or ensuring that
+ * all elements are safe for arbitrary access. This type of AV may be
+ * referred to as "fake" AVs. Examples include "@_" (unless tied), the
+ * scratchpad list, and the backrefs list on an object or stash.
*
* SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL
* is not set). It indicates that the fake AV is capable of becoming