GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Fix documentation for creating encrypted/signed archive

Browse Source 
--

The previous paragraph already explains where/how the result is stored.
In particular, it's not always "returned in the data object ...".
This commit is contained in:
Ingo Klöcker 2023-12-14 09:29:43 +01:00
parent d5dafb2ae3
commit b35bcf0040
No known key found for this signature in database
GPG Key ID: F5A5D1692277A1E9
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/gpgme.texi
View File

@ -6381,10 +6381,10 @@ mode @var{mode}.
If signature mode @code{GPGME_SIG_MODE_ARCHIVE} is requested, then a If signature mode @code{GPGME_SIG_MODE_ARCHIVE} is requested, then a
signed archive is created from the files and directories given as signed archive is created from the files and directories given as
NUL-separated list in the data object @var{plain} and returned in the NUL-separated list in the data object @var{plain}. The paths of the files
data object @var{sig}. The paths of the files and directories have to and directories have to be given as paths relative to the current working
be given as paths relative to the current working directory or relative directory or relative to the base directory set with
to the base directory set with @code{gpgme_data_set_file_name}. @code{gpgme_data_set_file_name} for the data object @var{plain}.
After the operation completed successfully, the result can be After the operation completed successfully, the result can be
retrieved with @code{gpgme_op_sign_result}. 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 If the flag @code{GPGME_ENCRYPT_ARCHIVE} is set, then an encrypted
archive is created from the files and directories given as NUL-separated 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 list in the data object @var{plain}. The paths of the files and
@var{cipher}. The paths of the files and directories have to directories have to be given as paths relative to the current working
be given as paths relative to the current working directory or relative directory or relative to the base directory set with
to the base directory set with @code{gpgme_data_set_file_name}. @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 @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 must keep references for all keys during the whole duration of the