mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-27 10:54:40 +00:00
Code Issues Releases Activity

epg: doc improvement for verify functions

Browse Source 
* epg.el (epg-verify-file): Add a comment saying that it does not
notify verification error as a return value nor a signal.
(epg-verify-string): Ditto.
This commit is contained in:
Daiki Ueno 2013-10-03 10:29:17 +09:00
parent 376f862a32
commit 15a1e936a0
2 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lisp/ChangeLog
View File

@ -1,3 +1,9 @@
2013-10-03 Daiki Ueno <ueno@gnu.org>
* epg.el (epg-verify-file): Add a comment saying that it does not
notify verification error as a return value nor a signal.
(epg-verify-string): Ditto.
2013-10-02 Kevin Rodgers <kevin.d.rodgers@gmail.com>
* progmodes/compile.el (compilation-start): Try globbing the arg to

24
lisp/epg.el
View File

@ -2219,7 +2219,17 @@ SIGNED-TEXT and PLAIN are also a file if they are specified.
For a detached signature, both SIGNATURE and SIGNED-TEXT should be
string. For a normal or a cleartext signature, SIGNED-TEXT should be
nil. In the latter case, if PLAIN is specified, the plaintext is
stored into the file after successful verification."
stored into the file after successful verification.
Note that this function does not return verification result as t
or nil, nor signal error on failure. That's a design decision to
handle the case where SIGNATURE has multiple signature.
To check the verification results, use `epg-context-result-for' as follows:
\(epg-context-result-for context 'verify)
which will return a list of `epg-signature' object."
(unwind-protect
(progn
(if plain
@ -2246,7 +2256,17 @@ SIGNED-TEXT is a string if it is specified.
For a detached signature, both SIGNATURE and SIGNED-TEXT should be
string. For a normal or a cleartext signature, SIGNED-TEXT should be
nil. In the latter case, this function returns the plaintext after
successful verification."
successful verification.
Note that this function does not return verification result as t
or nil, nor signal error on failure. That's a design decision to
handle the case where SIGNATURE has multiple signature.
To check the verification results, use `epg-context-result-for' as follows:
\(epg-context-result-for context 'verify)
which will return a list of `epg-signature' object."
(let ((coding-system-for-write 'binary)
input-file)
(unwind-protect