chore: fix typo in .clang-format comment

Commit Message

Aditya Neelamraju Oct. 29, 2023, 8:23 p.m. UTC

From: Aditya Neelamraju <[e-mail]>

Signed-off-by: Aditya Neelamraju <[e-mail]>
---
    chore: fix typo in .clang-format comment

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1602%2Faneelamr%2Fclang-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1602/aneelamr/clang-v1
Pull-Request: https://github.com/git/git/pull/1602

 .clang-format | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)


base-commit: 2e8e77cbac8ac17f94eee2087187fa1718e38b14

Comments

Taylor Blau Oct. 30, 2023, 4:56 p.m. UTC | #1

On Sun, Oct 29, 2023 at 08:23:07PM +0000, Aditya Neelamraju via GitGitGadget wrote:
> From: Aditya Neelamraju <[e-mail]>

We typically prefix commit messages with the subject area they're
working in, not with "chore", or "feat" like some Git workflows
recommend.

That said, the contents of this patch look obviously correct to me.
Thanks for noticing and fixing!

Thanks,
Taylor

Junio C Hamano Oct. 31, 2023, 3:12 a.m. UTC | #2

Taylor Blau <[e-mail]> writes:

> On Sun, Oct 29, 2023 at 08:23:07PM +0000, Aditya Neelamraju via GitGitGadget wrote:
>> From: Aditya Neelamraju <[e-mail]>
>
> We typically prefix commit messages with the subject area they're
> working in, not with "chore", or "feat" like some Git workflows
> recommend.
> ...
> That said, the contents of this patch look obviously correct to me.
> Thanks for noticing and fixing!

As a comment for a new contributor, it is a bit unhelpful not to
suggest what the "subject area" string we would use if we were
working on this patch, I think.

I also suspected that valuve may be a valid word in some language,
as the indentation in the example looked as if the six-letter word
was meant, not typoed.  https://www.gasolineravaluve.com/ was one
of the first hits I saw in my search ;-)

Taylor Blau Oct. 31, 2023, 7:09 p.m. UTC | #3

On Tue, Oct 31, 2023 at 12:12:43PM +0900, Junio C Hamano wrote:
> Taylor Blau <[e-mail]> writes:
>
> > On Sun, Oct 29, 2023 at 08:23:07PM +0000, Aditya Neelamraju via GitGitGadget wrote:
> >> From: Aditya Neelamraju <[e-mail]>
> >
> > We typically prefix commit messages with the subject area they're
> > working in, not with "chore", or "feat" like some Git workflows
> > recommend.
> > ...
> > That said, the contents of this patch look obviously correct to me.
> > Thanks for noticing and fixing!
>
> As a comment for a new contributor, it is a bit unhelpful not to
> suggest what the "subject area" string we would use if we were
> working on this patch, I think.

Good suggestion. I would have suggested "clang-format", which is
exactly Aditya ended up choosing, anyway. Thanks, Aditya!

> I also suspected that valuve may be a valid word in some language,
> as the indentation in the example looked as if the six-letter word
> was meant, not typoed.  https://www.gasolineravaluve.com/ was one
> of the first hits I saw in my search ;-)

;-)

Thanks,
Taylor

Junio C Hamano Oct. 31, 2023, 11:40 p.m. UTC | #4

Taylor Blau <[e-mail]> writes:

>> As a comment for a new contributor, it is a bit unhelpful not to
>> suggest what the "subject area" string we would use if we were
>> working on this patch, I think.
>
> Good suggestion. I would have suggested "clang-format", which is
> exactly Aditya ended up choosing, anyway. Thanks, Aditya!

Thanks.  I was being lazy when I said the above ;-)

Teaching how to fish instead of giving fish, the way I would have
done is

   $ git log --no-merges --stat --full-diff .clang-format

and inspect what they use.  The ones that used "clang-format:" are
indeed very similar in spirit to what this one does, I would say.

Thanks.

Patch

diff --git a/.clang-format b/.clang-format
index c592dda681f..3ed4fac753a 100644
--- a/.clang-format
+++ b/.clang-format
@@ -83,9 +83,9 @@  BinPackParameters: true
 BreakBeforeBraces: Linux
 
 # Break after operators
-# int valuve = aaaaaaaaaaaaa +
-#              bbbbbb -
-#              ccccccccccc;
+# int value = aaaaaaaaaaaaa +
+#             bbbbbb -
+#             ccccccccccc;
 BreakBeforeBinaryOperators: None
 BreakBeforeTernaryOperators: false