ynkmr/SourcetrailDB
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

describe versioning in readme and add changelog

Browse Source
This commit is contained in:
mlangkabel
2018-12-18 17:30:10 +01:00
parent 89158d0b1d
commit e7e1045375
3 changed files with 26 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/include/SourcetrailDBWriter.h
+8 -8
View File
@@ -52,15 +52,15 @@ namespace sourcetrail
SourcetrailDBWriter();
/**
* Provides the version of the SourcetrailDB Core as string with format "v1_db20_p0"
* Provides the version of the SourcetrailDB Core as string with format "vXX_dbYY_pZZ"
*
* The first number (e.g. "v1") of the version string denotes the interface version of the
* API. This version is increases on change that breaks the backwards compatibility.
* The second number (e.g. "db20") of the version string denotes the version of the database
* that will be generated by this class. This version needs to match the database version of
* the used Sourcetrail version to be compatible.
* The third number (e.g. "p0") is the patch number of the build and will increase with
* release that delivers bugfixes and features that don't break any compatibility.
* - "XX" marks the interface version of the API. This version is increases on every change
* that breaks backwards compatibility of the API.
* - "YY" marks the version of the database that will be generated when using the
* SourcetrailDB API. This version needs to match the database version of the Sourcetrail
* instance that is used to open the generated database file to be compatible.
* - "ZZ" marks the patch number of the build. It will increase with every release that
* publishes bugfixes and features that don't break any compatibility.
*/
std::string getVersionString() const;