Re: [PATCH v2] Add configuration variable for sign-off to format-patch

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 6, 2009, 08:14 UTC
Message-ID: <7veiw69p26.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <20090401175153.GA90421@macbook.lan>

Heiko Voigt <hvoigt@hvoigt.net> writes:

Show 14 quoted lines

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index ad22cb8..27cb7f1 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -715,6 +715,13 @@ format.thread::
>  	A true boolean value is the same as `shallow`, and a false
>  	value disables threading.
>  
> +format.signoff::
> +    A boolean value which lets you enable the `-s/--signoff` option of
> +    format-patch by default. *Note:* Adding the Signed-off-by: line to a
> +    patch should be a conscious act and means that you certify you have
> +    the rights to submit this work under the same open source license.
> +    Please see the 'SubmittingPatches' document for further discussion.

I have a mixed feeling about this description. The existing description on the --signoff option merely talks about what it does, leaving what it means, and it is quite deliberate. If your project uses S-o-b, it may be useful. If yours doesn't, you simply just don't use it. It does not matter to _us_ as the document writer what that line means to your project.

We do want to make the reader think twice iff S-o-b is used in the reader's project with the same meaning as it means in git and the Linux kernel project, which is what the description you added is about. But should we just assume if anybody uses S-o-b convention in their project they must give it the same meaning as we give it?

The patch looks straightforward enough, and the wording we can update if somebody can come up with a better one, so I'll apply the patch to 'master' and we will go from there.

Thanks.