doc: Add a deprecated warning to gpgme_op_delete.

This commit is contained in:
Werner Koch 2024-01-15 11:12:29 +01:00
parent b37efb11be
commit 18388f93ab
No known key found for this signature in database
GPG Key ID: E3FDFF218E45B72B

View File

@ -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