]> granicus.if.org Git - python/commitdiff
Enhanced memory-reference information in the description of Py_BuildValue(),
authorFred Drake <fdrake@acm.org>
Wed, 28 Jun 2000 16:15:08 +0000 (16:15 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 28 Jun 2000 16:15:08 +0000 (16:15 +0000)
based on response from Frank Stajano <fstajano@uk.research.att.com>.

Doc/ext/ext.tex

index 8de315848082d7f3f9495dc415f5475a51fdae3b..4171da93630de2c63d9719677693f3ab13a7e498 100644 (file)
@@ -1004,7 +1004,11 @@ parenthesize the format string.
 When memory buffers are passed as parameters to supply data to build
 objects, as for the \samp{s} and \samp{s\#} formats, the required data
 is copied.  Buffers provided by the caller are never referenced by the
-objects created by \cfunction{Py_BuildValue()}.
+objects created by \cfunction{Py_BuildValue()}.  In other words, if
+your code invokes \cfunction{malloc()} and passes the allocated memory
+to \cfunction{Py_BuildValue()}, your code is responsible for
+calling \cfunction{free()} for that memory once
+\cfunction{Py_BuildValue()} returns.
 
 In the following description, the quoted form is the format unit; the
 entry in (round) parentheses is the Python object type that the format