From fa5b8325449240a331836d9b494abcf0aaf26a6b Mon Sep 17 00:00:00 2001 From: Edward Thomson Date: Tue, 1 Oct 2024 16:22:42 +0100 Subject: [PATCH] openssl: point out the interaction between certs The OpenSSL certificate setting functions _may_ interact; try to document that a bit better. --- include/git2/common.h | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/include/git2/common.h b/include/git2/common.h index c4d494be3..8d0157044 100644 --- a/include/git2/common.h +++ b/include/git2/common.h @@ -336,17 +336,20 @@ typedef enum { * > - `path` is the location of a directory holding several * > certificates, one per file. * > + * > Calling `GIT_OPT_ADD_SSL_X509_CERT` may override the + * > data in `path`. + * > * > Either parameter may be `NULL`, but not both. - * + * * * opts(GIT_OPT_ADD_SSL_X509_CERT, const X509 *cert) - * - * > Add a raw X509 certificate into the SSL certs store. - * > The added certificate is not persisted and will be used - * > only during application lifetime. Also there is no ability - * > to remove a certificate from the store during app lifetime - * > after it was added. - * > - * > - `cert` is the raw X509 cert will be added to cert store. + * + * > Add a raw X509 certificate into the SSL certs store. + * > This certificate is only used by libgit2 invocations + * > during the application lifetime and is not persisted + * > to disk. This certificate cannot be removed from the + * > application once is has been added. + * > + * > - `cert` is the raw X509 cert will be added to cert store. * * * opts(GIT_OPT_SET_USER_AGENT, const char *user_agent) *