From 0d564a3d013287cf0880fdc3264f30c20fe6188d Mon Sep 17 00:00:00 2001
From: Richard Leach <richardleach@users.noreply.github.com>
Date: Mon, 5 Feb 2024 12:23:09 +0000
Subject: [PATCH] av.h - document new newAV_mortal macro

---
 av.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/av.h b/av.h
index 97af228574b0..b32e3b47a6bd 100644
--- a/av.h
+++ b/av.h
@@ -113,6 +113,7 @@ Note that there are both real and fake AVs; see the beginning of this file and
 'av.c'
 
 =for apidoc newAV
+=for apidoc newAV_mortal
 =for apidoc_item newAV_alloc_x
 =for apidoc_item newAV_alloc_xz
 
@@ -169,6 +170,11 @@ or implicitly when the first element is stored:
 
 Unused array elements are typically initialized by C<av_extend>.
 
+=item C<newAV_mortal> form
+
+This also creates the whole-array data structure, but also mortalises it.
+(That is to say, a reference to the AV is added to the C<temps> stack.)
+
 =item C<newAV_alloc_x> form
 
 This effectively does a C<newAV> followed by also allocating (uninitialized)