create_patches.sh revision 11786:6639b188ac11 
1#!/bin/bash
2#
3# Copyright (c) 2016 ARM Limited
4# All rights reserved
5#
6# The license below extends only to copyright in the software and shall
7# not be construed as granting a license to any other intellectual
8# property including but not limited to intellectual property relating
9# to a hardware implementation of the functionality of the software
10# licensed hereunder.  You may use the software subject to the license
11# terms below provided that you ensure that this notice is replicated
12# unmodified and in its entirety in all distributions of the software,
13# modified or unmodified, in source code or in binary form.
14#
15# Redistribution and use in source and binary forms, with or without
16# modification, are permitted provided that the following conditions are
17# met: redistributions of source code must retain the above copyright
18# notice, this list of conditions and the following disclaimer;
19# redistributions in binary form must reproduce the above copyright
20# notice, this list of conditions and the following disclaimer in the
21# documentation and/or other materials provided with the distribution;
22# neither the name of the copyright holders nor the names of its
23# contributors may be used to endorse or promote products derived from
24# this software without specific prior written permission.
25#
26# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37#
38# Authors: Andreas Sandberg
39#
40
41set -e
42
43REL_SCRIPT_DIR=`dirname "$0"`
44SCRIPT_NAME=`basename "$0"`
45SCRIPT_DIR=$(cd "$REL_SCRIPT_DIR" && echo "$(pwd -P)")
46MSG_FILTER="$SCRIPT_DIR"/upstream_msg_filter.sed
47CONV_HG="$SCRIPT_DIR"/git-patch-to-hg-patch
48
49PATCH_DIR="./patches/"
50UPSTREAM="upstream/master"
51PATCH_FORMAT=
52
53usage()
54{
55    cat <<EOF
56$SCRIPT_NAME [OPTION]...  [BRANCH]
57Format a patch series suitable for upstream consumption.
58
59Options:
60  -u BRANCH      Upstream branch
61  -d DIR         Patch directory
62  -f FMT         Patch format (hg or git)
63  -h             Show this help string.
64
65This script creates a series of patches suitable from upstream
66consumption from a git branch. By default, the script works on the
67currently checked out branch (HEAD). When invoked, the script executes
68the following operations in order:
69
70  1. Rebase the patches in the current branch onto the upstream
71     branch.
72  2. Filter commit messages.
73  3. Generate a set of patches in git format or Mercurial format.
74EOF
75}
76
77branch_exists()
78{
79    git rev-parse --verify -q "$1" > /dev/null
80}
81
82while getopts ":u:d:f:h" OPT; do
83    case $OPT in
84        d)
85            PATCH_DIR="$OPTARG"
86            ;;
87        u)
88            UPSTREAM="$OPTARG"
89            ;;
90        f)
91            PATCH_FORMAT="$OPTARG"
92            ;;
93        h)
94            usage
95            exit 0
96            ;;
97
98        \?)
99            echo "$0: invalid option --  '$OPTARG'" >&2
100            echo "Try '$0 -h' for more information." >&2
101            exit 1
102            ;;
103        :)
104            echo "$0: option requires an argument -- '$OPTARG'" >&2
105            exit 1
106            ;;
107        *)
108            echo "Unhandled getopt return:" >&2
109            echo "OPT: $OPT" >&2
110            echo "OPTARG: $OPTARG" >&2
111            exit 1
112    esac
113done
114
115
116shift $((OPTIND - 1))
117
118BRANCH="${1:-HEAD}"
119
120case "$PATCH_FORMAT" in
121    git|hg)
122        ;;
123
124    "")
125        echo "Error: No patch format specified" >&2
126        exit 1
127        ;;
128
129    *)
130        echo "Error: Illegal patch format specified: '$PATCH_FORMAT'" >&2
131        exit 1
132esac
133
134
135if ! branch_exists "$BRANCH"; then
136    echo "Error: Patch branch '$BRANCH' doesn't exist" 1>&2
137    exit 2
138fi
139
140if ! branch_exists "$UPSTREAM"; then
141    echo "Error: Upstream branch '$UPSTREAM' doesn't exist." 1>&2
142    exit 2
143fi
144
145SHA_PATCHES=`git rev-parse "$BRANCH"`
146OLD_BRANCH=`git symbolic-ref --short -q HEAD`
147SHA_UPSTREAM=`git rev-parse "$UPSTREAM"`
148
149echo "Upstream branch: $UPSTREAM"
150echo "Patch directory: $PATCH_DIR"
151
152echo "Preparing detached head..."
153git checkout -q --detach "$SHA_PATCHES"
154
155# Create an exit trap to checkout the old branch when we're done
156exit_trap() {
157    git checkout -q "$OLD_BRANCH"
158}
159trap exit_trap EXIT
160
161echo "Rebasing onto upstream master..."
162git rebase "$UPSTREAM"
163
164echo "Filtering commit messages..."
165git filter-branch -f \
166    --msg-filter "$MSG_FILTER" \
167    "$SHA_UPSTREAM"..HEAD > /dev/null
168
169echo "Creating patches..."
170git format-patch -p -o "$PATCH_DIR" "$UPSTREAM"
171
172if [ "$PATCH_FORMAT" == "hg" ]; then
173    echo "Converting patches..."
174    for P in "$PATCH_DIR"/*.patch; do
175        "$CONV_HG" $P
176    done
177fi
178