Commit 38c07daf authored by Leonardo Giordani's avatar Leonardo Giordani
Browse files

Official versioning schema documented

parent b94dcf5c
v0.22
v0.22.0
-----
* libgit2 types revealed through the libqgit2 API renamed as needed.
......@@ -7,3 +7,10 @@ v0.22
* A slight behavioral change in Repository::fetch() method when no
refspecs are given: previously all branches were fetched. Now the
fetch refspecs configured for the remote are used.
v0.22.1
* Added CMake code to find libgit2 as required by KDE CI system
libqgit2
========
# libqgit2
A Qt/C++ wrapper for libgit2
Official repository is
https://projects.kde.org/projects/playground/libs/libqgit2/repository/
Feel free to fork this repository to play with the library but remember
it is not the official one.
## Versioning
The versioning schema is "vNUM1.NUM2.NUM3". The first part of the version, given by "NUM1.NUM2" follows the libgit2 supported version (so all 0.22.x versions of libqgit2 compile against libgit2 0.22.x). The third number increases with maintenance versions of libqgit2. Between maintenance versions only libqgit2 fixes are allowed (as long as libgit2 maintains its versioning schema).
Each libgit2 version has its own libqgit2 branch, where multiple versions may be tagged, according to the maintenance work done on that release.
Branches are named after the libgit2 release without prefixes (e.g. '0.21', '0.22'), while versions are soft tagged with the 'v' prefix starting with NUM3 equal to 0 (e.g. 'v0.21.0', '0.21.1').
So the decision chart is:
* Did you change the code to compile against a new version of libgit2? Create a new 'NUM1.NUM2' branch and create there a 'NUM1.NUM2.0' tag.
* Did you fix libqgit2 code, solved CMake or compilation issues, changed comments or documentation? Just commit inside the 'NUM1.NUM2' branch you are working in, and create a new maintenance tag increasing NUM3.
The master Git branch must be always updated to the last tagged version.
The version number follows that of libgit2: libqgit2 0.21.x uses libgit2
0.21.x and libqgit2 0.22.x uses libgit2 0.22.x and so on.
Compiler warnings
=================
## Compiler warnings
Currently, compiler complains with the use of QSharedPointer on opaque
libgit structures. This is a known issue of Qt4 that has already been
fixed in Qt5, see [this report](https://codereview.qt-project.org/#change,26974).
I'm going to keep the QSharedPointer stuff by now, I'll replace it only
if problems arise.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment