InfoFromBuild.hpp
Go to the documentation of this file.
1 // Distributed under the MIT License.
2 // See LICENSE.txt for details.
3 
4 /// \file
5 /// Declares function info_from_build.
6 
7 #pragma once
8 
9 #include <string>
10 
11 /*!
12  * \ingroup LoggingGroup
13  * \brief Information about the version, date, host, git commit, and link time
14  *
15  * The information returned by this function is invaluable for identifying
16  * the version of the code used in a simulation, as well as which host, the
17  * date the code was compiled, and the time of linkage.
18  */
20 
21 /*!
22  * \ingroup LoggingGroup
23  * \brief Retrieve a string containing the current version of SpECTRE
24  */
26 
27 /*!
28  * \ingroup LoggingGroup
29  * \brief Returns major version
30  */
32 
33 /*!
34  * \ingroup LoggingGroup
35  * \brief Returns minor version
36  */
38 
39 /*!
40  * \ingroup LoggingGroup
41  * \brief Returns patch version
42  */
44 
45 /*!
46  * \ingroup LoggingGroup
47  * \brief Returns the path to the Unit test directory.
48  */
49 std::string unit_test_path() noexcept;
int spectre_major_version()
Returns major version.
Definition: InfoFromBuild.cpp:21
int spectre_patch_version()
Returns patch version.
Definition: InfoFromBuild.cpp:25
std::string spectre_version()
Retrieve a string containing the current version of SpECTRE.
Definition: InfoFromBuild.cpp:19
int spectre_minor_version()
Returns minor version.
Definition: InfoFromBuild.cpp:23
std::string unit_test_path() noexcept
Returns the path to the Unit test directory.
Definition: InfoFromBuild.cpp:43
std::string info_from_build()
Information about the version, date, host, git commit, and link time.
Definition: InfoFromBuild.cpp:27