[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] trunk r114503: epg: doc improvement for verify functions
From: |
Daiki Ueno |
Subject: |
[Emacs-diffs] trunk r114503: epg: doc improvement for verify functions |
Date: |
Thu, 03 Oct 2013 01:30:39 +0000 |
User-agent: |
Bazaar (2.6b2) |
------------------------------------------------------------
revno: 114503
revision-id: address@hidden
parent: address@hidden
committer: Daiki Ueno <address@hidden>
branch nick: trunk
timestamp: Thu 2013-10-03 10:29:17 +0900
message:
epg: doc improvement for verify functions
* 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.
modified:
lisp/ChangeLog changelog-20091113204419-o5vbwnq5f7feedwu-1432
lisp/epg.el epg.el-20091113204419-o5vbwnq5f7feedwu-8560
=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog 2013-10-02 23:33:48 +0000
+++ b/lisp/ChangeLog 2013-10-03 01:29:17 +0000
@@ -1,3 +1,9 @@
+2013-10-03 Daiki Ueno <address@hidden>
+
+ * 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 <address@hidden>
* progmodes/compile.el (compilation-start): Try globbing the arg to
=== modified file 'lisp/epg.el'
--- a/lisp/epg.el 2013-09-06 15:37:01 +0000
+++ b/lisp/epg.el 2013-10-03 01:29:17 +0000
@@ -2219,7 +2219,17 @@
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 @@
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
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] trunk r114503: epg: doc improvement for verify functions,
Daiki Ueno <=