Changeset 391 for python/trunk/Doc/c-api/cobject.rst

Timestamp:

Mar 19, 2014, 11:31:01 PM (11 years ago)

Author:

dmik

Message:

python: Merge vendor 2.7.6 to trunk.

Location:

python/trunk

Files:

• . (modified) (1 prop)
• Doc/c-api/cobject.rst (modified) (2 diffs)

python/trunk/Doc/c-api/cobject.rst

@@ -8 +8 @@
 .. index:: object: CObject
 
-Refer to :ref:`using-cobjects` for more information on using these objects.
 
+.. warning::
 
-.. ctype:: PyCObject
+   The CObject API is deprecated as of Python 2.7.  Please switch to the new
+   :ref:`capsules` API.
 
-   This subtype of :ctype:`PyObject` represents an opaque value, useful for C
-   extension modules who need to pass an opaque value (as a :ctype:`void\*`
+.. c:type:: PyCObject
+
+   This subtype of :c:type:`PyObject` represents an opaque value, useful for C
+   extension modules who need to pass an opaque value (as a :c:type:`void\*`
    pointer) through Python code to other C code.  It is often used to make a C
    function pointer defined in one module available to other modules, so the
@@ -21 +24 @@
 
 
-.. cfunction:: int PyCObject_Check(PyObject *p)
+.. c:function:: int PyCObject_Check(PyObject *p)
 
-   Return true if its argument is a :ctype:`PyCObject`.
+   Return true if its argument is a :c:type:`PyCObject`.
 
 
-.. cfunction:: PyObject* PyCObject_FromVoidPtr(void* cobj, void (*destr)(void *))
+.. c:function:: PyObject* PyCObject_FromVoidPtr(void* cobj, void (*destr)(void *))
 
-   Create a :ctype:`PyCObject` from the ``void *`` *cobj*.  The *destr* function
+   Create a :c:type:`PyCObject` from the ``void *`` *cobj*.  The *destr* function
    will be called when the object is reclaimed, unless it is *NULL*.
 
 
-.. cfunction:: PyObject* PyCObject_FromVoidPtrAndDesc(void* cobj, void* desc, void (*destr)(void *, void *))
+.. c:function:: PyObject* PyCObject_FromVoidPtrAndDesc(void* cobj, void* desc, void (*destr)(void *, void *))
 
-   Create a :ctype:`PyCObject` from the :ctype:`void \*` *cobj*.  The *destr*
+   Create a :c:type:`PyCObject` from the :c:type:`void \*` *cobj*.  The *destr*
    function will be called when the object is reclaimed. The *desc* argument can
    be used to pass extra callback data for the destructor function.
 
 
-.. cfunction:: void* PyCObject_AsVoidPtr(PyObject* self)
+.. c:function:: void* PyCObject_AsVoidPtr(PyObject* self)
 
-   Return the object :ctype:`void \*` that the :ctype:`PyCObject` *self* was
+   Return the object :c:type:`void \*` that the :c:type:`PyCObject` *self* was
    created with.
 
 
-.. cfunction:: void* PyCObject_GetDesc(PyObject* self)
+.. c:function:: void* PyCObject_GetDesc(PyObject* self)
 
-   Return the description :ctype:`void \*` that the :ctype:`PyCObject` *self* was
+   Return the description :c:type:`void \*` that the :c:type:`PyCObject` *self* was
    created with.
 
 
-.. cfunction:: int PyCObject_SetVoidPtr(PyObject* self, void* cobj)
+.. c:function:: int PyCObject_SetVoidPtr(PyObject* self, void* cobj)
 
-   Set the void pointer inside *self* to *cobj*. The :ctype:`PyCObject` must not
+   Set the void pointer inside *self* to *cobj*. The :c:type:`PyCObject` must not
    have an associated destructor. Return true on success, false on failure.