src/gromacs/utility/baseversion_gen.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2012,2013,2014,2015 by the GROMACS development team.
   5  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Declares variables that hold generated version information.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_BASEVERSION_GEN_H
  44 #define GMX_UTILITY_BASEVERSION_GEN_H
  45
  46 /*! \cond internal */
  47 //! \addtogroup module_utility
  48 //! \{
  49
  50 //! Version string, containing the version, date, and abbreviated hash.
  51 extern const char gmx_ver_string[];
  52 //! Full git hash of the latest commit.
  53 extern const char gmx_full_git_hash[];
  54 //! Full git hash of the latest commit in a central \Gromacs repository.
  55 extern const char gmx_central_base_hash[];
  56 /*! \brief
  57  *  DOI string for the \Gromacs source code populated by CMake.
  58  *
  59  *  The variable is populated with the generated DOI string
  60  *  by CMake when the build of a release version is
  61  *  requested by Jenkins. Allows identification and
  62  *  referencing of different \Gromacs releases.
  63  */
  64 extern const char gmxSourceDoiString[];
  65 //! Sha256 checksum of source and header files, populated for release builds.
  66 extern const char gmxReleaseSourceFileChecksum[];
  67 //! Sha256 checksum of source and header files, populated for builds from tarball.
  68 extern const char gmxCurrentSourceFileChecksum[];
  69
  70 //! \}
  71 //! \endcond
  72
  73 #endif