aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Reid <dreid@dreid.org>2014-01-20 10:14:40 -0800
committerDavid Reid <dreid@dreid.org>2014-01-20 10:14:40 -0800
commitcd10571261ad24dcd0dc63c9703289faccd841a8 (patch)
tree5994b0a095af99749e05ee936f8932af9a86ff40 /docs
parent580e992dc0d95618d3e667e471dd1d6a7eb6e323 (diff)
parentad4f646e685beb38e597bab83ea8e8314a3fd581 (diff)
downloadcryptography-cd10571261ad24dcd0dc63c9703289faccd841a8.tar.gz
cryptography-cd10571261ad24dcd0dc63c9703289faccd841a8.tar.bz2
cryptography-cd10571261ad24dcd0dc63c9703289faccd841a8.zip
Merge pull request #468 from reaperhulk/backend-flag-pytest
Add backend flag for pytest runs
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst10
-rw-r--r--docs/hazmat/backends/openssl.rst6
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
-------------------------------