diff options
author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-18 09:32:47 -0600 |
---|---|---|
committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-18 09:32:47 -0600 |
commit | 2502ce599b39509ba9c05b6e553527e5ed5ac43c (patch) | |
tree | d669e366d2206073bca754478ac0f001b35700ca /docs | |
parent | c421e636b15768e1adaf8bf681ecdd12b96c8669 (diff) | |
download | cryptography-2502ce599b39509ba9c05b6e553527e5ed5ac43c.tar.gz cryptography-2502ce599b39509ba9c05b6e553527e5ed5ac43c.tar.bz2 cryptography-2502ce599b39509ba9c05b6e553527e5ed5ac43c.zip |
docs for explicit backend selection and document name attribute of backend
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..3710abee 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 +``-- --backend``. + Building Documentation ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 404573a3..042ee87d 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 the backend. Using your own OpenSSL on Linux ------------------------------- |