summaryrefslogtreecommitdiff
path: root/Master/tlpkg/tlperl/lib/pods/perlmroapi.pod
diff options
context:
space:
mode:
Diffstat (limited to 'Master/tlpkg/tlperl/lib/pods/perlmroapi.pod')
-rw-r--r--Master/tlpkg/tlperl/lib/pods/perlmroapi.pod8
1 files changed, 6 insertions, 2 deletions
diff --git a/Master/tlpkg/tlperl/lib/pods/perlmroapi.pod b/Master/tlpkg/tlperl/lib/pods/perlmroapi.pod
index 2200becded2..74bd9b2a77d 100644
--- a/Master/tlpkg/tlperl/lib/pods/perlmroapi.pod
+++ b/Master/tlpkg/tlperl/lib/pods/perlmroapi.pod
@@ -54,8 +54,12 @@ function - the parameter is provided to allow your implementation to track
depth if it needs to recurse.
The function should return a reference to an array containing the parent
-classes in order. The caller is responsible for incrementing the reference
-count if it wants to keep the structure. Hence if you have created a
+classes in order. The names of the classes should be the result of calling
+C<HvENAME()> on the stash. In those cases where C<HvENAME()> returns null,
+C<HvNAME()> should be used instead.
+
+The caller is responsible for incrementing the reference count of the array
+returned if it wants to keep the structure. Hence, if you have created a
temporary value that you keep no pointer to, C<sv_2mortal()> to ensure that
it is disposed of correctly. If you have cached your return value, then
return a pointer to it without changing the reference count.