user-manual: improve html and pdf formatting
[git/mingw.git] / git-request-pull.sh
blobebf1269d297cbc9513cb6b52726ae4590520ae92
1 #!/bin/sh
2 # Copyright 2005, Ryan Anderson <ryan@michonline.com>
4 # This file is licensed under the GPL v2, or a later version
5 # at the discretion of Linus Torvalds.
7 USAGE='<start> <url> [<end>]'
8 LONG_USAGE='Summarizes the changes between two commits to the standard output,
9 and includes the given URL in the generated summary.'
10 SUBDIRECTORY_OK='Yes'
11 OPTIONS_KEEPDASHDASH=
12 OPTIONS_SPEC='git request-pull [options] start url [end]
14 p show patch text as well
17 . git-sh-setup
19 GIT_PAGER=
20 export GIT_PAGER
22 patch=
23 while case "$#" in 0) break ;; esac
25 case "$1" in
26 -p)
27 patch=-p ;;
28 --)
29 shift; break ;;
30 -*)
31 usage ;;
33 break ;;
34 esac
35 shift
36 done
38 base=$1 url=$2 head=${3-HEAD} status=0 branch_name=
40 headref=$(git symbolic-ref -q "$head")
41 if git show-ref -q --verify "$headref"
42 then
43 branch_name=${headref#refs/heads/}
44 if test "z$branch_name" = "z$headref" ||
45 ! git config "branch.$branch_name.description" >/dev/null
46 then
47 branch_name=
51 tag_name=$(git describe --exact "$head^0" 2>/dev/null)
53 test -n "$base" && test -n "$url" || usage
55 baserev=$(git rev-parse --verify --quiet "$base"^0)
56 if test -z "$baserev"
57 then
58 die "fatal: Not a valid revision: $base"
61 headrev=$(git rev-parse --verify --quiet "$head"^0)
62 if test -z "$headrev"
63 then
64 die "fatal: Not a valid revision: $head"
67 merge_base=$(git merge-base $baserev $headrev) ||
68 die "fatal: No commits in common between $base and $head"
70 # $head is the token given from the command line, and $tag_name, if
71 # exists, is the tag we are going to show the commit information for.
72 # If that tag exists at the remote and it points at the commit, use it.
73 # Otherwise, if a branch with the same name as $head exists at the remote
74 # and their values match, use that instead.
76 # Otherwise find a random ref that matches $headrev.
77 find_matching_ref='
78 sub abbr {
79 my $ref = shift;
80 if ($ref =~ s|^refs/heads/|| || $ref =~ s|^refs/tags/|tags/|) {
81 return $ref;
82 } else {
83 return $ref;
87 my ($tagged, $branch, $found);
88 while (<STDIN>) {
89 my ($sha1, $ref, $deref) = /^(\S+)\s+(\S+?)(\^\{\})?$/;
90 next unless ($sha1 eq $ARGV[1]);
91 $found = abbr($ref);
92 if ($deref && $ref eq "tags/$ARGV[2]") {
93 $tagged = $found;
94 last;
96 if ($ref =~ m|/\Q$ARGV[0]\E$|) {
97 $exact = $found;
100 if ($tagged) {
101 print "$tagged\n";
102 } elsif ($exact) {
103 print "$exact\n";
104 } elsif ($found) {
105 print "$found\n";
109 ref=$(git ls-remote "$url" | perl -e "$find_matching_ref" "$head" "$headrev" "$tag_name")
111 url=$(git ls-remote --get-url "$url")
113 git show -s --format='The following changes since commit %H:
115 %s (%ci)
117 are available in the git repository at:
118 ' $merge_base &&
119 echo " $url${ref+ $ref}" &&
120 git show -s --format='
121 for you to fetch changes up to %H:
123 %s (%ci)
125 ----------------------------------------------------------------' $headrev &&
127 if test -n "$branch_name"
128 then
129 echo "(from the branch description for $branch_name local branch)"
130 echo
131 git config "branch.$branch_name.description"
132 fi &&
134 if test -n "$tag_name"
135 then
136 if test -z "$ref" || test "$ref" != "tags/$tag_name"
137 then
138 echo >&2 "warn: You locally have $tag_name but it does not (yet)"
139 echo >&2 "warn: appear to be at $url"
140 echo >&2 "warn: Do you want to push it there, perhaps?"
142 git cat-file tag "$tag_name" |
143 sed -n -e '1,/^$/d' -e '/^-----BEGIN PGP /q' -e p
144 echo
145 fi &&
147 if test -n "$branch_name" || test -n "$tag_name"
148 then
149 echo "----------------------------------------------------------------"
150 fi &&
152 git shortlog ^$baserev $headrev &&
153 git diff -M --stat --summary $patch $merge_base..$headrev || status=1
155 if test -z "$ref"
156 then
157 echo "warn: No branch of $url is at:" >&2
158 git show -s --format='warn: %h: %s' $headrev >&2
159 echo "warn: Are you sure you pushed '$head' there?" >&2
160 status=1
162 exit $status