[git] GPGME - branch, master, updated. gpgme-1.8.0-10-g7880335

[by Andre Heinecke]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GnuPG Made Easy".

The branch, master has been updated
       via  7880335273382f05cbbe38aa965a566c4127ba6a (commit)
      from  05896c210f7fa9ce7b97784a75e49dc4489e9252 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 7880335273382f05cbbe38aa965a566c4127ba6a
Author: Andre Heinecke <aheinecke at intevation.de>
Date:   Wed Dec 7 21:41:34 2016 +0100

    Clarify what "checking on bit" means
    
    * doc/gpgme.texi (gpgme_sigsum_t summary): Clarify what "you
    can check one bit means"
    
    --
    It was unclear which bit to test for is. And tests
    with students have shown that they would "test" for
    this one bit by using if(sig.summary == GPGME_SIGSUM_VALID)
    which would fail because valid sigs are also SIGSUM_GREEN.
    
    So lets give an example for people not used to checking bits and
    clarify through this example which bit is meant to be checked.

diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 32e0861..ee82b27 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -4948,7 +4948,19 @@ list, or @code{NULL} if this is the last element.
 This is a bit vector giving a summary of the signature status.  It
 provides an easy interface to a defined semantic of the signature
 status.  Checking just one bit is sufficient to see whether a
-signature is valid without any restrictions.
+signature is valid without any restrictions. This means that
+you can check for GPGME_SIGSUM_VALID like this:
+
+ at example
+if (sig.summary & GPGME_SIGSUM_VALID)
+@{
+   ..do stuff if valid..
+@}
+else
+@{
+   ..do stuff if not fully valid..
+@}
+ at end example
 
 The defined bits are:
   @table @code

-----------------------------------------------------------------------

Summary of changes:
 doc/gpgme.texi | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)


hooks/post-receive
-- 
GnuPG Made Easy
http://git.gnupg.org