summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorArmin Rigo <arigo@tunes.org>2012-08-12 13:14:58 +0200
committerArmin Rigo <arigo@tunes.org>2012-08-12 13:14:58 +0200
commit046850e98943601ab2ff2f727a895e63bd10fb6d (patch)
tree22ef864d3e1c58c307042c43d1ec35a99d74c62b /doc/source
parentaafb5762fa0a6e19d24428bcd1a07f47eaa21fdc (diff)
downloadcffi-046850e98943601ab2ff2f727a895e63bd10fb6d.tar.gz
Fix the documentation: the module file names are no longer based
on the MD5 but on the CRC of the input strings.
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/index.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 336e2aa..9a47603 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -306,7 +306,8 @@ Cleaning up the __pycache__ directory
During development, every time you change the C sources that you pass to
``cdef()`` or ``verify()``, then the latter will create a new module
-file name, based on the MD5 hash of these strings. This creates more
+file name, based on two CRC32 hashes computed from these strings.
+This creates more
and more files in the ``__pycache__`` directory. It is recommended that
you clean it up from time to time. A nice way to do that is to add, in
your test suite, a call to ``cffi.verifier.cleanup_tmpdir()``.
@@ -1069,13 +1070,13 @@ can be instantiated directly. It is normally instantiated for you by
``Verifier`` objects have the following public attributes and methods:
- ``sourcefilename``: name of a C file. Defaults to
- ``__pycache__/_cffi_MD5HASH.c``, with the ``MD5HASH`` part computed
+ ``__pycache__/_cffi_CRCHASH.c``, with the ``CRCHASH`` part computed
from the strings you passed to cdef() and verify() as well as the
version numbers of Python and CFFI. Can be changed before calling
``write_source()`` if you want to write the source somewhere else.
- ``modulefilename``: name of the ``.so`` file (or ``.pyd`` on Windows).
- Defaults to ``__pycache__/_cffi_MD5HASH.so``. Can be changed before
+ Defaults to ``__pycache__/_cffi_CRCHASH.so``. Can be changed before
calling ``compile_module()``.
- ``get_module_name()``: extract the module name from ``modulefilename``.