doc: Minor comment cleanups.
authorWerner Koch <wk@gnupg.org>
Mon, 3 Dec 2018 09:40:52 +0000 (10:40 +0100)
committerWerner Koch <wk@gnupg.org>
Mon, 3 Dec 2018 09:41:00 +0000 (10:41 +0100)
--

Signed-off-by: Werner Koch <wk@gnupg.org>
doc/gpgme.texi
lang/python/doc/rst/gpgme-python-howto.rst
src/gpgme.c

index 7d410f8..e04c301 100644 (file)
@@ -2461,9 +2461,9 @@ the context @var{ctx} to @var{proto}.  All crypto operations will be
 performed by the crypto engine configured for that protocol.
 @xref{Protocols and Engines}.
 
-Setting the protocol with @code{gpgme_set_protocol} does not check if
-the crypto engine for that protocol is available and installed
-correctly.  @xref{Engine Version Check}.
+Setting the protocol with @code{gpgme_set_protocol} does intentionally
+not check if the crypto engine for that protocol is available and
+installed correctly.  @xref{Engine Version Check}.
 
 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
 protocol could be set successfully, and @code{GPG_ERR_INV_VALUE} if
index d1cb3fd..71dd72a 100644 (file)
@@ -8,16 +8,10 @@ Introduction
 +-----------------------------------+-----------------------------------+
 | GPGME Version:                    | 1.12.1                            |
 +-----------------------------------+-----------------------------------+
-| Author:                           | `Ben                              |
-|                                   | McGinnes <https://gnupg.org/peopl |
-|                                   | e/index.html#sec-1-5>`__          |
-|                                   | <ben@gnupg.org>                   |
+| Author:                           | Ben McGinnes <ben@gnupg.org>      |
 +-----------------------------------+-----------------------------------+
-| Author GPG Key:                   | `DB4724E6FA4286C92B4E55C4321E4E23 |
-|                                   | 73590E5D <https://hkps.pool.sks-k |
-|                                   | eyservers.net/pks/lookup?search=0 |
-|                                   | xDB4724E6FA4286C92B4E55C4321E4E23 |
-|                                   | 73590E5D&exact=on&op=get>`__      |
+| Author GPG Key:                   | DB4724E6FA4286C92B4E55C4321E4E23  |
+|                                   | 73590E5D                          |
 +-----------------------------------+-----------------------------------+
 | Language:                         | Australian English, British       |
 |                                   | English                           |
index a0a6c6b..65a2e30 100644 (file)
@@ -320,6 +320,8 @@ _gpgme_release_result (gpgme_ctx_t ctx)
 }
 
 
+/* Note that setting the protocol will intentionally not fail if the
+ * engine is not available.  */
 gpgme_error_t
 gpgme_set_protocol (gpgme_ctx_t ctx, gpgme_protocol_t protocol)
 {