[PATCH] Update documentation for git-get-tar-commit-id

[git.git] / git-format-patch-script

diff --git a/git-format-patch-script b/git-format-patch-script
index 9d26c9c..9b13b88 100755 (executable)
--- a/git-format-patch-script
+++ b/git-format-patch-script
@@ -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] [-<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
@@ -16,6 +18,10 @@ the current working directory.
 
 When -n is specified, instead of "[PATCH] Subject", the first line is formatted
 as "[PATCH N/M] Subject", unless you have only one patch.
+
+When --mbox is specified, the output is formatted to resemble
+UNIX mailbox format, and can be concatenated together for processing
+with applymbox.
 '
     exit 1
 }
@@ -25,13 +31,26 @@ IFS='
 '
 LF='
 '
-outdir=./
 
+outdir=./
 while case "$#" in 0) break;; esac
 do
     case "$1" in
+    -a|--a|--au|--aut|--auth|--autho|--author)
+    author=t ;;
+    -c|--c|--ch|--che|--chec|--check)
+    check=t ;;
+    -d|--d|--da|--dat|--date)
+    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=*|\
@@ -48,13 +67,27 @@ 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/>.*/>/'`
 
 case "$outdir" in
 */) ;;
@@ -66,6 +99,8 @@ tmp=.tmp-series$$
 trap 'rm -f $tmp-*' 0 1 2 3 15
 
 series=$tmp-series
+commsg=$tmp-commsg
+filelist=$tmp-files
 
 titleScript='
        /./d
@@ -82,18 +117,24 @@ titleScript='
        q
 '
 
+whosepatchScript='
+/^author /{
+       s/author \(.*>\) \(.*\)$/au='\''\1'\'' ad='\''\2'\''/p
+       q
+}'
+
 _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
-    title=`git-cat-file commit "$commit" |
-    git-stripspace |
-    sed -ne "$titleScript"`
+    git-cat-file commit "$commit" | git-stripspace >$commsg
+    title=`sed -ne "$titleScript" <$commsg`
     case "$numbered" in
     '') num= ;;
     *)
@@ -102,26 +143,78 @@ do
        *) num=' '`printf "%d/%d" $i $total` ;;
        esac
     esac
+
     file=`printf '%04d-%stxt' $i "$title"`
     i=`expr "$i" - 1`
-    echo "$file"
+    echo "* $file"
     {
        mailScript='
        /./d
-       /^$/n
-       s|^|[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"'
+       a\
+From: '"$au"
+       }
+       test "$date,$au" = ",$me" || {
+               mailScript="$mailScript"'
+       a\
+Date: '"$ad"
+       }
+
+       mailScript="$mailScript"'
        : body
        p
        n
        b body'
 
-       git-cat-file commit "$commit" |
-       git-stripspace |
-       sed -ne "$mailScript"
+       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
        echo
        git-diff-tree -p $diff_opts "$commit" | sed -e "$stripCommitHead"
+
+       case "$mbox" in
+       t)
+               echo
+               ;;
+       esac
     } >"$outdir$file"
+    case "$check" in
+    t)
+       # This is slightly modified from Andrew Morton's Perfect Patch.
+       # Lines you introduce should not have trailing whitespace.
+       # Also check for an indentation that has SP before a TAB.
+        grep -n '^+\([         ]*      .*\|.*[         ]\)$' "$outdir$file"
+
+       : do not exit with non-zero because we saw no problem in the last one.
+    esac
 done <$series