SteamFrame/OpenVR-AdvancedSettings-frame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs on version numbers for new system

Browse Source
This commit is contained in:
Vasily
2019-04-19 22:30:04 +02:00
parent 0e8e26d553
commit 13b3ba7a56
1 changed files with 6 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer_docs.md
+6 -12
View File
@@ -1,23 +1,17 @@
<a name="top"></a>
# OpenVR Advanced Settings Developer Docs
For things that don't directly belong a single place in the source code.
> * [New Patch Release Checklist](#patch_checklist)
> * [Increment Version Numbers](#inc_vers_numbers)
# New Patch Release Checklist
<a name="patch_checklist"></a>
## New Patch Release Checklist
## Increment Version Numbers
<a name="inc_vers_numbers"></a>
### Increment Version Numbers
The version number string is kept in the `./build_scripts/compile_version_string.txt` file. The file is read by at compile time by whatever needs the current version number. Currently it is being used in 3 locations.
Currently there are three version strings in the source.
1. `src\overlaycontroller.h` - Variable named `applicationVersionString`.
1. `advancedSettings.pro` - `VERSION` variable and `APPLICATION_VERSION` define.
2. `build_scripts\win\common.py` - Variable named `VERSION_STRING`.
3. `installer\installer.nsi` - Variable named `VERSION_STRING`.
The first string should be three digits separated by dots (periods), as described in [semantic versioning](https://semver.org/) (like "2.8.0"). The second and third should be three digits separated by hyphens/dashes (like "2-8-0").
The string should be three digits separated by dots (periods), as described in [semantic versioning](https://semver.org/) (like "2.8.0"). Additional qualifiers may be appended with a dash (and only a dash). The `QMAKE` build script relies on there only being dot separated integers before the first dash. If there are non-integers (or letters) before the first dash the Windows build will fail.
The reason for the difference is that the first string is only used as a string in the source code, while the second and third are used to name files. Some operating system can become confused with more than one dot in the file name (like Windows). It's better to just avoid the situation entirely.
The AppVeyor build server will append the last 8 digits of the commit hash. This is in order to make debugging various versions easier.