diff options
author | Ben McGinnes <[email protected]> | 2018-03-08 03:13:00 +0000 |
---|---|---|
committer | Ben McGinnes <[email protected]> | 2018-03-08 03:13:00 +0000 |
commit | e8adab68f8c0cd865ff220f06dfaff7fe183e8a1 (patch) | |
tree | f02489f1c786133f18a06e28980484d7faae3208 /lang/python | |
parent | GPL compatible license for documentation (diff) | |
download | gpgme-e8adab68f8c0cd865ff220f06dfaff7fe183e8a1.tar.gz gpgme-e8adab68f8c0cd865ff220f06dfaff7fe183e8a1.zip |
doc: Added multiple TODOs for inclusion in the HOWTO
* Some instructions to include are fairly obvious; as with encryption,
decryption and signature verification.
* Some are a little less obvious.
* This includes the requests received to specifically include subkey
management (adding and revoking subkeys on a primary key that's
being retained.
* Added the UID equivalents to the list, as well as key selection
matters (and may or may not include something for handling group
lines since that involves wrapping a CLI binary).
* Key control documentation and examples requested by Mike Ingle of
confidantmail.org.
Diffstat (limited to 'lang/python')
-rw-r--r-- | lang/python/docs/TODO.org | 44 |
1 files changed, 43 insertions, 1 deletions
diff --git a/lang/python/docs/TODO.org b/lang/python/docs/TODO.org index 4e067df8..897c617a 100644 --- a/lang/python/docs/TODO.org +++ b/lang/python/docs/TODO.org @@ -28,11 +28,13 @@ to produce reST versions via Pandoc and DITA XML can be reached through converting to either Markdown or XHTML first. -** TODO Documentation HOWTO +** STARTED Documentation HOWTO :PROPERTIES: :CUSTOM_ID: todo-docs-howto :END: + - State "STARTED" from "TODO" [2018-03-08 Thu 13:59] \\ + Started yesterday. Write a HOWTO style guide for the current Python bindings. *** DONE Start python bindings HOWTO @@ -41,6 +43,46 @@ :CUSTOM_ID: howto-start :END: +*** TODO Include certain specific instructions in the HOWTO + :PROPERTIES: + :CUSTOM_ID: howto-requests + :END: + + Some functions can be worked out from the handful of examples + available, but many more can't and I've already begun receiving + requests for certain functions to be explained. + +**** TODO Standard scenarios + :PROPERTIES: + :CUSTOM_ID: howto-the-basics + :END: + + What everyone expects: encryption, decryption, signing and verifying. + +**** TODO Key control + :PROPERTIES: + :CUSTOM_ID: howto-key-control + :END: + + Generating keys, adding subkeys, revoking subkeys (and keeping + the cert key), adding and revoking UIDs, signing/certifying keys. + +**** TODO Key control + :PROPERTIES: + :CUSTOM_ID: howto-key-selection + :END: + + Selecting keys to encrypt to or manipulate in other ways (e.g. as + with key control or the basics). + +**** TODO S/MIME + :PROPERTIES: + :CUSTOM_ID: howto-s-mime + :END: + + Eventually add some of this, but it the OpenPGP details are far + more important at the moment. + ** TODO Documentation SWIG :PROPERTIES: :CUSTOM_ID: todo-docs-swig |