diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-20 13:38:36 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-20 13:38:36 -0600 |
| commit | 1de55b76b12d7ade3e19f2c8e094695201d1523f (patch) | |
| tree | 2e4537ec44634106da56a0bf38beab667e480dc4 /docs | |
| parent | 5ab6a208c46f1de6e261646a0ad34482ea755922 (diff) | |
| parent | cd10571261ad24dcd0dc63c9703289faccd841a8 (diff) | |
| download | cryptography-1de55b76b12d7ade3e19f2c8e094695201d1523f.tar.gz cryptography-1de55b76b12d7ade3e19f2c8e094695201d1523f.tar.bz2 cryptography-1de55b76b12d7ade3e19f2c8e094695201d1523f.zip | |
Merge branch 'master' into commoncrypto-cipher-backend
* master:
expand tox backend example
On OS X at build time compile the CC bindings
fix docs
update docs for name attribute
revert fixture decorator for now, switch to append. no more globals
docs for explicit backend selection and document name attribute of backend
modify backend selection to allow multiple backends via comma delimiter
better name for the variable
don't mutate _ALL_BACKENDS
pass posargs via tox so --backend can be used for tox envs
support --backend as a pytest flag to limit to one backend for testing
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.rst | 10 | ||||
| -rw-r--r-- | docs/hazmat/backends/openssl.rst | 6 |
2 files changed, 15 insertions, 1 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 8e32c368..4bb1461d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -250,6 +250,16 @@ each supported Python version and run the tests. For example: You may not have all the required Python versions installed, in which case you will see one or more ``InterpreterNotFound`` errors. + +Explicit Backend Selection +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +While testing you may want to run tests against a subset of the backends that +cryptography supports. Explicit backend selection can be done via the +``--backend`` flag. This flag should be passed to ``py.test`` with a comma +delimited list of backend names. To use it with ``tox`` you must pass it as +``tox -- --backend=openssl``. + Building Documentation ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 404573a3..a1f2d28a 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -7,7 +7,11 @@ The `OpenSSL`_ C library. .. data:: cryptography.hazmat.backends.openssl.backend - This is the exposed API for the OpenSSL backend. It has no public attributes. + This is the exposed API for the OpenSSL backend. It has one public attribute. + + .. attribute:: name + + The string name of this backend: ``"openssl"`` Using your own OpenSSL on Linux ------------------------------- |