Donald Meyers / Mbed OS evan

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

pal/.git/hooks/pre-rebase.sample@0:06ee5f8a484a, 2017-03-18 (annotated)

Committer:
djmeyers
Date:
Sat Mar 18 22:37:16 2017 +0000
Revision:
0:06ee5f8a484a
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
djmeyers 0:06ee5f8a484a 1 #!/bin/sh
djmeyers 0:06ee5f8a484a 2 #
djmeyers 0:06ee5f8a484a 3 # Copyright (c) 2006, 2008 Junio C Hamano
djmeyers 0:06ee5f8a484a 4 #
djmeyers 0:06ee5f8a484a 5 # The "pre-rebase" hook is run just before "git rebase" starts doing
djmeyers 0:06ee5f8a484a 6 # its job, and can prevent the command from running by exiting with
djmeyers 0:06ee5f8a484a 7 # non-zero status.
djmeyers 0:06ee5f8a484a 8 #
djmeyers 0:06ee5f8a484a 9 # The hook is called with the following parameters:
djmeyers 0:06ee5f8a484a 10 #
djmeyers 0:06ee5f8a484a 11 # $1 -- the upstream the series was forked from.
djmeyers 0:06ee5f8a484a 12 # $2 -- the branch being rebased (or empty when rebasing the current branch).
djmeyers 0:06ee5f8a484a 13 #
djmeyers 0:06ee5f8a484a 14 # This sample shows how to prevent topic branches that are already
djmeyers 0:06ee5f8a484a 15 # merged to 'next' branch from getting rebased, because allowing it
djmeyers 0:06ee5f8a484a 16 # would result in rebasing already published history.
djmeyers 0:06ee5f8a484a 17
djmeyers 0:06ee5f8a484a 18 publish=next
djmeyers 0:06ee5f8a484a 19 basebranch="$1"
djmeyers 0:06ee5f8a484a 20 if test "$#" = 2
djmeyers 0:06ee5f8a484a 21 then
djmeyers 0:06ee5f8a484a 22 topic="refs/heads/$2"
djmeyers 0:06ee5f8a484a 23 else
djmeyers 0:06ee5f8a484a 24 topic=`git symbolic-ref HEAD` ||
djmeyers 0:06ee5f8a484a 25 exit 0 ;# we do not interrupt rebasing detached HEAD
djmeyers 0:06ee5f8a484a 26 fi
djmeyers 0:06ee5f8a484a 27
djmeyers 0:06ee5f8a484a 28 case "$topic" in
djmeyers 0:06ee5f8a484a 29 refs/heads/??/*)
djmeyers 0:06ee5f8a484a 30 ;;
djmeyers 0:06ee5f8a484a 31 *)
djmeyers 0:06ee5f8a484a 32 exit 0 ;# we do not interrupt others.
djmeyers 0:06ee5f8a484a 33 ;;
djmeyers 0:06ee5f8a484a 34 esac
djmeyers 0:06ee5f8a484a 35
djmeyers 0:06ee5f8a484a 36 # Now we are dealing with a topic branch being rebased
djmeyers 0:06ee5f8a484a 37 # on top of master. Is it OK to rebase it?
djmeyers 0:06ee5f8a484a 38
djmeyers 0:06ee5f8a484a 39 # Does the topic really exist?
djmeyers 0:06ee5f8a484a 40 git show-ref -q "$topic" || {
djmeyers 0:06ee5f8a484a 41 echo >&2 "No such branch $topic"
djmeyers 0:06ee5f8a484a 42 exit 1
djmeyers 0:06ee5f8a484a 43 }
djmeyers 0:06ee5f8a484a 44
djmeyers 0:06ee5f8a484a 45 # Is topic fully merged to master?
djmeyers 0:06ee5f8a484a 46 not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
djmeyers 0:06ee5f8a484a 47 if test -z "$not_in_master"
djmeyers 0:06ee5f8a484a 48 then
djmeyers 0:06ee5f8a484a 49 echo >&2 "$topic is fully merged to master; better remove it."
djmeyers 0:06ee5f8a484a 50 exit 1 ;# we could allow it, but there is no point.
djmeyers 0:06ee5f8a484a 51 fi
djmeyers 0:06ee5f8a484a 52
djmeyers 0:06ee5f8a484a 53 # Is topic ever merged to next? If so you should not be rebasing it.
djmeyers 0:06ee5f8a484a 54 only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
djmeyers 0:06ee5f8a484a 55 only_next_2=`git rev-list ^master ${publish} | sort`
djmeyers 0:06ee5f8a484a 56 if test "$only_next_1" = "$only_next_2"
djmeyers 0:06ee5f8a484a 57 then
djmeyers 0:06ee5f8a484a 58 not_in_topic=`git rev-list "^$topic" master`
djmeyers 0:06ee5f8a484a 59 if test -z "$not_in_topic"
djmeyers 0:06ee5f8a484a 60 then
djmeyers 0:06ee5f8a484a 61 echo >&2 "$topic is already up-to-date with master"
djmeyers 0:06ee5f8a484a 62 exit 1 ;# we could allow it, but there is no point.
djmeyers 0:06ee5f8a484a 63 else
djmeyers 0:06ee5f8a484a 64 exit 0
djmeyers 0:06ee5f8a484a 65 fi
djmeyers 0:06ee5f8a484a 66 else
djmeyers 0:06ee5f8a484a 67 not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
djmeyers 0:06ee5f8a484a 68 /usr/bin/perl -e '
djmeyers 0:06ee5f8a484a 69 my $topic = $ARGV[0];
djmeyers 0:06ee5f8a484a 70 my $msg = "* $topic has commits already merged to public branch:\n";
djmeyers 0:06ee5f8a484a 71 my (%not_in_next) = map {
djmeyers 0:06ee5f8a484a 72 /^([0-9a-f]+) /;
djmeyers 0:06ee5f8a484a 73 ($1 => 1);
djmeyers 0:06ee5f8a484a 74 } split(/\n/, $ARGV[1]);
djmeyers 0:06ee5f8a484a 75 for my $elem (map {
djmeyers 0:06ee5f8a484a 76 /^([0-9a-f]+) (.*)$/;
djmeyers 0:06ee5f8a484a 77 [$1 => $2];
djmeyers 0:06ee5f8a484a 78 } split(/\n/, $ARGV[2])) {
djmeyers 0:06ee5f8a484a 79 if (!exists $not_in_next{$elem->[0]}) {
djmeyers 0:06ee5f8a484a 80 if ($msg) {
djmeyers 0:06ee5f8a484a 81 print STDERR $msg;
djmeyers 0:06ee5f8a484a 82 undef $msg;
djmeyers 0:06ee5f8a484a 83 }
djmeyers 0:06ee5f8a484a 84 print STDERR " $elem->[1]\n";
djmeyers 0:06ee5f8a484a 85 }
djmeyers 0:06ee5f8a484a 86 }
djmeyers 0:06ee5f8a484a 87 ' "$topic" "$not_in_next" "$not_in_master"
djmeyers 0:06ee5f8a484a 88 exit 1
djmeyers 0:06ee5f8a484a 89 fi
djmeyers 0:06ee5f8a484a 90
djmeyers 0:06ee5f8a484a 91 <<\DOC_END
djmeyers 0:06ee5f8a484a 92
djmeyers 0:06ee5f8a484a 93 This sample hook safeguards topic branches that have been
djmeyers 0:06ee5f8a484a 94 published from being rewound.
djmeyers 0:06ee5f8a484a 95
djmeyers 0:06ee5f8a484a 96 The workflow assumed here is:
djmeyers 0:06ee5f8a484a 97
djmeyers 0:06ee5f8a484a 98 * Once a topic branch forks from "master", "master" is never
djmeyers 0:06ee5f8a484a 99 merged into it again (either directly or indirectly).
djmeyers 0:06ee5f8a484a 100
djmeyers 0:06ee5f8a484a 101 * Once a topic branch is fully cooked and merged into "master",
djmeyers 0:06ee5f8a484a 102 it is deleted. If you need to build on top of it to correct
djmeyers 0:06ee5f8a484a 103 earlier mistakes, a new topic branch is created by forking at
djmeyers 0:06ee5f8a484a 104 the tip of the "master". This is not strictly necessary, but
djmeyers 0:06ee5f8a484a 105 it makes it easier to keep your history simple.
djmeyers 0:06ee5f8a484a 106
djmeyers 0:06ee5f8a484a 107 * Whenever you need to test or publish your changes to topic
djmeyers 0:06ee5f8a484a 108 branches, merge them into "next" branch.
djmeyers 0:06ee5f8a484a 109
djmeyers 0:06ee5f8a484a 110 The script, being an example, hardcodes the publish branch name
djmeyers 0:06ee5f8a484a 111 to be "next", but it is trivial to make it configurable via
djmeyers 0:06ee5f8a484a 112 $GIT_DIR/config mechanism.
djmeyers 0:06ee5f8a484a 113
djmeyers 0:06ee5f8a484a 114 With this workflow, you would want to know:
djmeyers 0:06ee5f8a484a 115
djmeyers 0:06ee5f8a484a 116 (1) ... if a topic branch has ever been merged to "next". Young
djmeyers 0:06ee5f8a484a 117 topic branches can have stupid mistakes you would rather
djmeyers 0:06ee5f8a484a 118 clean up before publishing, and things that have not been
djmeyers 0:06ee5f8a484a 119 merged into other branches can be easily rebased without
djmeyers 0:06ee5f8a484a 120 affecting other people. But once it is published, you would
djmeyers 0:06ee5f8a484a 121 not want to rewind it.
djmeyers 0:06ee5f8a484a 122
djmeyers 0:06ee5f8a484a 123 (2) ... if a topic branch has been fully merged to "master".
djmeyers 0:06ee5f8a484a 124 Then you can delete it. More importantly, you should not
djmeyers 0:06ee5f8a484a 125 build on top of it -- other people may already want to
djmeyers 0:06ee5f8a484a 126 change things related to the topic as patches against your
djmeyers 0:06ee5f8a484a 127 "master", so if you need further changes, it is better to
djmeyers 0:06ee5f8a484a 128 fork the topic (perhaps with the same name) afresh from the
djmeyers 0:06ee5f8a484a 129 tip of "master".
djmeyers 0:06ee5f8a484a 130
djmeyers 0:06ee5f8a484a 131 Let's look at this example:
djmeyers 0:06ee5f8a484a 132
djmeyers 0:06ee5f8a484a 133 o---o---o---o---o---o---o---o---o---o "next"
djmeyers 0:06ee5f8a484a 134 / / / /
djmeyers 0:06ee5f8a484a 135 / a---a---b A / /
djmeyers 0:06ee5f8a484a 136 / / / /
djmeyers 0:06ee5f8a484a 137 / / c---c---c---c B /
djmeyers 0:06ee5f8a484a 138 / / / \ /
djmeyers 0:06ee5f8a484a 139 / / / b---b C \ /
djmeyers 0:06ee5f8a484a 140 / / / / \ /
djmeyers 0:06ee5f8a484a 141 ---o---o---o---o---o---o---o---o---o---o---o "master"
djmeyers 0:06ee5f8a484a 142
djmeyers 0:06ee5f8a484a 143
djmeyers 0:06ee5f8a484a 144 A, B and C are topic branches.
djmeyers 0:06ee5f8a484a 145
djmeyers 0:06ee5f8a484a 146 * A has one fix since it was merged up to "next".
djmeyers 0:06ee5f8a484a 147
djmeyers 0:06ee5f8a484a 148 * B has finished. It has been fully merged up to "master" and "next",
djmeyers 0:06ee5f8a484a 149 and is ready to be deleted.
djmeyers 0:06ee5f8a484a 150
djmeyers 0:06ee5f8a484a 151 * C has not merged to "next" at all.
djmeyers 0:06ee5f8a484a 152
djmeyers 0:06ee5f8a484a 153 We would want to allow C to be rebased, refuse A, and encourage
djmeyers 0:06ee5f8a484a 154 B to be deleted.
djmeyers 0:06ee5f8a484a 155
djmeyers 0:06ee5f8a484a 156 To compute (1):
djmeyers 0:06ee5f8a484a 157
djmeyers 0:06ee5f8a484a 158 git rev-list ^master ^topic next
djmeyers 0:06ee5f8a484a 159 git rev-list ^master next
djmeyers 0:06ee5f8a484a 160
djmeyers 0:06ee5f8a484a 161 if these match, topic has not merged in next at all.
djmeyers 0:06ee5f8a484a 162
djmeyers 0:06ee5f8a484a 163 To compute (2):
djmeyers 0:06ee5f8a484a 164
djmeyers 0:06ee5f8a484a 165 git rev-list master..topic
djmeyers 0:06ee5f8a484a 166
djmeyers 0:06ee5f8a484a 167 if this is empty, it is fully merged to "master".
djmeyers 0:06ee5f8a484a 168
djmeyers 0:06ee5f8a484a 169 DOC_END