Skip to content

Commit 77e4623

Browse files
committed
settings: clarify what each value means
Most importantly, clarify what it means for HTTPS and SSH to be supported.
1 parent 061a0ad commit 77e4623

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

include/git2/common.h

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,27 @@ GIT_EXTERN(void) git_libgit2_version(int *major, int *minor, int *rev);
109109
* was compiled
110110
*/
111111
typedef enum {
112+
/**
113+
* If set, libgit2 was built thread-aware and can be safely used from multiple
114+
* threads.
115+
*/
112116
GIT_FEATURE_THREADS = (1 << 0),
117+
/**
118+
* If set, libgit2 was built with and linked against a TLS implementation.
119+
* Custom TLS streams may still be added by the user to support HTTPS
120+
* regardless of this.
121+
*/
113122
GIT_FEATURE_HTTPS = (1 << 1),
123+
/**
124+
* If set, libgit2 was built with and linked against libssh2. A custom
125+
* transport may still be added by the user to support libssh2 regardless of
126+
* this.
127+
*/
114128
GIT_FEATURE_SSH = (1 << 2),
129+
/**
130+
* If set, libgit2 was built with support for sub-second resolution in file
131+
* modification times.
132+
*/
115133
GIT_FEATURE_NSEC = (1 << 3),
116134
} git_feature_t;
117135

0 commit comments

Comments
 (0)