summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2008-10-19 16:06:44 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2008-10-19 16:06:44 -0700
commitfd6e237d4e8b07287c8349aa99e897f4eace4ff3 (patch)
tree8753aa2593c28be0deddb95421eb8d399c24e693 /Documentation
parentMerge branch 'sp/describe-lwtag' (diff)
parentformat-patch: autonumber by default (diff)
downloadtgif-fd6e237d4e8b07287c8349aa99e897f4eace4ff3.tar.xz
Merge branch 'gb/formatpatch-autonbr'
* gb/formatpatch-autonbr: format-patch: autonumber by default
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config.txt9
-rw-r--r--Documentation/git-format-patch.txt8
2 files changed, 10 insertions, 7 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index da18a5458e..5ba3ffa10f 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -640,10 +640,11 @@ fetch.unpackLimit::
`transfer.unpackLimit` is used instead.
format.numbered::
- A boolean which can enable sequence numbers in patch subjects.
- Setting this option to "auto" will enable it only if there is
- more than one patch. See --numbered option in
- linkgit:git-format-patch[1].
+ A boolean which can enable or disable sequence numbers in patch
+ subjects. It defaults to "auto" which enables it only if there
+ is more than one patch. It can be enabled or disabled for all
+ messages by setting it to "true" or "false". See --numbered
+ option in linkgit:git-format-patch[1].
format.headers::
Additional email headers to include in a patch to be submitted
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index adb4ea7b1b..ac36ce8717 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -58,8 +58,10 @@ output, unless the --stdout option is specified.
If -o is specified, output files are created in <dir>. Otherwise
they are created in the current working directory.
-If -n is specified, instead of "[PATCH] Subject", the first line
-is formatted as "[PATCH n/m] Subject".
+By default, the subject of a single patch is "[PATCH] First Line" and
+the subject when multiple patches are output is "[PATCH n/m] First
+Line". To force 1/1 to be added for a single patch, use -n. To omit
+patch numbers from the subject, use -N
If given --thread, 'git-format-patch' will generate In-Reply-To and
References headers to make the second and subsequent patch mails appear
@@ -81,7 +83,7 @@ include::diff-options.txt[]
-n::
--numbered::
- Name output in '[PATCH n/m]' format.
+ Name output in '[PATCH n/m]' format, even with a single patch.
-N::
--no-numbered::