From 649b19688132dd315e361c0f5b63ba6d8f45996d Mon Sep 17 00:00:00 2001 From: Werner Koch Date: Mon, 3 Dec 2018 10:40:52 +0100 Subject: [PATCH] doc: Minor comment cleanups. -- Signed-off-by: Werner Koch --- doc/gpgme.texi | 6 +++--- lang/python/doc/rst/gpgme-python-howto.rst | 12 +++--------- src/gpgme.c | 2 ++ 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 7d410f83..e04c301a 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -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 diff --git a/lang/python/doc/rst/gpgme-python-howto.rst b/lang/python/doc/rst/gpgme-python-howto.rst index d1cb3fd3..71dd72a9 100644 --- a/lang/python/doc/rst/gpgme-python-howto.rst +++ b/lang/python/doc/rst/gpgme-python-howto.rst @@ -8,16 +8,10 @@ Introduction +-----------------------------------+-----------------------------------+ | GPGME Version: | 1.12.1 | +-----------------------------------+-----------------------------------+ -| Author: | `Ben | -| | McGinnes `__ | -| | | +| Author: | Ben McGinnes | +-----------------------------------+-----------------------------------+ -| Author GPG Key: | `DB4724E6FA4286C92B4E55C4321E4E23 | -| | 73590E5D `__ | +| Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E23 | +| | 73590E5D | +-----------------------------------+-----------------------------------+ | Language: | Australian English, British | | | English | diff --git a/src/gpgme.c b/src/gpgme.c index a0a6c6bc..65a2e309 100644 --- a/src/gpgme.c +++ b/src/gpgme.c @@ -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) {