[Pkg-gnupg-commit] [gpgme] 70/103: gpgconf: Add more comments.

[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 91e47d71652bd0f83b51089c343c3c4836bdfa8a
Author: Marcus Brinkmann <marcus.brinkmann at ruhr-uni-bochum.de>
Date:   Thu Aug 24 15:50:16 2017 +0200

    gpgconf: Add more comments.
    
    * src/engine-gpgconf.c (gpgconf_config_dir_cb, gpgconf_conf_dir):
    Add comments.
    
    Signed-off-by: Marcus Brinkmann <mb at g10code.com>
    GnuPG-bug-id: 3018
---
 src/engine-gpgconf.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/engine-gpgconf.c b/src/engine-gpgconf.c
index ba5a73d..94ae67f 100644
--- a/src/engine-gpgconf.c
+++ b/src/engine-gpgconf.c
@@ -992,6 +992,10 @@ struct gpgconf_config_dir_s
   char *result;
 };
 
+/* Called for each line in the gpgconf --list-dirs output.  Searches
+   for the desired line and returns the result, indicating success by
+   a special error value GPG_ERR_USER_1 (which terminates the
+   operation immediately).  */
 static gpgme_error_t
 gpgconf_config_dir_cb (void *hook, char *line)
 {
@@ -1011,6 +1015,8 @@ gpgconf_config_dir_cb (void *hook, char *line)
 }
 
 
+/* Like gpgme_get_dirinfo, but uses the home directory of ENGINE and
+   does not cache the result.  */
 static gpgme_error_t
 gpgconf_conf_dir (void *engine, const char *what, char **result)
 {
@@ -1023,7 +1029,7 @@ gpgconf_conf_dir (void *engine, const char *what, char **result)
 		      gpgconf_config_dir_cb, &data);
   if (gpg_err_code (err) == GPG_ERR_USER_1)
     {
-      /* This signals to use that a result was found.  */
+      /* This signals to us that a result was found.  */
       *result = data.result;
       return 0;
     }

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