diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-11-29 23:48:33 -0600 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-11-29 23:48:33 -0600 |
| commit | e01eeb407aa77e6c8108bf08c85533d268a496bd (patch) | |
| tree | 0fdb0859ee5c48245b0c8ed224be9449a608c682 /docs | |
| parent | 745e512b283594d86aa5045503f5a797dabcd54c (diff) | |
| parent | 836955ff8d84c2ca4eedf2cb51cb364f6d31b595 (diff) | |
| download | cryptography-e01eeb407aa77e6c8108bf08c85533d268a496bd.tar.gz cryptography-e01eeb407aa77e6c8108bf08c85533d268a496bd.tar.bz2 cryptography-e01eeb407aa77e6c8108bf08c85533d268a496bd.zip | |
Merge pull request #1504 from reaperhulk/update-bindings-dev-docs
Update dev docs to add information regarding recompilation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/c-bindings.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/development/c-bindings.rst b/docs/development/c-bindings.rst index 56963379..10d5fc10 100644 --- a/docs/development/c-bindings.rst +++ b/docs/development/c-bindings.rst @@ -7,6 +7,10 @@ C bindings are bindings to C libraries, using cffi_ whenever possible. Bindings live in :py:mod:`cryptography.hazmat.bindings`. +When modifying the bindings you will need to recompile the C extensions to +test the changes. This can be accomplished with ``pip install -e .`` in the +project root. If you do not do this a ``RuntimeError`` will be raised. + Style guide ----------- |