| Message ID | fd908bcc01884469dce966fbc384d6982687b4bd.1566258525.git.liu.denton@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | format-patch: learn --infer-cover-subject option | expand |
On Mon, Aug 19, 2019 at 7:53 PM Denton Liu <liu.denton@gmail.com> wrote: > 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. This entire paragraph can go away since v2 dropped this change. > 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 camel case. > > Signed-off-by: Denton Liu <liu.denton@gmail.com> > --- > diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt > @@ -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. Should <commit> be encased in backquotes in the paragraph body?
On Mon, Aug 19, 2019 at 10:44:03PM -0400, Eric Sunshine wrote: > On Mon, Aug 19, 2019 at 7:53 PM Denton Liu <liu.denton@gmail.com> wrote: > > 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. > > This entire paragraph can go away since v2 dropped this change. > > > 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 camel case. > > > > Signed-off-by: Denton Liu <liu.denton@gmail.com> > > --- > > diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt > > @@ -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. > > Should <commit> be encased in backquotes in the paragraph body? In this page, it seems like the other instances of <commit> (or most other <text> for that matter) aren't wrapped in backquotes. From checking out the rest of Git's documentation, it seems like it's a mixed bag whether to do this or not. I'm going to leave it as is and hopefully someone who cares enough will make the docs more stylistically uniform.
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index b9b97e63ae..95bc4d53ca 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. @@ -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 ------------
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 camel case. Signed-off-by: Denton Liu <liu.denton@gmail.com> --- Documentation/git-format-patch.txt | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-)