[Patches] [ python-Patches-702933 ] Kill off docs for unsafe macros

[SourceForge.net]

Patches item #702933, was opened at 2003-03-13 08:10
Message generated for change (Comment added) made by david_abrahams
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=702933&group_id=5470

Category: Documentation
Group: Python 2.3
>Status: Open
Resolution: None
Priority: 5
Submitted By: David Abrahams (david_abrahams)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Kill off docs for unsafe macros

Initial Comment:
I'll also attach the patch, but a message body is 
required:
=========================================
==========================
RCS 
file: /cvsroot/python/python/dist/src/Doc/api/memory.tex,
v
retrieving revision 1.2
diff -w -u -r1.2 memory.tex
--- memory.tex	6 Apr 2002 09:14:33 -0000
	1.2
+++ memory.tex	13 Mar 2003 12:56:26 -0000
@@ -195,9 +195,7 @@
 In addition to the functions aimed at handling raw 
memory blocks from
 the Python heap, objects in Python are allocated and 
released with
 \cfunction{PyObject_New()}, \cfunction
{PyObject_NewVar()} and
-\cfunction{PyObject_Del()}, or with their corresponding 
macros
-\cfunction{PyObject_NEW()}, \cfunction
{PyObject_NEW_VAR()} and
-\cfunction{PyObject_DEL()}.
+\cfunction{PyObject_Del()}.
 
 These will be explained in the next chapter on defining 
and
 implementing new object types in C.
Index: newtypes.tex
=========================================
==========================
RCS 
file: /cvsroot/python/python/dist/src/Doc/api/newtypes.te
x,v
retrieving revision 1.21
diff -w -u -r1.21 newtypes.tex
--- newtypes.tex	10 Feb 2003 19:18:21 -0000
	1.21
+++ newtypes.tex	13 Mar 2003 12:56:27 -0000
@@ -62,23 +62,6 @@
   after this call as the memory is no longer a valid 
Python object.
 \end{cfuncdesc}
 
-\begin{cfuncdesc}{\var{TYPE}*}{PyObject_NEW}{TYPE, 
PyTypeObject *type}
-  Macro version of \cfunction{PyObject_New()}, to gain 
performance at
-  the expense of safety.  This does not check \var{type} 
for a \NULL{}
-  value.
-\end{cfuncdesc}
-
-\begin{cfuncdesc}{\var{TYPE}*}{PyObject_NEW_VAR}
{TYPE, PyTypeObject *type,
-                                                int size}
-  Macro version of \cfunction{PyObject_NewVar()}, to 
gain performance
-  at the expense of safety.  This does not check \var
{type} for a
-  \NULL{} value.
-\end{cfuncdesc}
-
-\begin{cfuncdesc}{void}{PyObject_DEL}{PyObject *op}
-  Macro version of \cfunction{PyObject_Del()}.
-\end{cfuncdesc}
-
 \begin{cfuncdesc}{PyObject*}{Py_InitModule}{char 
*name,
                                             PyMethodDef *methods}
   Create a new module object based on a name and 
table of functions,


----------------------------------------------------------------------

>Comment By: David Abrahams (david_abrahams)
Date: 2003-07-03 21:37

Message:
Logged In: YES 
user_id=52572

I've forgotten, frankly.  You might check python-dev around 
this date.  Seems like Guido may have agreed that these 
macros were really not meant to be touched by users and 
shouild be deprecated, but I don't recall.

----------------------------------------------------------------------

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2003-07-03 20:00

Message:
Logged In: YES 
user_id=3066

I'm not sure what you're suggesting with this patch.  Could
you explain the intention?

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=702933&group_id=5470