aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Stapleton <alexs@prol.etari.at>2014-03-14 20:03:12 +0000
committerAlex Stapleton <alexs@prol.etari.at>2014-03-24 09:46:47 +0000
commita39a319b096b1b2b1775ae1a91117c19422a6c81 (patch)
treeda7d4dbf73d815f835dcf38a4d62d73b742480d2 /docs
parent68e77c752b94c2531f83589c1bb2060c5ed0d886 (diff)
downloadcryptography-a39a319b096b1b2b1775ae1a91117c19422a6c81.tar.gz
cryptography-a39a319b096b1b2b1775ae1a91117c19422a6c81.tar.bz2
cryptography-a39a319b096b1b2b1775ae1a91117c19422a6c81.zip
Move cryptography.vectors to cryptography_vectors
All vectors are now stored in the subpackage in the vectors/ folder. This package is automatically installed by setup.py test and will also be uploaded with a matching version number by the PyPI upload task.
Diffstat (limited to 'docs')
-rw-r--r--docs/development/test-vectors.rst12
-rw-r--r--docs/doing-a-release.rst4
2 files changed, 12 insertions, 4 deletions
diff --git a/docs/development/test-vectors.rst b/docs/development/test-vectors.rst
index 164d0abd..c5ea8152 100644
--- a/docs/development/test-vectors.rst
+++ b/docs/development/test-vectors.rst
@@ -2,10 +2,14 @@ Test vectors
============
Testing the correctness of the primitives implemented in each ``cryptography``
-backend requires trusted test vectors. Where possible these vectors are obtained
-from official sources such as `NIST`_ or `IETF`_ RFCs. When this is not possible
-``cryptography`` has chosen to create a set of custom vectors using an official
-vector file as input to verify consistency between implemented backends.
+backend requires trusted test vectors. Where possible these vectors are
+obtained from official sources such as `NIST`_ or `IETF`_ RFCs. When this is
+not possible ``cryptography`` has chosen to create a set of custom vectors
+using an official vector file as input to verify consistency between
+implemented backends.
+
+Vectors are kept in the `cryptography_vectors` package rather than within our
+main test suite.
Sources
-------
diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst
index 8b37df78..fc88a91c 100644
--- a/docs/doing-a-release.rst
+++ b/docs/doing-a-release.rst
@@ -10,6 +10,7 @@ The first step in doing a release is bumping the version number in the
software.
* Update the version number in ``cryptography/__about__.py``.
+* Update the version number in ``vectors/cryptography_vectors/__about__.py``.
* Set the release date in the :doc:`/changelog`.
* Do a commit indicating this.
* Send a pull request with this.
@@ -33,5 +34,8 @@ correctly:
>>> import cryptography
>>> cryptography.__version__
'...'
+ >>> import cryptography_vectors
+ >>> cryptography_vectors.__version__
+ '...'
Verify that this is the version you just released.