GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify what "checking on bit" means

Browse Source 
* 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.
This commit is contained in:
Andre Heinecke 2016-12-07 21:41:34 +01:00
parent 05896c210f
commit 7880335273
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/gpgme.texi
View File

@ -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:
@example
if (sig.summary & GPGME_SIGSUM_VALID)
@{
..do stuff if valid..
@}
else
@{
..do stuff if not fully valid..
@}
@end example
The defined bits are:
@table @code