aboutsummaryrefslogtreecommitdiffstats
path: root/extra/git-version.sh
diff options
context:
space:
mode:
Diffstat (limited to 'extra/git-version.sh')
-rwxr-xr-xextra/git-version.sh10
1 files changed, 10 insertions, 0 deletions
diff --git a/extra/git-version.sh b/extra/git-version.sh
index e53ddbc..612bea4 100755
--- a/extra/git-version.sh
+++ b/extra/git-version.sh
@@ -5,6 +5,16 @@ REV_SHORT=`git rev-parse --short HEAD`
REV_LONG=`git rev-parse HEAD`
cat <<EOF
+----
+-- \`alive\` source code version information
+--
+-- @module version
+
+--- exports
+-- @table exports
+-- @tfield string tag the last versions git tag
+-- @tfield string rev_short the short git revision hash
+-- @tfield string rev_long the full git revision hash
{
tag: "${TAG}"
rev_short: "${REV_SHORT}"