From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>,
"Eric Sunshine" <sunshine@sunshineco.com>,
"Johannes Sixt" <j6t@kdbg.org>,
"Philip Oakley" <philipoakley@iee.email>
Subject: [PATCH v2 12/13] Doc: add more detail for git-format-patch
Date: Tue, 27 Aug 2019 00:05:17 -0400 [thread overview]
Message-ID: <fd343b99c5bc3a73c3896805ea4283c9f39a9d04.1566878374.git.liu.denton@gmail.com> (raw)
In-Reply-To: <cover.1566878373.git.liu.denton@gmail.com>
In git-format-patch.txt, we were missing some key user information.
First of all, document the special value of `--base=auto`.
Next, while we're at it, surround option arguments with <> and change
existing names such as "Message-Id" to "message id", which conforms with
how existing documentation is written.
Finally, document the `format.outputDirectory` config and change
`format.coverletter` to use camel case.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
Documentation/git-format-patch.txt | 23 +++++++++++++----------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index b9b97e63ae..0ac56f4b70 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -17,9 +17,9 @@ SYNOPSIS
[--signature-file=<file>]
[-n | --numbered | -N | --no-numbered]
[--start-number <n>] [--numbered-files]
- [--in-reply-to=Message-Id] [--suffix=.<sfx>]
+ [--in-reply-to=<message id>] [--suffix=.<sfx>]
[--ignore-if-in-upstream]
- [--rfc] [--subject-prefix=Subject-Prefix]
+ [--rfc] [--subject-prefix=<subject prefix>]
[(--reroll-count|-v) <n>]
[--to=<email>] [--cc=<email>]
[--[no-]cover-letter] [--quiet]
@@ -159,9 +159,9 @@ Beware that the default for 'git send-email' is to thread emails
itself. If you want `git format-patch` to take care of threading, you
will want to ensure that threading is disabled for `git send-email`.
---in-reply-to=Message-Id::
+--in-reply-to=<message id>::
Make the first mail (or all the mails with `--no-thread`) appear as a
- reply to the given Message-Id, which avoids breaking threads to
+ reply to the given <message id>, which avoids breaking threads to
provide a new patch series.
--ignore-if-in-upstream::
@@ -171,9 +171,9 @@ will want to ensure that threading is disabled for `git send-email`.
patches being generated, and any patch that matches is
ignored.
---subject-prefix=<Subject-Prefix>::
+--subject-prefix=<subject prefix>::
Instead of the standard '[PATCH]' prefix in the subject
- line, instead use '[<Subject-Prefix>]'. This
+ line, instead use '[<subject prefix>]'. This
allows for useful naming of a patch series, and can be
combined with the `--numbered` option.
@@ -314,7 +314,8 @@ you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
--base=<commit>::
Record the base tree information to identify the state the
patch series applies to. See the BASE TREE INFORMATION section
- below for details.
+ below for details. If <commit> is "auto", a base commit is
+ automatically chosen.
--root::
Treat the revision argument as a <revision range>, even if it
@@ -330,8 +331,9 @@ CONFIGURATION
-------------
You can specify extra mail header lines to be added to each message,
defaults for the subject prefix and file suffix, number patches when
-outputting more than one patch, add "To" or "Cc:" headers, configure
-attachments, and sign off patches with configuration variables.
+outputting more than one patch, add "To:" or "Cc:" headers, configure
+attachments, change the patch output directory, and sign off patches
+with configuration variables.
------------
[format]
@@ -343,7 +345,8 @@ attachments, and sign off patches with configuration variables.
cc = <email>
attach [ = mime-boundary-string ]
signOff = true
- coverletter = auto
+ outputDirectory = <directory>
+ coverLetter = auto
------------
--
2.23.0.248.g3a9dd8fb08
next prev parent reply other threads:[~2019-08-27 4:05 UTC|newest]
Thread overview: 91+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-19 23:52 [PATCH v2 0/4] format-patch: learn --infer-cover-subject option Denton Liu
2019-08-19 23:52 ` [PATCH v2 1/4] t4014: clean up style Denton Liu
2019-08-20 2:41 ` Eric Sunshine
2019-08-19 23:52 ` [PATCH v2 2/4] Doc: add more detail for git-format-patch Denton Liu
2019-08-20 2:44 ` Eric Sunshine
2019-08-20 7:07 ` Denton Liu
2019-08-19 23:52 ` [PATCH v2 3/4] config/format.txt: make clear the default value of format.coverLetter Denton Liu
2019-08-20 2:47 ` Eric Sunshine
2019-08-19 23:52 ` [PATCH v2 4/4] format-patch: learn --infer-cover-letter option Denton Liu
2019-08-20 3:46 ` Eric Sunshine
2019-08-20 7:18 ` [PATCH v3 00/13] format-patch: learn --infer-cover-subject option (also t4014 cleanup) Denton Liu
2019-08-20 7:18 ` [PATCH v3 01/13] t4014: drop unnecessary blank lines from test cases Denton Liu
2019-08-20 7:18 ` [PATCH v3 02/13] t4014: s/expected/expect/ Denton Liu
2019-08-20 21:31 ` Eric Sunshine
2019-08-20 7:18 ` [PATCH v3 03/13] t4014: move closing sq onto its own line Denton Liu
2019-08-20 7:18 ` [PATCH v3 04/13] t4014: use sq for test case names Denton Liu
2019-08-20 7:18 ` [PATCH v3 05/13] t4014: remove spaces after redirect operators Denton Liu
2019-08-20 7:18 ` [PATCH v3 06/13] t4014: use indentable here-docs Denton Liu
2019-08-20 7:19 ` [PATCH v3 07/13] t4014: drop redirections to /dev/null Denton Liu
2019-08-20 7:19 ` [PATCH v3 08/13] t4014: use test_line_count() where possible Denton Liu
2019-08-20 7:19 ` [PATCH v3 09/13] t4014: remove confusing pipe in check_threading() Denton Liu
2019-08-20 7:19 ` [PATCH v3 10/13] t4014: stop losing return codes of git commands Denton Liu
2019-08-20 7:31 ` Denton Liu
2019-08-20 19:04 ` Johannes Sixt
2019-08-20 7:19 ` [PATCH v3 11/13] Doc: add more detail for git-format-patch Denton Liu
2019-08-21 18:26 ` Junio C Hamano
2019-08-20 7:19 ` [PATCH v3 12/13] config/format.txt: specify default value of format.coverLetter Denton Liu
2019-08-20 7:19 ` [PATCH v3 13/13] format-patch: learn --infer-cover-subject option Denton Liu
2019-08-21 19:32 ` Junio C Hamano
2019-08-23 18:15 ` Denton Liu
2019-08-23 18:46 ` Philip Oakley
2019-08-23 20:18 ` Junio C Hamano
2019-08-24 8:03 ` Denton Liu
2019-08-24 13:59 ` Philip Oakley
2019-08-26 14:30 ` Junio C Hamano
2019-08-26 14:26 ` Junio C Hamano
2019-08-26 16:05 ` Junio C Hamano
2019-08-22 20:18 ` [PATCH v3 00/13] format-patch: learn --infer-cover-subject option (also t4014 cleanup) Junio C Hamano
2019-08-23 18:19 ` Denton Liu
2019-08-23 20:25 ` Junio C Hamano
2019-08-24 8:25 ` [PATCH 00/13] format-patch: clean up tests and documentation Denton Liu
2019-08-24 8:26 ` [PATCH 01/13] t4014: drop unnecessary blank lines from test cases Denton Liu
2019-08-24 8:26 ` [PATCH 02/13] t4014: s/expected/expect/ Denton Liu
2019-08-24 8:26 ` [PATCH 03/13] t4014: move closing sq onto its own line Denton Liu
2019-08-24 8:26 ` [PATCH 04/13] t4014: use sq for test case names Denton Liu
2019-08-24 8:26 ` [PATCH 05/13] t4014: remove spaces after redirect operators Denton Liu
2019-08-24 8:27 ` [PATCH 06/13] t4014: use indentable here-docs Denton Liu
2019-08-24 8:27 ` [PATCH 07/13] t4014: drop redirections to /dev/null Denton Liu
2019-08-24 8:27 ` [PATCH 08/13] t4014: let sed open its own files Denton Liu
2019-08-26 0:42 ` Eric Sunshine
2019-08-24 8:27 ` [PATCH 09/13] t4014: use test_line_count() where possible Denton Liu
2019-08-24 8:27 ` [PATCH 10/13] t4014: remove confusing pipe in check_threading() Denton Liu
2019-08-24 8:27 ` [PATCH 11/13] t4014: stop losing return codes of git commands Denton Liu
2019-08-24 8:27 ` [PATCH 12/13] Doc: add more detail for git-format-patch Denton Liu
2019-08-26 15:20 ` Junio C Hamano
2019-08-26 16:07 ` Junio C Hamano
2019-08-24 8:27 ` [PATCH 13/13] config/format.txt: specify default value of format.coverLetter Denton Liu
2019-08-24 8:28 ` [PATCH 00/13] format-patch: clean up tests and documentation Denton Liu
2019-08-26 15:21 ` Junio C Hamano
2019-08-27 4:04 ` [PATCH v2 " Denton Liu
2019-08-27 4:04 ` [PATCH v2 01/13] t4014: drop unnecessary blank lines from test cases Denton Liu
2019-08-27 4:04 ` [PATCH v2 02/13] t4014: s/expected/expect/ Denton Liu
2019-08-27 4:04 ` [PATCH v2 03/13] t4014: move closing sq onto its own line Denton Liu
2019-08-27 4:04 ` [PATCH v2 04/13] t4014: use sq for test case names Denton Liu
2019-08-27 4:05 ` [PATCH v2 05/13] t4014: remove spaces after redirect operators Denton Liu
2019-08-27 4:05 ` [PATCH v2 06/13] t4014: use indentable here-docs Denton Liu
2019-08-27 4:05 ` [PATCH v2 07/13] t4014: drop redirections to /dev/null Denton Liu
2019-08-27 4:05 ` [PATCH v2 08/13] t4014: let sed open its own files Denton Liu
2019-08-27 4:05 ` [PATCH v2 09/13] t4014: use test_line_count() where possible Denton Liu
2019-08-27 4:05 ` [PATCH v2 10/13] t4014: remove confusing pipe in check_threading() Denton Liu
2019-08-27 4:05 ` [PATCH v2 11/13] t4014: stop losing return codes of git commands Denton Liu
2019-08-27 4:05 ` Denton Liu [this message]
2019-08-27 4:05 ` [PATCH v2 13/13] config/format.txt: specify default value of format.coverLetter Denton Liu
2019-09-04 11:21 ` [PATCH v2 00/13] format-patch: clean up tests and documentation Denton Liu
2019-09-05 19:56 ` Junio C Hamano
2019-09-05 21:40 ` Denton Liu
2019-10-11 19:12 ` [PATCH v4 0/3] format-patch: learn --cover-from-description option Denton Liu
2019-10-11 19:12 ` [PATCH v4 1/3] format-patch: remove erroneous and condition Denton Liu
2019-10-11 19:12 ` [PATCH v4 2/3] format-patch: use enum variables Denton Liu
2019-10-12 2:16 ` Junio C Hamano
2019-10-11 19:12 ` [PATCH v4 3/3] format-patch: teach --cover-from-description option Denton Liu
2019-10-12 2:36 ` Junio C Hamano
2019-10-11 19:23 ` [PATCH v4 4/3] fixup! " Denton Liu
2019-10-12 4:18 ` [PATCH v4 0/3] format-patch: learn " Junio C Hamano
2019-10-14 20:46 ` [PATCH v5 " Denton Liu
2019-10-14 20:46 ` [PATCH v5 1/3] format-patch: change erroneous and condition Denton Liu
2019-10-15 2:16 ` Junio C Hamano
2019-10-15 3:45 ` Denton Liu
2019-10-14 20:47 ` [PATCH v5 2/3] format-patch: use enum variables Denton Liu
2019-10-14 20:47 ` [PATCH v5 3/3] format-patch: teach --cover-from-description option Denton Liu
2019-10-15 2:25 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=fd343b99c5bc3a73c3896805ea4283c9f39a9d04.1566878374.git.liu.denton@gmail.com \
--to=liu.denton@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=j6t@kdbg.org \
--cc=philipoakley@iee.email \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).