From 2a31ed0f34b389d55eaa237108cf80f7eb8b9c97 Mon Sep 17 00:00:00 2001 From: Robert Adam Date: Sat, 1 Jan 2022 20:35:13 +0100 Subject: DOCS: Describe how to find build number --- docs/dev/build-instructions/README.md | 1 + docs/dev/build-instructions/find_build_number.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 docs/dev/build-instructions/find_build_number.md (limited to 'docs') diff --git a/docs/dev/build-instructions/README.md b/docs/dev/build-instructions/README.md index 734e07edf..88cad727c 100644 --- a/docs/dev/build-instructions/README.md +++ b/docs/dev/build-instructions/README.md @@ -21,6 +21,7 @@ In order to actually build Mumble, you can follow one of the following instructi Furthermore you might find these helpful as well: - [FAQ](faq.md) +- [Determine build number](find_build_number.md) - [Common build errors](common_build_errors.md) - [List of available cmake options](cmake_options.md) - [IDE integration](ide_integration.md) diff --git a/docs/dev/build-instructions/find_build_number.md b/docs/dev/build-instructions/find_build_number.md new file mode 100644 index 000000000..93be2f3d0 --- /dev/null +++ b/docs/dev/build-instructions/find_build_number.md @@ -0,0 +1,12 @@ +# Finding the correct BUILD_NUMBER + +When invoking CMake, you can specify a build number as e.g. `-DBUILD_NUMBER=42`. The build number will be used as the third component of the Mumble +version. + +First off: This is only important if you are planning to distribute/package Mumble (it makes sure that Mumble can be upgraded properly). For +self-compiled versions this doesn't really matter and you can simply omit the build number. + +The build number is automatically increased with every commit that is made to Mumble. All build numbers for all commits can be found on +https://mumble.info/build-number.json. Simply look up the current commit hash (topmost entry in the result of `git log`) in the list and use the +corresponding build number. + -- cgit v1.2.3