git-ls-files: add --exclude-standard

[thirdparty/git.git] / Documentation / git-format-patch.txt

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 5e6d5373ad595d58d2eac53e172099354ca55148..9d4bae2f600ba637a978648fe81cac5d6cbc903b 100644 (file)
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -9,9 +9,10 @@ git-format-patch - Prepare patches for e-mail submission
 SYNOPSIS
 --------
 [verse]
-'git-format-patch' [-n | -k] [-o <dir> | --stdout] [--thread]
+'git-format-patch' [-k] [-o <dir> | --stdout] [--thread]
                    [--attach[=<boundary>] | --inline[=<boundary>]]
                    [-s | --signoff] [<common diff options>]
+                   [-n | --numbered | -N | --no-numbered]
                    [--start-number <n>] [--numbered-files]
                    [--in-reply-to=Message-Id] [--suffix=.<sfx>]
                    [--ignore-if-in-upstream]
@@ -34,13 +35,16 @@ There are two ways to specify which commits to operate on.
 
 2. Generic <revision range> expression (see "SPECIFYING
    REVISIONS" section in gitlink: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 that is taken as
-   the special case above.  If you want to format everything
-   since project inception to one commit, say "git format-patch
-   \--root <that-commit>", as showing the root commit as patch
-   requires \--root option anyway.
+   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.
 
 By default, each output file is numbered sequentially from 1, and uses the
 first line of the commit message (massaged for pathname safety) as
@@ -74,6 +78,9 @@ include::diff-options.txt[]
 -n|--numbered::
        Name output in '[PATCH n/m]' format.
 
+-N|--no-numbered::
+       Name output in '[PATCH]' format.
+
 --start-number <n>::
        Start numbering the patches at <n> instead of 1.
 
@@ -139,15 +146,16 @@ not add any suffix.
 
 CONFIGURATION
 -------------
-You can specify extra mail header lines to be added to each
-message in the repository configuration.  You can also specify
-new defaults for the subject prefix and file suffix.
+You can specify extra mail header lines to be added to each message
+in the repository configuration, new defaults for the subject prefix
+and file suffix, and number patches when outputting more than one.
 
 ------------
 [format]
         headers = "Organization: git-foo\n"
         subjectprefix = CHANGE
         suffix = .txt
+        numbered = auto
 ------------
 
 
@@ -165,7 +173,7 @@ git-format-patch origin::
        is created in the current directory.
 
 git-format-patch \--root origin::
-       Extract all commits which that leads to 'origin' since the
+       Extract all commits that lead to 'origin' since the
        inception of the project.
 
 git-format-patch -M -B origin::