Re: [PATCH 3/3] commit: add --cleanup=scissors

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Feb 16, 2014, 03:44 UTC
Message-ID: <CAPig+cSwU5CEBZX7sBJnSvUo=sx=uC5qJx+9UwikqYWSgM7wMw@mail.gmail.com>
In-Reply-To: <1392521840-21628-4-git-send-email-pclouds@gmail.com>

On Sat, Feb 15, 2014 at 10:37 PM, Nguyễn Thái Ngọc Duy <pclouds@gmail.com> wrote:

Show 5 quoted lines

> Since 1a72cfd (commit -v: strip diffs and submodule shortlogs from the
> commit message - 2013-12-05) we have a less fragile way to cut out
> "git status" at the end of a commit message but it's only enabled for
> stripping submodule shortlogs. Add new cleanup option that reuses the
> same mechanism for the entire "git status" without accidentally remove

s/remove/removing/

Show 24 quoted lines

> lines starting with '#'
>
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> ---
> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> index 1a7616c..98f976a 100644
> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -176,7 +176,7 @@ OPTIONS
>  --cleanup=<mode>::
>         This option determines how the supplied commit message should be
>         cleaned up before committing.  The '<mode>' can be `strip`,
> -       `whitespace`, `verbatim`, or `default`.
> +       `whitespace`, `verbatim`, `scissors` or `default`.
>  +
>  --
>  strip::
> @@ -186,6 +186,11 @@ whitespace::
>         Same as `strip` except #commentary is not removed.
>  verbatim::
>         Do not change the message at all.
> +scissors::
> +       Same as `whitespace`, except that everything from the line
> +       "`# ------------------------ >8 ------------------------`"

Would it make sense to be more explicit and say that the 'cut' line is also removed?

    Same as `whitespace`, except that the line
    `# ------------------------ >8 ------------------------`
    and all lines following it are removed ...

> +       is truncated if the message is to be edited. "`#`" could be

s/could/can/

> +       customized with core.commentChar.
>  default::
>         Same as `strip` if the message is to be edited.
>         Otherwise `whitespace`.