diff options
| author | Edward Thomson <ethomson@github.com> | 2022-02-14 10:27:48 -0500 |
|---|---|---|
| committer | Edward Thomson <ethomson@github.com> | 2022-02-14 10:27:48 -0500 |
| commit | b152b0300e7f9c0d8e4e34b6970311b96a85862c (patch) | |
| tree | 1046b93ca6710ae85963b275862f8cc1a8250741 | |
| parent | 056fe4be05cd8623fb210a1be4aa0529ce08ed66 (diff) | |
| download | libgit2-b152b0300e7f9c0d8e4e34b6970311b96a85862c.tar.gz | |
meta: document version information for libgit2
| -rw-r--r-- | include/git2/version.h | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/include/git2/version.h b/include/git2/version.h index ad36eb569..84af817e2 100644 --- a/include/git2/version.h +++ b/include/git2/version.h @@ -7,13 +7,33 @@ #ifndef INCLUDE_git_version_h__ #define INCLUDE_git_version_h__ +/** + * The version string for libgit2. This string follows semantic + * versioning (v2) guidelines. + */ #define LIBGIT2_VERSION "1.5.0-alpha" + +/** The major version number for this version of libgit2. */ #define LIBGIT2_VER_MAJOR 1 + +/** The minor version number for this version of libgit2. */ #define LIBGIT2_VER_MINOR 5 + +/** The revision ("teeny") version number for this version of libgit2. */ #define LIBGIT2_VER_REVISION 0 + +/** The Windows DLL patch number for this version of libgit2. */ #define LIBGIT2_VER_PATCH 0 + +/** + * The prerelease string for this version of libgit2. For development + * (nightly) builds, this will be "alpha". For prereleases, this will be + * a prerelease name like "beta" or "rc1". For final releases, this will + * be `NULL`. + */ #define LIBGIT2_VER_PRERELEASE "alpha" +/** The library ABI soversion for this version of libgit2. */ #define LIBGIT2_SOVERSION "1.5" #endif |