summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatěj Cepl <mcepl@cepl.eu>2017-10-07 19:46:27 +0200
committerMatěj Cepl <mcepl@cepl.eu>2017-10-07 21:14:26 +0200
commit232b457ec2e9896d4b205f894a7ba333e8811116 (patch)
tree0be1290337dd572ad6d9ec453db6f28cc076990d /doc
parent35f5e5c3e735a27c6af552744ae3dbdeab819c6a (diff)
downloadm2crypto-232b457ec2e9896d4b205f894a7ba333e8811116.tar.gz
Remove all PGP modules.
Fixes #182. Reasoning for the change was: I think we are just lying to ourselves when we keep PGP module in the repository. 1. It is not used. Over a year, there is ``DeprecationWarning`` asking anybody who uses the module to contact me. Nobody ever did. Even the previous maintainer of M2Crypto [did not know how to use it](https://stackoverflow.com/a/1042139/164233), and that was 2009. Whole Stack Overflow is full of vague comments like “hopefully M2Crypto.PGP will help you”, but I have not found on DuckDuckGo one example of use of M2Crypto.PGP 2. The main point of M2Crypto is to be Python bindings for OpenSSL. And truly most of the other M2Crypto code is just a tiny wrapper around C functions. That is not so with M2Crypto.PGP. It is basically reimplementation of PGP keys manipulation functions with Python with rather large set of Python objects and complicated computations. There are very few calls to any C code at all and most work is done by series of Python functions. And, obviously, PGP != OpenSSL. 3. There is very tiny test suite for M2Crypto.PGP. It is basically just running ``PGP.load_pubring()``, which does exercise a lot of the module, but certainly it is far from the rigorous unit testing. 4. And of course, it is completely broken under Python 3, and I have no idea how to fix it (especially given 1. I don't want to spend too much time on it).
Diffstat (limited to 'doc')
-rw-r--r--doc/M2Crypto.PGP.rst51
-rw-r--r--doc/M2Crypto.rst1
-rw-r--r--doc/doctrees/M2Crypto.SSL.doctreebin349777 -> 296531 bytes
-rw-r--r--doc/doctrees/M2Crypto.doctreebin1257651 -> 1082506 bytes
-rw-r--r--doc/doctrees/ZServerSSL-HOWTO.doctreebin49245 -> 49205 bytes
-rw-r--r--doc/doctrees/environment.picklebin459094 -> 442226 bytes
-rw-r--r--doc/doctrees/howto.ca.doctreebin51373 -> 51341 bytes
-rw-r--r--doc/doctrees/howto.smime.doctreebin94672 -> 94635 bytes
-rw-r--r--doc/doctrees/howto.ssl.doctreebin22402 -> 22375 bytes
-rw-r--r--doc/doctrees/index.doctreebin7232 -> 7200 bytes
10 files changed, 0 insertions, 52 deletions
diff --git a/doc/M2Crypto.PGP.rst b/doc/M2Crypto.PGP.rst
deleted file mode 100644
index 5396b5d..0000000
--- a/doc/M2Crypto.PGP.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-PGP Package
-===========
-
-:mod:`PGP` Package
-------------------
-
-.. automodule:: M2Crypto.PGP
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`PublicKey` Module
------------------------
-
-.. automodule:: M2Crypto.PGP.PublicKey
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`PublicKeyRing` Module
----------------------------
-
-.. automodule:: M2Crypto.PGP.PublicKeyRing
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`RSA` Module
------------------
-
-.. automodule:: M2Crypto.PGP.RSA
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`constants` Module
------------------------
-
-.. automodule:: M2Crypto.PGP.constants
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`packet` Module
---------------------
-
-.. automodule:: M2Crypto.PGP.packet
- :members:
- :undoc-members:
- :show-inheritance:
-
diff --git a/doc/M2Crypto.rst b/doc/M2Crypto.rst
index 31a03ad..dc6c706 100644
--- a/doc/M2Crypto.rst
+++ b/doc/M2Crypto.rst
@@ -214,6 +214,5 @@ Subpackages
.. toctree::
- M2Crypto.PGP
M2Crypto.SSL
diff --git a/doc/doctrees/M2Crypto.SSL.doctree b/doc/doctrees/M2Crypto.SSL.doctree
index 3ccda5f..c613ca6 100644
--- a/doc/doctrees/M2Crypto.SSL.doctree
+++ b/doc/doctrees/M2Crypto.SSL.doctree
Binary files differ
diff --git a/doc/doctrees/M2Crypto.doctree b/doc/doctrees/M2Crypto.doctree
index 73f49b8..b195fd4 100644
--- a/doc/doctrees/M2Crypto.doctree
+++ b/doc/doctrees/M2Crypto.doctree
Binary files differ
diff --git a/doc/doctrees/ZServerSSL-HOWTO.doctree b/doc/doctrees/ZServerSSL-HOWTO.doctree
index 3c2a9fc..a807552 100644
--- a/doc/doctrees/ZServerSSL-HOWTO.doctree
+++ b/doc/doctrees/ZServerSSL-HOWTO.doctree
Binary files differ
diff --git a/doc/doctrees/environment.pickle b/doc/doctrees/environment.pickle
index d4e74d6..0068ff7 100644
--- a/doc/doctrees/environment.pickle
+++ b/doc/doctrees/environment.pickle
Binary files differ
diff --git a/doc/doctrees/howto.ca.doctree b/doc/doctrees/howto.ca.doctree
index 124cf99..25d7aae 100644
--- a/doc/doctrees/howto.ca.doctree
+++ b/doc/doctrees/howto.ca.doctree
Binary files differ
diff --git a/doc/doctrees/howto.smime.doctree b/doc/doctrees/howto.smime.doctree
index 3329844..dde291f 100644
--- a/doc/doctrees/howto.smime.doctree
+++ b/doc/doctrees/howto.smime.doctree
Binary files differ
diff --git a/doc/doctrees/howto.ssl.doctree b/doc/doctrees/howto.ssl.doctree
index 438b79b..6032ac5 100644
--- a/doc/doctrees/howto.ssl.doctree
+++ b/doc/doctrees/howto.ssl.doctree
Binary files differ
diff --git a/doc/doctrees/index.doctree b/doc/doctrees/index.doctree
index 281514e..ddb7340 100644
--- a/doc/doctrees/index.doctree
+++ b/doc/doctrees/index.doctree
Binary files differ