Re: [PATCH 1/2] commit doc: document that -c, -C, -F and --fixup with -m error

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Dec 20, 2017, 19:45 UTC
Message-ID: <CAPig+cR_erp_U5GJKBcoBnQ+xhWpS4KjTu3sNgRTTO4V==DCsA@mail.gmail.com>
In-Reply-To: <20171220193845.11754-1-avarab@gmail.com>

On Wed, Dec 20, 2017 at 2:38 PM, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:

Show 12 quoted lines

> Document that providing any of -c, -C, -F and --fixup along with -m
> will result in an error. Some variant of this has been errored about
> explicitly since 0c091296c0 ("git-commit: log parameter updates.",
> 2005-08-08), but the documentation was never updated to reflect this.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> @@ -144,6 +144,9 @@ OPTIONS
> ++
> +Combining the `-m` option and any of `-c`, `-C`, `-F` or `--fixup`
> +will result in an error.

This sounds a bit scary, as if there is something wrong with Git. Perhaps say instead that they are "mutually exclusive":

    The `-m` option is mutually exclusive with `-c`, `-C`, `-F`, and
    `--fixup`.

Or something.