[git] GPGME - branch, master, updated. gpgme-1.4.0-2-g12374cb

[by Werner Koch]

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  12374cbecede047accd2d2267bba5927037ed16c (commit)
      from  68221577b74fbcf0b43586f6004384fba0959ac5 (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 12374cbecede047accd2d2267bba5927037ed16c
Author: Werner Koch <wk at wheatstone.g10code.de>
Date:   Tue Apr 16 18:30:20 2013 +0200

    Explain the GPGME_DEBUG variable.
    
    --

diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index af2e163..8eeaafc 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -101,6 +101,7 @@ This is Edition @value{EDITION}, last updated @value{UPDATED}, of
 Appendices
 
 * UI Server Protocol::            The GnuPG UI Server Protocol.
+* Debugging::                     How to solve problems.
 
 * Library Copying::               The GNU Lesser General Public License says
                                   how you can copy and share `GnuPG Made Easy'.
@@ -5794,6 +5795,47 @@ case the state of @var{ctx} is not modified).
 
 @include uiserver.texi
 
+ at node Debugging
+ at appendix How to solve problems
+ at cindex debug
+ at cindex GPGME_DEBUG
+
+Everyone knows that software often does not do what it should do and thus
+there is a need to track down problems.  This is in particular true
+for applications using a complex library like @acronym{GPGME} and of
+course also for the library itself.  Here we give a few hints on how
+to solve such problems.
+
+First of all you should make sure that the keys you want to use are
+installed in the GnuPG engine and are usable.  Thus the first test is
+to run the desired operation using @command{gpg} or @command{gpgsm} on
+the command line.  If you can't figure out why things don't work, you
+may use @acronym{GPGME}'s built in trace feature.  This feature is
+either enabled using the environment variable @code{GPGME_DEBUG} or,
+if this is not possible, by calling the function
+ at code{gpgme_set_global_flag}.  The value is the trace level and
+an optional file name.
+
+ at noindenr
+For example
+ at smallexample
+GPGME_DEBUG=9:/home/user/mygpgme.log
+ at end smallexample
+ at noindent
+(Note that under Windows you use a semicolon in place of the colon to
+separate the fields.)
+
+A trace level of 9 is pretty verbose and thus you may want to start
+off with a lower level.  The exact definition of the trace levels and
+the output format may change with any release; you need to check the
+source code for details.  In any case the trace log should be helpful
+to understand what is going going on.  Warning: The trace log may
+reveal sensitive details like passphrases or other data you use in
+your application.  If you are asked to send a log file, make sure that
+you run your tests only with play data.
+
+
+
 @include lesser.texi
 
 @include gpl.texi

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

Summary of changes:
 doc/gpgme.texi |   42 ++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 42 insertions(+), 0 deletions(-)


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