ReceiveCommits: Add comment for special handling of HEAD branch and refs/meta/config
Pushing changes for review usually requires that the target branch
exists, but there is an exception for the branch to which HEAD points to
and for refs/meta/config. Pushing for review to these branches is
allowed even if the branch does not exist yet. This allows to push
initial code for review to an empty repository and to review an initial
project configuration.
There are 2 code places in ReceiveCommits that implement this special
handling, but only at one place it was explained by a comment.
Change-Id: I9e6b171f72e5c9f68a7dfe8f49a9119264744592
Signed-off-by: Edwin Kempin <ekempin@google.com>
diff --git a/java/com/google/gerrit/server/git/receive/ReceiveCommits.java b/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
index cdfd00d..ba11985 100644
--- a/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
+++ b/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
@@ -1670,6 +1670,11 @@
logger.atFine().log("Handling %s", RefNames.REFS_USERS_SELF);
ref = RefNames.refsUsers(user.getAccountId());
}
+ // Pushing changes for review usually requires that the target branch exists, but there is an
+ // exception for the branch to which HEAD points to and for refs/meta/config. Pushing for
+ // review to these branches is allowed even if the branch does not exist yet. This allows to
+ // push initial code for review to an empty repository and to review an initial project
+ // configuration.
if (!receivePack.getAdvertisedRefs().containsKey(ref)
&& !ref.equals(readHEAD(repo))
&& !ref.equals(RefNames.REFS_CONFIG)) {
