From 2502ce599b39509ba9c05b6e553527e5ed5ac43c Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sat, 18 Jan 2014 09:32:47 -0600 Subject: docs for explicit backend selection and document name attribute of backend --- docs/contributing.rst | 10 ++++++++++ docs/hazmat/backends/openssl.rst | 6 +++++- 2 files changed, 15 insertions(+), 1 deletion(-) (limited to 'docs') 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 ------------------------------- -- cgit v1.2.3 From 5882361dbd8b0f6f9c7933b173bc933cbd90097a Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:31:35 -0600 Subject: update docs for name attribute --- docs/hazmat/backends/openssl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 042ee87d..b0bd3ae0 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -9,9 +9,9 @@ The `OpenSSL`_ C library. This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - The string name of the backend. + Returns ``openssl``, the string name of this backend. Using your own OpenSSL on Linux ------------------------------- -- cgit v1.2.3 From cfa2d6275e9c31e6fc61109e4853c5687d16532e Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 14:01:25 -0600 Subject: fix docs --- docs/hazmat/backends/openssl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index b0bd3ae0..a1f2d28a 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -9,9 +9,9 @@ The `OpenSSL`_ C library. This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - Returns ``openssl``, the string name of this backend. + The string name of this backend: ``"openssl"`` Using your own OpenSSL on Linux ------------------------------- -- cgit v1.2.3 From ad4f646e685beb38e597bab83ea8e8314a3fd581 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Mon, 20 Jan 2014 09:36:57 -0600 Subject: expand tox backend example --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/contributing.rst b/docs/contributing.rst index 3710abee..4bb1461d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -258,7 +258,7 @@ 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``. +``tox -- --backend=openssl``. Building Documentation ~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3