diff options
| author | Andrew Morrow <acm@mongodb.com> | 2021-10-04 14:43:39 -0400 |
|---|---|---|
| committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2021-10-05 14:14:16 +0000 |
| commit | 264eef8fe8722cf055cd51469d7da6da7268baa7 (patch) | |
| tree | 1458cadae74da9e8d10ec4c82211b141ef690d56 /docs/build_system_reference.md | |
| parent | 71c7b77200d55c7cc7d04e61cb4f059bc35f23e4 (diff) | |
| download | mongo-264eef8fe8722cf055cd51469d7da6da7268baa7.tar.gz | |
SERVER-58284 Add documentation around MONGO_VERSION and MONGO_GIT_HASH
Diffstat (limited to 'docs/build_system_reference.md')
| -rw-r--r-- | docs/build_system_reference.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/build_system_reference.md b/docs/build_system_reference.md index 8a09bbacb3d..45ae052ad28 100644 --- a/docs/build_system_reference.md +++ b/docs/build_system_reference.md @@ -407,6 +407,21 @@ After the server has started up, it should notify you via the terminal that you #### Frequently used flags and variables ### MongoDB build configuration #### Frequently used flags and variables + +##### `MONGO_GIT_HASH` + +The `MONGO_GIT_HASH` SCons variable controls the value of the git hash +which will be interpolated into the build to identify the commit +currently being built. If not overridden, this defaults to the git +hash of the current commit. + +##### `MONGO_VERSION` + +The `MONGO_VERSION` SCons variable controls the value which will be +interpolated into the build to identify the version of the software +currently being built. If not overridden, this defaults to the result +of `git describe`, which will use the local tags to derive a version. + ### Targets and Aliases ## Build artifacts and installation |