Files
deb-python-pygit2/docs/general.rst
Michael Jones bd322fa132 Correct LIBGIT2_VERSION name and add documentation
LIBGIT2_VERSION was previously recorded as LIBGIT2_VER_VERSION which is
incorrect.

We also add basic explanations to all the constants so that the page is
a little less bare. Perhaps this should be done as autodoc style
comments in the code but I guess not.
2014-06-15 11:11:16 +01:00

1.1 KiB

General

Contents

Top level constants and exceptions from the library.

Constants

The following constants provide information about the version of the libgit2 library that has been built against. The version number has a MAJOR.MINOR.REVISION format.

Integer value of the major version number. For example, for the version 0.20.0:

>>> print LIBGIT2_VER_MAJOR
0

Integer value of the minor version number. For example, for the version 0.20.0:

>>> print LIBGIT2_VER_MINOR
20

Integer value of the revision version number. For example, for the version 0.20.0:

>>> print LIBGIT2_VER_REVISION
0

The libgit2 version number as a string:

>>> print LIBGIT2_VERSION
'0.20.0'

Errors

pygit2.GitError