Accumulated documentation updates.
[gitweb.git] / git-format-patch-script
index 994019e17ef5e6fa6c5a7da3c69656be4c445cdf..9b13b8858bebcad23f8d876272b33c6fed7a925a 100755 (executable)
@@ -3,8 +3,10 @@
 # Copyright (c) 2005 Junio C Hamano
 #
 
+. git-sh-setup-script || die "Not a git archive."
+
 usage () {
-    echo >&2 "usage: $0"' [-n] [-o dir] [--mbox] [--check] [-<diff options>...] upstream [ our-head ]
+    echo >&2 "usage: $0"' [-n] [-o dir] [--keep-subject] [--mbox] [--check] [--signoff] [-<diff options>...] upstream [ our-head ]
 
 Prepare each commit with its patch since our-head forked from upstream,
 one file per patch, for e-mail submission.  Each output file is
@@ -42,8 +44,13 @@ do
     date=t ;;
     -m|--m|--mb|--mbo|--mbox)
     date=t author=t mbox=t ;;
+    -k|--k|--ke|--kee|--keep|--keep-|--keep-s|--keep-su|--keep-sub|\
+    --keep-subj|--keep-subje|--keep-subjec|--keep-subject)
+    keep_subject=t ;;
     -n|--n|--nu|--num|--numb|--numbe|--number|--numbere|--numbered)
     numbered=t ;;
+    -s|--s|--si|--sig|--sign|--signo|--signof|--signoff)
+    signoff=t ;;
     -o=*|--o=*|--ou=*|--out=*|--outp=*|--outpu=*|--output=*|--output-=*|\
     --output-d=*|--output-di=*|--output-dir=*|--output-dire=*|\
     --output-direc=*|--output-direct=*|--output-directo=*|\
@@ -60,13 +67,25 @@ do
     shift
 done
 
+case "$keep_subject$numbered" in
+tt)
+       die '--keep-subject and --numbered are incompatible.' ;;
+esac
+
+revpair=
 case "$#" in
-2)    linus="$1" junio="$2" ;;
-1)    linus="$1" junio=HEAD ;;
-*)    usage ;;
+2)
+    revpair="$1..$2" ;;
+1)
+    case "$1" in
+    *..*)
+       revpair="$1";;
+    *)
+       revpair="$1..HEAD";;
+    esac ;;
+*)
+    usage ;;
 esac
-junio=`git-rev-parse --verify "$junio"`
-linus=`git-rev-parse --verify "$linus"`
 
 me=`git-var GIT_AUTHOR_IDENT | sed -e 's/>.*/>/'`
 
@@ -108,8 +127,9 @@ _x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
 _x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
 stripCommitHead='/^'"$_x40"' (from '"$_x40"')$/d'
 
-git-rev-list --merge-order "$junio" "^$linus" >$series
-total=`wc -l <$series`
+git-rev-list --no-merges --merge-order \
+       $(git-rev-parse --revs-only "$revpair") >$series
+total=`wc -l <$series | tr -dc "[0-9]"`
 i=$total
 while read commit
 do
@@ -126,25 +146,26 @@ do
 
     file=`printf '%04d-%stxt' $i "$title"`
     i=`expr "$i" - 1`
-    echo >&2 "* $file"
+    echo "* $file"
     {
        mailScript='
        /./d
-       /^$/n
-       s|^\[PATCH[^]]*\] *||'
-
-       case "$mbox" in
-       t)
-           echo 'From nobody Mon Sep 17 00:00:00 2001' ;# UNIX "From" line
-           mailScript="$mailScript"'
-           s|^|Subject: [PATCH'"$num"'] |'
-           ;;
+       /^$/n'
+       case "$keep_subject" in
+       t)  ;;
        *)
            mailScript="$mailScript"'
+           s|^\[PATCH[^]]*\] *||
            s|^|[PATCH'"$num"'] |'
            ;;
        esac
-
+       mailScript="$mailScript"'
+       s|^|Subject: |'
+       case "$mbox" in
+       t)
+           echo 'From nobody Mon Sep 17 00:00:00 2001' ;# UNIX "From" line
+           ;;
+       esac
        eval "$(sed -ne "$whosepatchScript" $commsg)"
        test "$author,$au" = ",$me" || {
                mailScript="$mailScript"'
@@ -164,6 +185,17 @@ Date: '"$ad"
        b body'
 
        sed -ne "$mailScript" <$commsg
+
+       test "$signoff" = "t" && {
+               offsigner=`git-var GIT_COMMITTER_IDENT | sed -e 's/>.*/>/'`
+               line="Signed-off-by: $offsigner"
+               grep -q "^$line\$" $commsg || {
+                       echo
+                       echo "$line"
+                       echo
+               }
+       }
+       echo
        echo '---'
        echo
        git-diff-tree -p $diff_opts "$commit" | git-apply --stat --summary