From: Junio C Hamano <gitster@pobox.com>
Date: Thu, 2 Apr 2009 19:00:59 +0000 (-0700)
Subject: Merge branch 'tr/maint-1.6.1-doc-format-patch--root' into maint
X-Git-Tag: v1.6.2.2~5
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/b5a18787bd5c757b49a7ea4fdd73e62a1fee35de?ds=inline;hp=-c

Merge branch 'tr/maint-1.6.1-doc-format-patch--root' into maint

* tr/maint-1.6.1-doc-format-patch--root:
Documentation: format-patch --root clarifications
---

b5a18787bd5c757b49a7ea4fdd73e62a1fee35de
diff --combined Documentation/git-format-patch.txt
index dc40f47169,1f577b8016..3c29655d75
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@@ -39,15 -39,11 +39,11 @@@ There are two ways to specify which com
     REVISIONS" section in linkgit:git-rev-parse[1]) means the
     commits in the specified range.
  
- A single commit, when interpreted as a <revision range>
- expression, means "everything that leads to that commit", but
- if you write 'git format-patch <commit>', the previous rule
- applies to that command line and you do not get "everything
- since the beginning of the time".  If you want to format
- everything since project inception to one commit, say "git
- format-patch \--root <commit>" to make it clear that it is the
- latter case.  If you want to format a single commit, you can do
- this with "git format-patch -1 <commit>".
+ The first rule takes precedence in the case of a single <commit>.  To
+ apply the second rule, i.e., format everything since the beginning of
+ history up until <commit>, use the '\--root' option: "git format-patch
+ \--root <commit>".  If you want to format only <commit> itself, you
+ can do this with "git format-patch -1 <commit>".
  
  By default, each output file is numbered sequentially from 1, and uses the
  first line of the commit message (massaged for pathname safety) as
@@@ -96,6 -92,7 +92,6 @@@ include::diff-options.txt[
  --numbered-files::
  	Output file names will be a simple number sequence
  	without the default first line of the commit appended.
 -	Mutually exclusive with the --stdout option.
  
  -k::
  --keep-subject::
@@@ -169,6 -166,13 +165,13 @@@ not add any suffix
  	applied.  By default the contents of changes in those files are
  	encoded in the patch.
  
+ --root::
+ 	Treat the revision argument as a <revision range>, even if it
+ 	is just a single commit (that would normally be treated as a
+ 	<since>).  Note that root commits included in the specified
+ 	range are always formatted as creation patches, independently
+ 	of this flag.
+ 
  CONFIGURATION
  -------------
  You can specify extra mail header lines to be added to each message