diff options
| author | Ingo Klöcker <[email protected]> | 2023-12-14 08:29:43 +0000 |
|---|---|---|
| committer | Ingo Klöcker <[email protected]> | 2023-12-14 08:29:43 +0000 |
| commit | b35bcf0040903ab5d803ce21fb512a327816a1d9 (patch) | |
| tree | e2a95a56902f7e2d0243b0cdf6706b697e2798fa /doc | |
| parent | qt: Replace Q_FOREACH with range-for (diff) | |
| download | gpgme-b35bcf0040903ab5d803ce21fb512a327816a1d9.tar.gz gpgme-b35bcf0040903ab5d803ce21fb512a327816a1d9.zip | |
doc: Fix documentation for creating encrypted/signed archive
--
The previous paragraph already explains where/how the result is stored.
In particular, it's not always "returned in the data object ...".
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/gpgme.texi | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi index c499ed9b..11f90133 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -6381,10 +6381,10 @@ mode @var{mode}. If signature mode @code{GPGME_SIG_MODE_ARCHIVE} is requested, then a signed archive is created from the files and directories given as -NUL-separated list in the data object @var{plain} and returned in the -data object @var{sig}. The paths of the files and directories have to -be given as paths relative to the current working directory or relative -to the base directory set with @code{gpgme_data_set_file_name}. +NUL-separated list in the data object @var{plain}. The paths of the files +and directories have to be given as paths relative to the current working +directory or relative to the base directory set with +@code{gpgme_data_set_file_name} for the data object @var{plain}. After the operation completed successfully, the result can be retrieved with @code{gpgme_op_sign_result}. @@ -6561,10 +6561,10 @@ for @var{cipher}) and the text mode attributes set for the context If the flag @code{GPGME_ENCRYPT_ARCHIVE} is set, then an encrypted archive is created from the files and directories given as NUL-separated -list in the data object @var{plain} and returned in the data object -@var{cipher}. The paths of the files and directories have to -be given as paths relative to the current working directory or relative -to the base directory set with @code{gpgme_data_set_file_name}. +list in the data object @var{plain}. The paths of the files and +directories have to be given as paths relative to the current working +directory or relative to the base directory set with +@code{gpgme_data_set_file_name} for the data object @var{plain}. @var{recp} must be a @code{NULL}-terminated array of keys. The user must keep references for all keys during the whole duration of the |