diff options
| author | Jens Lorenz <jlorenz@de.adit-jv.com> | 2018-02-12 17:45:56 +0100 |
|---|---|---|
| committer | Jens Lorenz <jlorenz@de.adit-jv.com> | 2018-02-13 11:05:45 +0100 |
| commit | 5b8411277e44e92eea3b8e9469af003415c02a6f (patch) | |
| tree | 1ef22847112e596d79de199ce5de1c500c86f8cd /docx | |
| parent | a4e8cdcef0ebf57b23ea6676a54c39e256e906eb (diff) | |
| download | audiomanager-5b8411277e44e92eea3b8e9469af003415c02a6f.tar.gz | |
CMake: Implement VCS agnostic versioning
Versioning should not strictly depend on Version Control System (e.g. git).
Best approach is to have a dedicated VERSION file exposing with format
<Major>.<Minor>.<Revision>. Target is that maintainer will manually release
the version once patches/fixes are merged e.g. to a stabilization branch.
In order to have an OEM specific meta information exposed with the version
information EXTRAVERSIONINFO can be specified by CMAKE flag.
Signed-off-by: Guerra Mattia <mguerra@de.adit-jv.com>
Diffstat (limited to 'docx')
| -rw-r--r-- | docx/02_y_versioning.dox | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docx/02_y_versioning.dox b/docx/02_y_versioning.dox index 864a04e..c30e6bd 100644 --- a/docx/02_y_versioning.dox +++ b/docx/02_y_versioning.dox @@ -17,6 +17,8 @@ /*! \page ver Versioning +\section mec_ver Versioning Mechanism +Versioning should not strictly depend on Version Control System (e.g. git) information. Best approach is to have a dedicated resource exposing the Version of the project. This is achieved via the \c VERSION file in the main folder of the AudioManager, which content is read by CMake and used in the whole component. Optionally, the flag \c EXTRAVERSIONINFO can be used to append additional information to the version. \c VERSION is reporting with the format <\c Major>.<\c Minor>.<\c Revision>. Maintainer of the component should take care of keeping the information aligned with release cycle. \c Revision should be maintained once patches/fixes are merged to a stabilization branch. \section new_ver New versioning scheme Due to the unclearness in the versioning scheme, the versioning scheme changed with release 7.0. Beginning with the 7.0 version, the versioning changed to the semantic versioning described here: <a href="http://semver.org/">http://semver.org/</a>. |