.. _file_src_t8_version.h:

File t8_version.h
=================

|exhale_lsh| :ref:`Parent directory <dir_src>` (``src``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS


.. contents:: Contents
   :local:
   :backlinks: none

Definition (``src/t8_version.h``)
---------------------------------


.. toctree::
   :maxdepth: 1

   program_listing_file_src_t8_version.h.rst



Detailed Description
--------------------

This file offers additional functions and support regarding the t8code version. The version number of t8code is a string "X.Y.Z-HASH" where the "-HASH" part is optional.


Macro   
Meaning   
example    


T8_PACKAGE_STRING   
The package string of t8code   
"t8 0.41.1-288be-dirty"    


T8_PACKAGE_VERSION   
The full version number X.Y.Z-HASH as string   
"0.41.1-288be-dirty"    


T8_VERSION_MAJOR   
The major version number of t8code X as int   
0    


T8_VERSION_MINOR   
The minor version number of t8code Y as int   
42    


T8_VERSION_POINT   
The point version number of t8code Z-HASH as inst   
1-288be-dirty    


:ref:`exhale_define_t8__version_8h_1a7e5a979f6391aae5e061624755775a53` 
The point version number of t8code Z-HASH as string   
"1-288be-dirty"   




Attention: By design of git's version handling, T8_VERSION_POINT is not defined as a string. Since it does often contain chars we additionally define the macro :ref:`exhale_define_t8__version_8h_1a7e5a979f6391aae5e061624755775a53` in this header file.

The point version number consists of the the patch version number and the HASH part. To get the patch version number Z alone use :ref:`exhale_function_t8__version_8h_1a15a0da945e9c73f12ff5b7eb6ed924d5`. 




Includes
--------


- ``t8.h`` (:ref:`file_src_t8.h`)



Included By
-----------


- :ref:`file_src_t8.c`

- :ref:`file_src_t8_cmesh_t8_cmesh_io_t8_cmesh_save.cxx`

- :ref:`file_src_t8_version.c`




Functions
---------


- :ref:`exhale_function_t8__version_8h_1a5c30a461c77ce9d6ec1243ec4e6dd0b7`

- :ref:`exhale_function_t8__version_8h_1abc3887647de0182a3e7c06fd682993ad`

- :ref:`exhale_function_t8__version_8h_1a9dcff7311b62cd2b8a618daf217826b6`

- :ref:`exhale_function_t8__version_8h_1ad4c0b1368c3e365b09be3cc661fd5115`

- :ref:`exhale_function_t8__version_8h_1a7998d21fba4879dee41da4f405e3c779`

- :ref:`exhale_function_t8__version_8h_1a12998033691219f6235c26cc8bfd3bbf`

- :ref:`exhale_function_t8__version_8h_1a15a0da945e9c73f12ff5b7eb6ed924d5`

- :ref:`exhale_function_t8__version_8h_1aa84d8cb3eafb157220f6c83b1847dbdd`


Defines
-------


- :ref:`exhale_define_t8__version_8h_1a54894bd983b2b402d116ebdb2653fa41`

- :ref:`exhale_define_t8__version_8h_1ab5cb5337c96978242484ef44865e9c2a`

- :ref:`exhale_define_t8__version_8h_1a7e5a979f6391aae5e061624755775a53`