aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWerner Koch <[email protected]>2024-01-15 10:12:29 +0000
committerWerner Koch <[email protected]>2024-01-15 10:12:29 +0000
commit18388f93abb064b2bcd1010242b47eb696dabf6d (patch)
tree988f65538edf07e85e8420e17d0657f013b2f8a2 /doc
parentdoc: Fix minor typo. (diff)
downloadgpgme-18388f93abb064b2bcd1010242b47eb696dabf6d.tar.gz
gpgme-18388f93abb064b2bcd1010242b47eb696dabf6d.zip
doc: Add a deprecated warning to gpgme_op_delete.
Diffstat (limited to 'doc')
-rw-r--r--doc/gpgme.texi9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index f5104f20..36b775a1 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -5377,16 +5377,19 @@ operation was started successfully, and @code{GPG_ERR_INV_VALUE} if
@var{ctx} or @var{key} is not a valid pointer.
@end deftypefun
-The following functions allow only to use one particular flag.
+The following functions allow only to use one particular flag. Their
+use is thus deprecated.
@deftypefun gpgme_error_t gpgme_op_delete (@w{gpgme_ctx_t @var{ctx}}, @w{const gpgme_key_t @var{key}}, @w{int @var{allow_secret}})
Similar to @code{gpgme_op_delete_ext}, but only the flag
-@code{GPGME_DELETE_ALLOW_SECRET} can be provided.
+@code{GPGME_DELETE_ALLOW_SECRET} can be provided. Actually all true
+values are mapped to this flag.
@end deftypefun
@deftypefun gpgme_error_t gpgme_op_delete_start (@w{gpgme_ctx_t @var{ctx}}, @w{const gpgme_key_t @var{key}}, @w{int @var{allow_secret}})
Similar to @code{gpgme_op_delete_ext_start}, but only the flag
-@code{GPGME_DELETE_ALLOW_SECRET} can be provided.
+@code{GPGME_DELETE_ALLOW_SECRET} can be provided. Actually all true
+values are mapped to this flag.
@end deftypefun