aboutsummaryrefslogtreecommitdiffstats
path: root/extra
diff options
context:
space:
mode:
authors-ol <s-ol@users.noreply.github.com>2020-03-07 20:58:30 +0000
committers-ol <s-ol@users.noreply.github.com>2020-03-07 20:58:51 +0000
commit6a7a2ddaca798f3cccac394d1fb9f317cbe90de6 (patch)
tree4e49e53057b39f75813311ede13f87d238061fe6 /extra
parentspellcheck (diff)
downloadalive-6a7a2ddaca798f3cccac394d1fb9f317cbe90de6.tar.gz
alive-6a7a2ddaca798f3cccac394d1fb9f317cbe90de6.zip
add ldoc documentation
Diffstat (limited to 'extra')
-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}"