Re: [PATCH] commit: make default of "cleanup" option configurable

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 9, 2013, 15:56 UTC
Message-ID: <7vhamq8i44.fsf@alter.siamese.dyndns.org>
In-Reply-To: <CAN0XMO+t2gu9UKJFVXAxt91-hUUhMqqmMoop88KYp0vo3x6c_g@mail.gmail.com>

Ralf Thielow <ralf.thielow@gmail.com> writes:

Show 5 quoted lines

> It's actually my own usecase :). The bugtracker I'm using is able
> to create relationships between issues and related commits. It
> expects that a part of the commit message contains the issue number
> in format "#<issueId>". So I need to use a cleanup mode different
> from "default" to keep the commentary.

This is orthogonal to the patch in question, but in your particular case, I wonder if it is a workable solution to indent #<bugid> in your message, which won't be stripped away.

I also wonder, as a longer term alternative (which would require a lot of code auditing and some refactoring), if it is useful to have an option and/or configuration that lets you configure the "comment in log message editor" character from the default "#" to something else. "git -c log.commentchar=% commit" may start the log message editor with something like this in it:

    % Please enter the commit message for your changes. Lines starting
    % with '%' will be ignored, and an empty message aborts the commit.

Naturally, setting log.commentchar to "none" would disable stripping of any commented lines if such a feature existed, and stop issuing these helpful comments altogether, but still strip excess blank lines and trailing whitespaces.

I wouldn't seriously suggest it as I am not sure if the usefulness of such a feature would outweigh the cost of coding it, though; at least not at this point yet.