[pypy-commit] cffi cffi-1.0: small doc fixes
arigo
noreply at buildbot.pypy.org
Sun May 17 12:38:06 CEST 2015
Author: Armin Rigo <arigo at tunes.org>
Branch: cffi-1.0
Changeset: r2029:82b840b44be9
Date: 2015-05-17 12:38 +0200
http://bitbucket.org/cffi/cffi/changeset/82b840b44be9/
Log: small doc fixes
diff --git a/doc/source/cdef.rst b/doc/source/cdef.rst
--- a/doc/source/cdef.rst
+++ b/doc/source/cdef.rst
@@ -101,6 +101,8 @@
in-line use), but also the extra methods described below (to prepare
the FFI).
+.. _`Using the ffi/lib objects`: using.html
+
The reason for this split of functionality is that a regular program
using CFFI out-of-line does not need to import the ``cffi`` pure
Python package at all. (Internally it still needs ``_cffi_backend``,
@@ -185,6 +187,8 @@
Also, this has no effect on structs declared with ``"...;"``---next
section.)
+.. _`ffi.set_unicode()`:
+
**ffi.set_unicode(enabled_flag)**: Windows: if ``enabled_flag`` is
True, enable the ``UNICODE`` and ``_UNICODE`` defines in C, and
declare the types ``TBYTE TCHAR LPCTSTR PCTSTR LPTSTR PTSTR PTBYTE
@@ -437,14 +441,16 @@
**ffi.include(other_ffi)**: includes the typedefs, structs, unions,
enums and constants defined in another FFI instance. This is meant
for large projects where one CFFI-based interface depends on some
-types or functions declared in a different CFFI-based interface.
+types declared in a different CFFI-based interface.
For out-of-line modules, the ``ffi.include(other_ffi)`` line should
occur in the build script, and the ``other_ffi`` argument should be
another FFI that comes from another build script. When the two build
scripts are turned into generated files, say ``_ffi.so`` and
``_other_ffi.so``, then importing ``_ffi.so`` will internally cause
-``_other_ffi.so`` to be imported.
+``_other_ffi.so`` to be imported. At that point, the real
+declarations from ``_other_ffi.so`` are combined with the real
+declarations from ``_ffi.so``.
The usage of ``ffi.include()`` is the cdef-level equivalent of a
``#include`` in C, where a part of the program might include types and
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -79,11 +79,11 @@
* The documentation below might be sketchy on details; for now the
ultimate reference is given by the tests, notably
- `_cffi1/test_verify1.py`_ and `_cffi1/test_new_ffi_1.py`_.
+ `testing/cffi1/test_verify1.py`_ and `testing/cffi0/backend_tests.py`_.
.. _`demo`: https://bitbucket.org/cffi/cffi/src/default/demo
-.. _`cffi1/test_verify1.py`: https://bitbucket.org/cffi/cffi/src/default/_cffi1/test_verify1.py
-.. _`testing/test_verify.py`: https://bitbucket.org/cffi/cffi/src/default/_cffi1/test_new_ffi_1.py
+.. _`testing/cffi1/test_verify1.py`: https://bitbucket.org/cffi/cffi/src/default/testing/cffi1/test_verify1.py
+.. _`testing/cffi0/backend_tests.py`: https://bitbucket.org/cffi/cffi/src/default/testing/cffi0/backend_tests.py
Platform-specific instructions
diff --git a/doc/source/overview.rst b/doc/source/overview.rst
--- a/doc/source/overview.rst
+++ b/doc/source/overview.rst
@@ -41,8 +41,6 @@
there, %s!\n"``. In general it is ``somestring.encode(myencoding)``.
-.. _out-of-line-abi:
-
Out-of-line example (ABI level, out-of-line)
--------------------------------------------
More information about the pypy-commit
mailing list