Added documentation

Added documentation to show some of the know variables in the files.
myatt95 · Sep 7, 2012 · 03b61ef · 03b61ef
1 parent 62657ec
commit 03b61ef
Show file tree

Hide file tree

Showing 34 changed files with 171 additions and 0 deletions.
diff --git a/hooks/filter-flow-hotfix-start-version b/hooks/filter-flow-hotfix-start-version
@@ -8,6 +8,11 @@
 # Return VERSION - When VERSION is returned empty, git-flow will stop as the
 # version is necessary
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+
 VERSION=$1
 
 # Implement your script here.

diff --git a/hooks/filter-flow-release-start-version b/hooks/filter-flow-release-start-version
@@ -8,6 +8,11 @@
 # Return VERSION - When VERSION is returned empty, git-flow will stop as the
 # version is necessary
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 
 # Implement your script here.

diff --git a/hooks/post-flow-feature-delete b/hooks/post-flow-feature-delete
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-feature-finish b/hooks/post-flow-feature-finish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-feature-publish b/hooks/post-flow-feature-publish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-feature-pull b/hooks/post-flow-feature-pull
@@ -7,6 +7,11 @@
 # $2    The remote to pull from
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 REMOTE=$2
 BRANCH=$3

diff --git a/hooks/post-flow-feature-start b/hooks/post-flow-feature-start
@@ -8,6 +8,11 @@
 # $3    The full branch name (including the feature prefix)
 # $4    The base from which this feature is started
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-feature-track b/hooks/post-flow-feature-track
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-hotfix-delete b/hooks/post-flow-hotfix-delete
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-hotfix-finish b/hooks/post-flow-hotfix-finish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-hotfix-publish b/hooks/post-flow-hotfix-publish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-hotfix-start b/hooks/post-flow-hotfix-start
@@ -8,6 +8,11 @@
 # $3    The full branch name (including the feature prefix)
 # $4    The base from which this feature is started
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-release-branch b/hooks/post-flow-release-branch
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-release-delete b/hooks/post-flow-release-delete
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-release-finish b/hooks/post-flow-release-finish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-release-publish b/hooks/post-flow-release-publish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-release-start b/hooks/post-flow-release-start
@@ -8,6 +8,11 @@
 # $3    The full branch name (including the release prefix)
 # $4    The base from which this release is started
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/post-flow-release-track b/hooks/post-flow-release-track
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-feature-delete b/hooks/pre-flow-feature-delete
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-feature-finish b/hooks/pre-flow-feature-finish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-feature-publish b/hooks/pre-flow-feature-publish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-feature-pull b/hooks/pre-flow-feature-pull
@@ -7,6 +7,11 @@
 # $2    The remote to pull from
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 REMOTE=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-feature-start b/hooks/pre-flow-feature-start
@@ -8,6 +8,11 @@
 # $3    The full branch name (including the feature prefix)
 # $4    The base from which this feature is started
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-feature-track b/hooks/pre-flow-feature-track
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-hotfix-delete b/hooks/pre-flow-hotfix-delete
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-hotfix-finish b/hooks/pre-flow-hotfix-finish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-hotfix-publish b/hooks/pre-flow-hotfix-publish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the feature prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-hotfix-start b/hooks/pre-flow-hotfix-start
@@ -8,6 +8,11 @@
 # $3    The full branch name (including the feature prefix)
 # $4    The base from which this feature is started
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-release-branch b/hooks/pre-flow-release-branch
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-release-delete b/hooks/pre-flow-release-delete
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-release-finish b/hooks/pre-flow-release-finish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-release-publish b/hooks/pre-flow-release-publish
@@ -7,6 +7,11 @@
 # $2    The origin remote
 # $3    The full branch name (including the release prefix)
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 NAME=$1
 ORIGIN=$2
 BRANCH=$3

diff --git a/hooks/pre-flow-release-start b/hooks/pre-flow-release-start
@@ -8,6 +8,11 @@
 # $3    The full branch name (including the release prefix)
 # $4    The base from which this release is started
 #
+# The following variables are available as they are exported by git-flow:
+#
+# MASTER_BRANCH - The branch defined as Master
+# DEVELOP_BRANCH - The branch defined as Develop
+#
 VERSION=$1
 ORIGIN=$2
 BRANCH=$3