openssl: point out the interaction between certs

The OpenSSL certificate setting functions _may_ interact; try to
document that a bit better.
This commit is contained in:
Edward Thomson
2024-10-01 16:22:42 +01:00
parent 33938b3df7
commit fa5b832544

View File

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