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

   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano
   4#
   5
   6USAGE='[-n | -k] [-o <dir> | --stdout] [--signoff] [--check] [--diff-options] [--attach] <his> [<mine>]'
   7LONG_USAGE='Prepare each commit with its patch since <mine> head forked from
   8<his> head, one file per patch formatted to resemble UNIX mailbox
   9format, for e-mail submission or use with git-am.
  10
  11Each output file is numbered sequentially from 1, and uses the
  12first line of the commit message (massaged for pathname safety)
  13as the filename.
  14
  15When -o is specified, output files are created in <dir>; otherwise
  16they are created in the current working directory.  This option
  17is ignored if --stdout is specified.
  18
  19When -n is specified, instead of "[PATCH] Subject", the first
  20line is formatted as "[PATCH N/M] Subject", unless you have only
  21one patch.
  22
  23When --attach is specified, patches are attached, not inlined.'
  24
  25. git-sh-setup
  26
  27# Force diff to run in C locale.
  28LANG=C LC_ALL=C
  29export LANG LC_ALL
  30
  31diff_opts=
  32LF='
  33'
  34
  35outdir=./
  36while case "$#" in 0) break;; esac
  37do
  38    case "$1" in
  39    -c|--c|--ch|--che|--chec|--check)
  40    check=t ;;
  41    -a|--a|--au|--aut|--auth|--autho|--author|\
  42    -d|--d|--da|--dat|--date|\
  43    -m|--m|--mb|--mbo|--mbox) # now noop
  44    ;;
  45    --at|--att|--atta|--attac|--attach)
  46    attach=t ;;
  47    -k|--k|--ke|--kee|--keep|--keep-|--keep-s|--keep-su|--keep-sub|\
  48    --keep-subj|--keep-subje|--keep-subjec|--keep-subject)
  49    keep_subject=t ;;
  50    -n|--n|--nu|--num|--numb|--numbe|--number|--numbere|--numbered)
  51    numbered=t ;;
  52    -s|--s|--si|--sig|--sign|--signo|--signof|--signoff)
  53    signoff=t ;;
  54    --st|--std|--stdo|--stdou|--stdout)
  55    stdout=t ;;
  56    -o=*|--o=*|--ou=*|--out=*|--outp=*|--outpu=*|--output=*|--output-=*|\
  57    --output-d=*|--output-di=*|--output-dir=*|--output-dire=*|\
  58    --output-direc=*|--output-direct=*|--output-directo=*|\
  59    --output-director=*|--output-directory=*)
  60    outdir=`expr "$1" : '-[^=]*=\(.*\)'` ;;
  61    -o|--o|--ou|--out|--outp|--outpu|--output|--output-|--output-d|\
  62    --output-di|--output-dir|--output-dire|--output-direc|--output-direct|\
  63    --output-directo|--output-director|--output-directory)
  64    case "$#" in 1) usage ;; esac; shift
  65    outdir="$1" ;;
  66    -h|--h|--he|--hel|--help)
  67        usage
  68        ;;
  69    -*' '* | -*"$LF"* | -*'     '*)
  70        # Ignore diff option that has whitespace for now.
  71        ;;
  72    -*) diff_opts="$diff_opts$1 " ;;
  73    *) break ;;
  74    esac
  75    shift
  76done
  77
  78case "$keep_subject$numbered" in
  79tt)
  80        die '--keep-subject and --numbered are incompatible.' ;;
  81esac
  82
  83tmp=.tmp-series$$
  84trap 'rm -f $tmp-*' 0 1 2 3 15
  85
  86series=$tmp-series
  87commsg=$tmp-commsg
  88filelist=$tmp-files
  89
  90# Backward compatible argument parsing hack.
  91#
  92# Historically, we supported:
  93# 1. "rev1"             is equivalent to "rev1..HEAD"
  94# 2. "rev1..rev2"
  95# 3. "rev1" "rev2       is equivalent to "rev1..rev2"
  96#
  97# We want to take a sequence of "rev1..rev2" in general.
  98# Also, "rev1.." should mean "rev1..HEAD"; git-diff users are
  99# familiar with that syntax.
 100
 101case "$#,$1$2" in
 1021,?*..?*)
 103        # single "rev1..rev2"
 104        ;;
 1051,?*..)
 106        # single "rev1.." should mean "rev1..HEAD"
 107        set x "$1"HEAD
 108        shift
 109        ;;
 1101,*)
 111        # single rev1
 112        set x "$1..HEAD"
 113        shift
 114        ;;
 1152,?*..?*)
 116        # not traditional "rev1" "rev2"
 117        ;;
 1182,*)
 119        set x "$1..$2"
 120        shift
 121        ;;
 122esac
 123
 124# Now we have what we want in $@
 125for revpair
 126do
 127        case "$revpair" in
 128        ?*..?*)
 129                rev1=`expr "z$revpair" : 'z\(.*\)\.\.'`
 130                rev2=`expr "z$revpair" : 'z.*\.\.\(.*\)'`
 131                ;;
 132        *)
 133                rev1="$revpair^"
 134                rev2="$revpair"
 135                ;;
 136        esac
 137        git-rev-parse --verify "$rev1^0" >/dev/null 2>&1 ||
 138                die "Not a valid rev $rev1 ($revpair)"
 139        git-rev-parse --verify "$rev2^0" >/dev/null 2>&1 ||
 140                die "Not a valid rev $rev2 ($revpair)"
 141        git-cherry -v "$rev1" "$rev2" |
 142        while read sign rev comment
 143        do
 144                case "$sign" in
 145                '-')
 146                        echo >&2 "Merged already: $comment"
 147                        ;;
 148                *)
 149                        echo $rev
 150                        ;;
 151                esac
 152        done
 153done >$series
 154
 155me=`git-var GIT_AUTHOR_IDENT | sed -e 's/>.*/>/'`
 156headers=`git-repo-config --get format.headers`
 157case "$attach" in
 158"") ;;
 159*)
 160        mimemagic="050802040500080604070107"
 161esac
 162
 163case "$outdir" in
 164*/) ;;
 165*) outdir="$outdir/" ;;
 166esac
 167test -d "$outdir" || mkdir -p "$outdir" || exit
 168
 169titleScript='
 170        /./d
 171        /^$/n
 172        s/^\[PATCH[^]]*\] *//
 173        s/[^-a-z.A-Z_0-9]/-/g
 174        s/\.\.\.*/\./g
 175        s/\.*$//
 176        s/--*/-/g
 177        s/^-//
 178        s/-$//
 179        s/$/./
 180        p
 181        q
 182'
 183
 184process_one () {
 185        perl -w -e '
 186my ($keep_subject, $num, $signoff, $headers, $mimemagic, $commsg) = @ARGV;
 187my ($signoff_pattern, $done_header, $done_subject, $done_separator, $signoff_seen,
 188    $last_was_signoff);
 189
 190if ($signoff) {
 191        $signoff = "Signed-off-by: " . `git-var GIT_COMMITTER_IDENT`;
 192        $signoff =~ s/>.*/>/;
 193        $signoff_pattern = quotemeta($signoff);
 194}
 195
 196my @weekday_names = qw(Sun Mon Tue Wed Thu Fri Sat);
 197my @month_names = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
 198
 199sub show_date {
 200    my ($time, $tz) = @_;
 201    my $minutes = abs($tz);
 202    $minutes = int($minutes / 100) * 60 + ($minutes % 100);
 203    if ($tz < 0) {
 204        $minutes = -$minutes;
 205    }
 206    my $t = $time + $minutes * 60;
 207    my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday) = gmtime($t);
 208    return sprintf("%s, %d %s %d %02d:%02d:%02d %+05d",
 209                   $weekday_names[$wday], $mday,
 210                   $month_names[$mon], $year+1900,
 211                   $hour, $min, $sec, $tz);
 212}
 213
 214print "From nobody Mon Sep 17 00:00:00 2001\n";
 215open FH, "git stripspace <$commsg |" or die "open $commsg pipe";
 216while (<FH>) {
 217    unless ($done_header) {
 218        if (/^$/) {
 219            $done_header = 1;
 220        }
 221        elsif (/^author (.*>) (.*)$/) {
 222            my ($author_ident, $author_date) = ($1, $2);
 223            my ($utc, $off) = ($author_date =~ /^(\d+) ([-+]?\d+)$/);
 224            $author_date = show_date($utc, $off);
 225
 226            print "From: $author_ident\n";
 227            print "Date: $author_date\n";
 228        }
 229        next;
 230    }
 231    unless ($done_subject) {
 232        unless ($keep_subject) {
 233            s/^\[PATCH[^]]*\]\s*//;
 234            s/^/[PATCH$num] /;
 235        }
 236        if ($headers) {
 237            print "$headers\n";
 238        }
 239        print "Subject: $_";
 240        if ($mimemagic) {
 241            print "MIME-Version: 1.0\n";
 242            print "Content-Type: multipart/mixed;\n";
 243            print " boundary=\"------------$mimemagic\"\n";
 244            print "\n";
 245            print "This is a multi-part message in MIME format.\n";
 246            print "--------------$mimemagic\n";
 247            print "Content-Type: text/plain; charset=UTF-8; format=fixed\n";
 248            print "Content-Transfer-Encoding: 8bit\n";
 249        }
 250        $done_subject = 1;
 251        next;
 252    }
 253    unless ($done_separator) {
 254        print "\n";
 255        $done_separator = 1;
 256        next if (/^$/);
 257    }
 258
 259    $last_was_signoff = 0;
 260    if (/Signed-off-by:/i) {
 261        if ($signoff ne "" && /Signed-off-by:\s*$signoff_pattern$/i) {
 262            $signoff_seen = 1;
 263        }
 264    }
 265    print $_;
 266}
 267if (!$signoff_seen && $signoff ne "") {
 268    if (!$last_was_signoff) {
 269        print "\n";
 270    }
 271    print "$signoff\n";
 272}
 273print "\n---\n\n";
 274close FH or die "close $commsg pipe";
 275' "$keep_subject" "$num" "$signoff" "$headers" "$mimemagic" $commsg
 276
 277        git-diff-tree -p $diff_opts "$commit" | git-apply --stat --summary
 278        echo
 279        case "$mimemagic" in
 280        '');;
 281        *)
 282                echo "--------------$mimemagic"
 283                echo "Content-Type: text/x-patch;"
 284                echo " name=\"$commit.diff\""
 285                echo "Content-Transfer-Encoding: 8bit"
 286                echo "Content-Disposition: inline;"
 287                echo " filename=\"$commit.diff\""
 288                echo
 289        esac
 290        git-diff-tree -p $diff_opts "$commit"
 291        case "$mimemagic" in
 292        '')
 293                echo "-- "
 294                echo "@@GIT_VERSION@@"
 295                ;;
 296        *)
 297                echo
 298                echo "--------------$mimemagic--"
 299                echo
 300                ;;
 301        esac
 302        echo
 303}
 304
 305total=`wc -l <$series | tr -dc "[0-9]"`
 306case "$total,$numbered" in
 3071,*)
 308        numfmt='' ;;
 309*,t)
 310        numfmt=`echo "$total" | wc -c`
 311        numfmt=$(($numfmt-1))
 312        numfmt=" %0${numfmt}d/$total"
 313esac
 314
 315i=1
 316while read commit
 317do
 318    git-cat-file commit "$commit" | git-stripspace >$commsg
 319    title=`sed -ne "$titleScript" <$commsg`
 320    case "$numbered" in
 321    '') num= ;;
 322    *)
 323        num=`printf "$numfmt" $i` ;;
 324    esac
 325
 326    file=`printf '%04d-%stxt' $i "$title"`
 327    if test '' = "$stdout"
 328    then
 329            echo "$file"
 330            process_one >"$outdir$file"
 331            if test t = "$check"
 332            then
 333                # This is slightly modified from Andrew Morton's Perfect Patch.
 334                # Lines you introduce should not have trailing whitespace.
 335                # Also check for an indentation that has SP before a TAB.
 336                grep -n '^+\([  ]*      .*\|.*[         ]\)$' "$outdir$file"
 337                :
 338            fi
 339    else
 340            echo >&2 "$file"
 341            process_one
 342    fi
 343    i=`expr "$i" + 1`
 344done <$series