[3.14] gh-141004: Document `Py_MEMCPY` (GH-141676) (GH-141685)

gh-141004: Document `Py_MEMCPY` (GH-141676)
(cherry picked from commit 16ea9505ce690485bab38691e5a83f467757fc03)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index 04c4d7284ad4fd033aca3b439c67a60ed6a03358..37c1649124ea9c3aa2d56d51b4387c195a3b7e51 100644 (file)
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -183,6 +183,14 @@ complete listing.
 
    .. versionadded:: 3.6
 
+.. c:macro:: Py_MEMCPY(dest, src, n)
+
+   This is a :term:`soft deprecated` alias to :c:func:`!memcpy`.
+   Use :c:func:`!memcpy` directly instead.
+
+   .. deprecated:: 3.14
+      The macro is :term:`soft deprecated`.
+
 .. c:macro:: Py_MIN(x, y)
 
    Return the minimum value between ``x`` and ``y``.

diff --git a/Misc/NEWS.d/3.14.0a1.rst b/Misc/NEWS.d/3.14.0a1.rst
index 305a0b65b98e6aef7dc723f929f06fc765007730..1938976fa4226a4a0dbf5f01959c2c4a7313a128 100644 (file)
--- a/Misc/NEWS.d/3.14.0a1.rst
+++ b/Misc/NEWS.d/3.14.0a1.rst
@@ -6092,7 +6092,7 @@ Patch by Victor Stinner.
 .. nonce: qOr9GF
 .. section: C API
 
-Soft deprecate the :c:macro:`!Py_MEMCPY` macro: use directly ``memcpy()``
+Soft deprecate the :c:macro:`Py_MEMCPY` macro: use directly ``memcpy()``
 instead.  Patch by Victor Stinner.
 
 ..