summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichał Górny <mgorny@gentoo.org>2017-03-18 10:16:12 +0100
committerMichał Górny <mgorny@gentoo.org>2017-03-18 10:17:28 +0100
commit00f0ed296c7b145239ba53e57d58bdd1fa42afdd (patch)
treef704df6d68c25c5230e69d4c7ad7702a315c9458
parentnet-misc/orbited: Remove last-rited pkg, #591506 (diff)
downloadgentoo-00f0ed296c7b145239ba53e57d58bdd1fa42afdd.tar.gz
gentoo-00f0ed296c7b145239ba53e57d58bdd1fa42afdd.tar.bz2
gentoo-00f0ed296c7b145239ba53e57d58bdd1fa42afdd.zip
git-r3.eclass: Document EGIT_COMMIT* <=> EGIT_BRANCH, #612852
Document the relation between EGIT_COMMIT* and EGIT_BRANCH variables.
-rw-r--r--eclass/git-r3.eclass8
1 files changed, 5 insertions, 3 deletions
diff --git a/eclass/git-r3.eclass b/eclass/git-r3.eclass
index f8ea81b5ac87..1b49f66f5f00 100644
--- a/eclass/git-r3.eclass
+++ b/eclass/git-r3.eclass
@@ -153,8 +153,9 @@ fi
# @DEFAULT_UNSET
# @DESCRIPTION:
# The tag name or commit identifier to check out. If unset, newest
-# commit from the branch will be used. If set, EGIT_BRANCH will
-# be ignored.
+# commit from the branch will be used. Note that if set to a commit
+# not on HEAD branch, EGIT_BRANCH needs to be set to a branch on which
+# the commit is available.
#
# It can be overriden via env using ${PN}_LIVE_COMMIT variable.
@@ -162,7 +163,8 @@ fi
# @DEFAULT_UNSET
# @DESCRIPTION:
# Attempt to check out the repository state for the specified timestamp.
-# The date should be in format understood by 'git rev-list'.
+# The date should be in format understood by 'git rev-list'. The commits
+# on EGIT_BRANCH will be considered.
#
# The eclass will select the last commit with commit date preceding
# the specified date. When merge commits are found, only first parents