From: Junio C Hamano <gitster@pobox•com>
To: Stephan Beyer <s-beyer@gmx•net>
Cc: Jonathan Nieder <jrnieder@gmail•com>,
git@vger•kernel.org,
Johannes Schindelin <johannes.schindelin@gmx•de>
Subject: Re: [PATCH] Add a comment to .clang-format about the meaning of the file
Date: Sun, 01 Oct 2017 11:45:21 +0900 [thread overview]
Message-ID: <xmqqy3ovvb5q.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170930213731.27133-1-s-beyer@gmx.net> (Stephan Beyer's message of "Sat, 30 Sep 2017 23:37:31 +0200")
Stephan Beyer <s-beyer@gmx•net> writes:
> Having a .clang-format file in a project can be understood in a way that code
> has to be in the style defined by the .clang-format file, i.e., you just have
> to run clang-format over all code and you are set. This is not the case in the
> Git project, which is now reflected by an comment in the beginning of the file.
>
> Additionally, the working clang-format version is mentioned because the config
> directives change from time to time (in a compatibility-breaking way).
>
> Signed-off-by: Stephan Beyer <s-beyer@gmx•net>
> ---
>
> Notes:
> On 09/30/2017 12:45 AM, Jonathan Nieder wrote:
> > Sounds good to me. Care to send it as a patch? :)
>
> Like this? :)
>
> .clang-format | 6 +++++-
> 1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/.clang-format b/.clang-format
> index 3ede2628d..558fc7fd8 100644
> --- a/.clang-format
> +++ b/.clang-format
> @@ -1,4 +1,8 @@
> -# Defaults
> +# This file is an example configuration for clang-format 5.0.
> +#
> +# Note that this style definition should only be understood as a hint
> +# for writing new code. Most of Git's codebase does not conform to
> +# this definition.
I think this makes 50%-80% sense. As we have just seen in the patch
that started this thread, the rules currently in this file is known
not to be perfect (and I do not think the patch was meant to make,
or claimed that it has made, the rules perfect---it was to fix the
most problematic part that was observed and is a good incremental
improvement), so we should treat it as such. "does not conform to"
does not convey that--it makes as if a random patch to "make it
conform" without thinking if the rules make sense were a welcome
addition, which is absolutely the last signal we would want to send
to the readers.
next prev parent reply other threads:[~2017-10-01 2:45 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-29 18:26 [PATCH] clang-format: adjust line break penalties Johannes Schindelin
2017-09-29 18:40 ` Jonathan Nieder
2017-09-29 19:50 ` Brandon Williams
2017-09-29 22:39 ` Stephan Beyer
2017-09-29 22:45 ` Jonathan Nieder
2017-09-30 21:37 ` [PATCH] Add a comment to .clang-format about the meaning of the file Stephan Beyer
2017-10-01 2:45 ` Junio C Hamano [this message]
2017-10-01 15:44 ` [PATCH v2] " Stephan Beyer
2017-10-01 20:30 ` Junio C Hamano
2017-10-01 21:29 ` Stephan Beyer
2017-10-01 23:37 ` [PATCH v3] clang-format: add a comment about the meaning/status of the Junio C Hamano
2017-10-02 17:16 ` Stephan Beyer
2017-10-02 17:21 ` Brandon Williams
2017-10-03 1:08 ` Ramsay Jones
2017-10-01 2:40 ` [PATCH] clang-format: adjust line break penalties Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqy3ovvb5q.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=johannes.schindelin@gmx$(echo .)de \
--cc=jrnieder@gmail$(echo .)com \
--cc=s-beyer@gmx$(echo .)net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox