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>
Subject: [PATCH 2/3] Doc: add more detail for git-format-patch
Date: Sun, 18 Aug 2019 22:37:37 -0400 [thread overview]
Message-ID: <7619da962d1fc804392e3552fbd56bf4bc68ac38.1566182184.git.liu.denton@gmail.com> (raw)
In-Reply-To: <cover.1566182184.git.liu.denton@gmail.com>
In git-format-patch.txt, we were missing some key user information.
First of all, using the `--to` and `--cc` options don't override
`format.to` and `format.cc` variables, respectively. They add on to each
other. Document this.
In addition, document the special value of `--base=auto`.
Next, while we're at it, surround option arguments with <>.
Finally, document the `format.outputDirectory` config and change
`format.coverletter` to use camelcase.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
Documentation/git-format-patch.txt | 25 ++++++++++++++++---------
1 file changed, 16 insertions(+), 9 deletions(-)
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index b9b97e63ae..0e2dd59c0f 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,7 +159,7 @@ 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
provide a new patch series.
@@ -193,13 +193,17 @@ will want to ensure that threading is disabled for `git send-email`.
--to=<email>::
Add a `To:` header to the email headers. This is in addition
- to any configured headers, and may be used multiple times.
+ to any configured headers, and may be used multiple times. The
+ emails given will be used along with any emails given by
+ `format.to` configurations.
The negated form `--no-to` discards all `To:` headers added so
far (from config or command line).
--cc=<email>::
Add a `Cc:` header to the email headers. This is in addition
- to any configured headers, and may be used multiple times.
+ to any configured headers, and may be used multiple times. The
+ emails given will be used along with any emails given by
+ `format.cc` configurations.
The negated form `--no-cc` discards all `Cc:` headers added so
far (from config or command line).
@@ -314,7 +318,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 equal to "auto", a base commit
+ is automatically chosen.
--root::
Treat the revision argument as a <revision range>, even if it
@@ -330,8 +335,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 +349,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-19 2:38 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-19 2:37 [PATCH 0/3] format-patch: teach --infer-cover-subject option Denton Liu
2019-08-19 2:37 ` [PATCH 1/3] t4014: clean up style Denton Liu
2019-08-19 16:02 ` Eric Sunshine
2019-08-19 2:37 ` Denton Liu [this message]
2019-08-19 17:09 ` [PATCH 2/3] Doc: add more detail for git-format-patch Eric Sunshine
2019-08-19 23:16 ` Denton Liu
2019-08-20 19:01 ` Junio C Hamano
2019-08-19 2:37 ` [PATCH 3/3] format-patch: infer cover letter from branch description Denton Liu
2019-08-19 17:29 ` Eric Sunshine
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=7619da962d1fc804392e3552fbd56bf4bc68ac38.1566182184.git.liu.denton@gmail.com \
--to=liu.denton@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).