Andrew's git - gitweb.git/blob - git-format-patch.sh

   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano
   4#
   5
   6. git-sh-setup
   7
   8# Force diff to run in C locale.
   9LANG=C LC_ALL=C
  10export LANG LC_ALL
  11
  12usage () {
  13    echo >&2 "usage: $0"' [-n] [-o dir | --stdout] [--keep-subject] [--mbox]
  14    [--check] [--signoff] [-<diff options>...]
  15    [--help]
  16    ( from..to ... | upstream [ our-head ] )
  17
  18Prepare each commit with its patch since our-head forked from upstream,
  19one file per patch, for e-mail submission.  Each output file is
  20numbered sequentially from 1, and uses the first line of the commit
  21message (massaged for pathname safety) as the filename.
  22
  23When -o is specified, output files are created in that directory; otherwise in
  24the current working directory.
  25
  26When -n is specified, instead of "[PATCH] Subject", the first line is formatted
  27as "[PATCH N/M] Subject", unless you have only one patch.
  28
  29When --mbox is specified, the output is formatted to resemble
  30UNIX mailbox format, and can be concatenated together for processing
  31with applymbox.
  32'
  33    exit 1
  34}
  35
  36diff_opts=
  37LF='
  38'
  39
  40outdir=./
  41while case "$#" in 0) break;; esac
  42do
  43    case "$1" in
  44    -a|--a|--au|--aut|--auth|--autho|--author)
  45    author=t ;;
  46    -c|--c|--ch|--che|--chec|--check)
  47    check=t ;;
  48    -d|--d|--da|--dat|--date)
  49    date=t ;;
  50    -m|--m|--mb|--mbo|--mbox)
  51    date=t author=t mbox=t ;;
  52    -k|--k|--ke|--kee|--keep|--keep-|--keep-s|--keep-su|--keep-sub|\
  53    --keep-subj|--keep-subje|--keep-subjec|--keep-subject)
  54    keep_subject=t ;;
  55    -n|--n|--nu|--num|--numb|--numbe|--number|--numbere|--numbered)
  56    numbered=t ;;
  57    -s|--s|--si|--sig|--sign|--signo|--signof|--signoff)
  58    signoff=t ;;
  59    --st|--std|--stdo|--stdou|--stdout)
  60    stdout=t mbox=t date=t author=t ;;
  61    -o=*|--o=*|--ou=*|--out=*|--outp=*|--outpu=*|--output=*|--output-=*|\
  62    --output-d=*|--output-di=*|--output-dir=*|--output-dire=*|\
  63    --output-direc=*|--output-direct=*|--output-directo=*|\
  64    --output-director=*|--output-directory=*)
  65    outdir=`expr "$1" : '-[^=]*=\(.*\)'` ;;
  66    -o|--o|--ou|--out|--outp|--outpu|--output|--output-|--output-d|\
  67    --output-di|--output-dir|--output-dire|--output-direc|--output-direct|\
  68    --output-directo|--output-director|--output-directory)
  69    case "$#" in 1) usage ;; esac; shift
  70    outdir="$1" ;;
  71    -h|--h|--he|--hel|--help)
  72        usage
  73        ;;
  74    -*' '* | -*"$LF"* | -*'     '*)
  75        # Ignore diff option that has whitespace for now.
  76        ;;
  77    -*) diff_opts="$diff_opts$1 " ;;
  78    *) break ;;
  79    esac
  80    shift
  81done
  82
  83case "$keep_subject$numbered" in
  84tt)
  85        die '--keep-subject and --numbered are incompatible.' ;;
  86esac
  87
  88tmp=.tmp-series$$
  89trap 'rm -f $tmp-*' 0 1 2 3 15
  90
  91series=$tmp-series
  92commsg=$tmp-commsg
  93filelist=$tmp-files
  94
  95# Backward compatible argument parsing hack.
  96#
  97# Historically, we supported:
  98# 1. "rev1"             is equivalent to "rev1..HEAD"
  99# 2. "rev1..rev2"
 100# 3. "rev1" "rev2       is equivalent to "rev1..rev2"
 101#
 102# We want to take a sequence of "rev1..rev2" in general.
 103# Also, "rev1.." should mean "rev1..HEAD"; git-diff users are
 104# familiar with that syntax.
 105
 106case "$#,$1$2" in
 1071,?*..?*)
 108        # single "rev1..rev2"
 109        ;;
 1101,?*..)
 111        # single "rev1.." should mean "rev1..HEAD"
 112        set x "$1"HEAD
 113        shift
 114        ;;
 1151,*)
 116        # single rev1
 117        set x "$1..HEAD"
 118        shift
 119        ;;
 1202,?*..?*)
 121        # not traditional "rev1" "rev2"
 122        ;;
 1232,*)
 124        set x "$1..$2"
 125        shift
 126        ;;
 127esac
 128
 129# Now we have what we want in $@
 130for revpair
 131do
 132        case "$revpair" in
 133        ?*..?*)
 134                rev1=`expr "$revpair" : '\(.*\)\.\.'`
 135                rev2=`expr "$revpair" : '.*\.\.\(.*\)'`
 136                ;;
 137        *)
 138                rev1="$revpair^"
 139                rev2="$revpair"
 140                ;;
 141        esac
 142        git-rev-parse --verify "$rev1^0" >/dev/null 2>&1 ||
 143                die "Not a valid rev $rev1 ($revpair)"
 144        git-rev-parse --verify "$rev2^0" >/dev/null 2>&1 ||
 145                die "Not a valid rev $rev2 ($revpair)"
 146        git-cherry -v "$rev1" "$rev2" |
 147        while read sign rev comment
 148        do
 149                case "$sign" in
 150                '-')
 151                        echo >&2 "Merged already: $comment"
 152                        ;;
 153                *)
 154                        echo $rev
 155                        ;;
 156                esac
 157        done
 158done >$series
 159
 160me=`git-var GIT_AUTHOR_IDENT | sed -e 's/>.*/>/'`
 161
 162case "$outdir" in
 163*/) ;;
 164*) outdir="$outdir/" ;;
 165esac
 166test -d "$outdir" || mkdir -p "$outdir" || exit
 167
 168titleScript='
 169        /./d
 170        /^$/n
 171        s/^\[PATCH[^]]*\] *//
 172        s/[^-a-z.A-Z_0-9]/-/g
 173        s/\.\.\.*/\./g
 174        s/\.*$//
 175        s/--*/-/g
 176        s/^-//
 177        s/-$//
 178        s/$/./
 179        p
 180        q
 181'
 182
 183whosepatchScript='
 184/^author /{
 185        s/author \(.*>\) \(.*\)$/au='\''\1'\'' ad='\''\2'\''/p
 186        q
 187}'
 188
 189process_one () {
 190        mailScript='
 191        /./d
 192        /^$/n'
 193        case "$keep_subject" in
 194        t)  ;;
 195        *)
 196            mailScript="$mailScript"'
 197            s|^\[PATCH[^]]*\] *||
 198            s|^|[PATCH'"$num"'] |'
 199            ;;
 200        esac
 201        mailScript="$mailScript"'
 202        s|^|Subject: |'
 203        case "$mbox" in
 204        t)
 205            echo 'From nobody Mon Sep 17 00:00:00 2001' ;# UNIX "From" line
 206            ;;
 207        esac
 208
 209        eval "$(sed -ne "$whosepatchScript" $commsg)"
 210        test "$author,$au" = ",$me" || {
 211                mailScript="$mailScript"'
 212        a\
 213From: '"$au"
 214        }
 215        test "$date,$au" = ",$me" || {
 216                mailScript="$mailScript"'
 217        a\
 218Date: '"$ad"
 219        }
 220
 221        mailScript="$mailScript"'
 222        : body
 223        p
 224        n
 225        b body'
 226
 227        (cat $commsg ; echo; echo) |
 228        sed -ne "$mailScript" |
 229        git-stripspace
 230
 231        test "$signoff" = "t" && {
 232                offsigner=`git-var GIT_COMMITTER_IDENT | sed -e 's/>.*/>/'`
 233                line="Signed-off-by: $offsigner"
 234                grep -q "^$line\$" $commsg || {
 235                        echo
 236                        echo "$line"
 237                        echo
 238                }
 239        }
 240        echo
 241        echo '---'
 242        echo
 243        git-diff-tree -p $diff_opts "$commit" | git-apply --stat --summary
 244        echo
 245        git-diff-tree -p $diff_opts "$commit"
 246        echo "-- "
 247        echo "@@GIT_VERSION@@"
 248
 249        case "$mbox" in
 250        t)
 251                echo
 252                ;;
 253        esac
 254}
 255
 256total=`wc -l <$series | tr -dc "[0-9]"`
 257case "$total,$numbered" in
 2581,*)
 259        numfmt='' ;;
 260*,t)
 261        numfmt=`echo "$total" | wc -c`
 262        numfmt=$(($numfmt-1))
 263        numfmt=" %0${numfmt}d/$total"
 264esac
 265
 266i=1
 267while read commit
 268do
 269    git-cat-file commit "$commit" | git-stripspace >$commsg
 270    title=`sed -ne "$titleScript" <$commsg`
 271    case "$numbered" in
 272    '') num= ;;
 273    *)
 274        num=`printf "$numfmt" $i` ;;
 275    esac
 276
 277    file=`printf '%04d-%stxt' $i "$title"`
 278    if test '' = "$stdout"
 279    then
 280            echo "$file"
 281            process_one >"$outdir$file"
 282            if test t = "$check"
 283            then
 284                # This is slightly modified from Andrew Morton's Perfect Patch.
 285                # Lines you introduce should not have trailing whitespace.
 286                # Also check for an indentation that has SP before a TAB.
 287                grep -n '^+\([  ]*      .*\|.*[         ]\)$' "$outdir$file"
 288                :
 289            fi
 290    else
 291            echo >&2 "$file"
 292            process_one
 293    fi
 294    i=`expr "$i" + 1`
 295done <$series