From: Georg Brandl <georg@python.org>
Date: Sat, 30 Sep 2006 12:03:02 +0000 (+0000)
Subject: Bug #1546052: clarify that PyString_FromString(AndSize) copies the
X-Git-Tag: v2.5.1c1~358
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0988904df8da8fc484d050127b8e77eb47bd1ab8;p=python

Bug #1546052: clarify that PyString_FromString(AndSize) copies the
string pointed to by its parameter.
 (backport from rev. 52078)
---

diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 34221ad3af..764c6aa90f 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -602,15 +602,15 @@ parameter and are called with a non-string parameter.
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{PyObject*}{PyString_FromString}{const char *v}
-  Return a new string object with the value \var{v} on success, and
-  \NULL{} on failure.  The parameter \var{v} must not be \NULL{}; it
-  will not be checked.
+  Return a new string object with a copy of the string \var{v} as value
+  on success, and \NULL{} on failure.  The parameter \var{v} must not be
+  \NULL{}; it will not be checked.
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{PyObject*}{PyString_FromStringAndSize}{const char *v,
                                                          Py_ssize_t len}
-  Return a new string object with the value \var{v} and length
-  \var{len} on success, and \NULL{} on failure.  If \var{v} is
+  Return a new string object with a copy of the string \var{v} as value
+  and length \var{len} on success, and \NULL{} on failure.  If \var{v} is
   \NULL{}, the contents of the string are uninitialized.
 \end{cfuncdesc}
 
diff --git a/Misc/NEWS b/Misc/NEWS
index c3cf131c04..424820d03e 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -163,6 +163,9 @@ Tests
 Documentation
 -------------
 
+- Bug #1546052: clarify that PyString_FromString(AndSize) copies the
+  string pointed to by its parameter.
+
 - Bug #1566663: remove obsolete example from datetime docs.
 
 - Bug #1541682: Fix example in the "Refcount details" API docs.