From: Michał Górny <mgorny@gentoo.org>
Date: Sat, 18 Mar 2017 09:16:12 +0000 (+0100)
Subject: git-r3.eclass: Document EGIT_COMMIT* <=> EGIT_BRANCH, #612852
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=00f0ed296c7b145239ba53e57d58bdd1fa42afdd;p=gentoo.git

git-r3.eclass: Document EGIT_COMMIT* <=> EGIT_BRANCH, #612852

Document the relation between EGIT_COMMIT* and EGIT_BRANCH variables.
---

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