[Pkg-gnupg-commit] [gpgme] 58/103: doc: Add more tofu documentation.

[Daniel Kahn Gillmor]

This is an automated email from the git hooks/post-receive script.

dkg pushed a commit to branch master
in repository gpgme.

commit 274609baceda3378b21f84c3ae6a44806dad2dba
Author: Marcus Brinkmann <marcus.brinkmann at ruhr-uni-bochum.de>
Date:   Thu Aug 10 16:10:40 2017 +0200

    doc: Add more tofu documentation.
    
    * doc/gpgme.texi (gpgme_tofu_info_t): Document structure.
    (gpgme_sigsum_t): Document GPGME_SIGSUM_TOFU_CONFLICT.
    
    Signed-off-by: Marcus Brinkmann <mb at g10code.com>
    GnuPG-bug-id: 2816
---
 doc/gpgme.texi | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 31929d3..37760af 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -3276,6 +3276,75 @@ Reserved for the time of the last update of this user ID.
 @end deftp
 
 
+ at deftp {Data type} gpgme_tofu_info_t
+
+The @code{gpgme_tofu_info_t} type is a pointer to a tofu info
+structure.  Tofu info structures are one component of a
+ at code{gpgme_user_id_t} object, and provide information from the TOFU
+database pertaining to the user ID.
+
+The tofu info structure has the following members:
+
+ at table @code
+ at item gpgme_key_sig_t next
+This is a pointer to the next tofu info structure in the linked
+list, or @code{NULL} if this is the last element.
+
+ at item unsigned int validity : 3
+This is the TOFU validity.  It can have the following values:
+
+ at table @code
+ at item 0
+The value @code{0} indicates a conflict.
+
+ at item 1
+The value @code{1} indicates a key without history.
+
+ at item 2
+The value @code{2} indicates a key with too little history.
+
+ at item 3
+The value @code{3} indicates a key with enough history for basic trust.
+
+ at item 4
+The value @code{4} indicates a key with a lot of history.
+
+ at end table
+
+ at item unsigned int policy : 4
+This is the TOFU policy, see @code{gpgme_tofu_policy_t}.
+
+ at item unsigned short signcount
+This is the number of signatures seen for this binding (or
+ at code{USHRT_MAX} if there are more than that).
+
+ at item unsigned short encrcount
+This is the number of encryptions done with this binding (or
+ at code{USHRT_MAX} if there are more than that).
+
+ at item unsigned long signfirst
+Number of seconds since Epoch when the first signature was seen with
+this binding.
+
+ at item unsigned long signlast
+Number of seconds since Epoch when the last signature was seen with
+this binding.
+
+ at item unsigned long encrfirst
+Number of seconds since Epoch when the first encryption was done with
+this binding.
+
+ at item unsigned long encrlast
+Number of seconds since Epoch when the last encryption was done with
+this binding.
+
+ at item char *description
+A human-readable string summarizing the TOFU data (or NULL).
+
+ at end table
+ at end deftp
+
+
 @deftp {Data type} gpgme_key_sig_t
 
 The @code{gpgme_key_sig_t} type is a pointer to a key signature structure.
@@ -5196,6 +5265,9 @@ The defined bits are:
 
   @item GPGME_SIGSUM_SYS_ERROR
   A system error occured.
+
+  @item GPGME_SIGSUM_TOFU_CONFLICT
+  A TOFU conflict was detected.
   @end table
 
 @item char *fpr

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/gpgme.git