Re: [PATCH v2 3/4] config/format.txt: make clear the default value of format.coverLetter
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Aug 20, 2019, 02:47 UTC
- Message-ID
- <CAPig+cTA-YzPkDP+pTpZQkwj0UeCuci8aCuXZW_xrS7-CH7Rng@mail.gmail.com>
- In-Reply-To
- <94a778c9aa561c8cbe5ef39e21695db3124611b4.1566258525.git.liu.denton@gmail.com>
On Mon, Aug 19, 2019 at 7:53 PM Denton Liu <liu.denton@gmail.com> wrote:
Show 8 quoted lines
> diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt > @@ -74,7 +74,8 @@ format.signOff:: > format.coverLetter:: > - A boolean that controls whether to generate a cover-letter when > + A boolean which lets you enable the `--cover-letter` option by > + default when > format-patch is invoked, but in addition can be set to "auto", to > generate a cover-letter only when there's more than one patch.
Rather than rewriting like this, I think it's more common in Git documentation to mention the default as the last sentence in the paragraph. For instance:
... when there's more than one patch. Default is true.