From: Karthik Nayak <karthik.188@gmail.com>
To: karthik.188@gmail.com
Cc: git@vger.kernel.org, jltobler@gmail.com, toon@iotcl.com,
spectral@google.com
Subject: [PATCH v4 0/2] Subject: clang-format: fix rules to make the CI job cleaner
Date: Fri, 18 Oct 2024 10:46:44 +0200 [thread overview]
Message-ID: <cover.1729241030.git.karthik.188@gmail.com> (raw)
In-Reply-To: <CAOLa=ZRvFBhageS65uE5enzLBz7H_CAvvnEcPsi_QAi0exRx2w@mail.gmail.com>
The clang-format CI job is currently cluttered due to too many errors being
reported. See some of the examples here:
* https://gitlab.com/gitlab-org/git/-/jobs/7854601948
* https://gitlab.com/gitlab-org/git/-/jobs/7843131109
So modify the clang-format with the following changes:
1. Modify the penalties for linebreaks to be more considerate towards
readability. The commit goes into detail explaining how/why.
2. Align the macro definitions. This is something we follow to keep the macros
readable.
I will still keep monitoring the jobs from time to time to ensure we can fine
tune more as needed, if someone see's something odd, do keep me in the loop.
Thanks
Changes over the previous version:
1. I made the example in the first commit message a bit clearer so it is easier
to understand.
2. Removed the third commit, since I was convinced that it is good as-is for now.
Karthik Nayak (2):
clang-format: re-adjust line break penalties
clang-format: align consecutive macro definitions
.clang-format | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
Range-diff against v3:
1: 74bbd2f9db ! 1: a8c8df5d95 clang-format: re-adjust line break penalties
@@ Commit message
to instead have something more readable like:
static const struct strbuf *a_really_really_large_function_name(struct strbuf resolved,
- const char *path, int flags)
+ const char *path,
+ int flags)
+
+ (note: the tabs here have been replaced by spaces for easier reading)
This is done by bumping the values of 'PenaltyReturnTypeOnItsOwnLine'
and 'PenaltyBreakOpenParenthesis' to 300. This is so that we can allow a
2: 1586d53769 = 2: fcf965ac74 clang-format: align consecutive macro definitions
3: 36a53299c1 < -: ---------- clang-format: don't align expressions after linebreaks
--
2.47.0
next prev parent reply other threads:[~2024-10-18 8:46 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-09 12:51 [PATCH 0/3] clang-format: fix rules to make the CI job cleaner Karthik Nayak
2024-10-09 12:55 ` [PATCH 1/3] clang-format: don't enforce the column limit Karthik Nayak
2024-10-09 15:45 ` Justin Tobler
2024-10-09 22:32 ` Junio C Hamano
2024-10-10 16:48 ` karthik nayak
2024-10-09 12:56 ` [PATCH 2/3] clang-format: don't align expressions after linebreaks Karthik Nayak
2024-10-09 12:56 ` [PATCH 3/3] clang-format: align consecutive macro definitions Karthik Nayak
2024-10-10 8:27 ` Toon Claes
2024-10-10 17:59 ` [PATCH v2 0/3] clang-format: fix rules to make the CI job cleaner Karthik Nayak
2024-10-10 17:59 ` [PATCH v2 1/3] clang-format: change column limit to 96 characters Karthik Nayak
2024-10-10 18:11 ` Kyle Lippincott
2024-10-10 19:49 ` karthik nayak
2024-10-10 20:09 ` Kyle Lippincott
2024-10-10 17:59 ` [PATCH v2 2/3] clang-format: don't align expressions after linebreaks Karthik Nayak
2024-10-10 17:59 ` [PATCH v2 3/3] clang-format: align consecutive macro definitions Karthik Nayak
2024-10-12 1:49 ` [PATCH v3 0/3] clang-format: fix rules to make the CI job cleaner Karthik Nayak
2024-10-12 1:49 ` [PATCH v3 1/3] clang-format: re-adjust line break penalties Karthik Nayak
2024-10-14 9:08 ` Toon Claes
2024-10-14 21:14 ` Taylor Blau
2024-10-15 11:35 ` karthik nayak
2024-10-15 11:20 ` karthik nayak
2024-10-14 20:59 ` Kyle Lippincott
2024-10-15 12:37 ` karthik nayak
2024-10-16 1:38 ` Kyle Lippincott
2024-10-16 21:17 ` karthik nayak
2024-10-12 1:49 ` [PATCH v3 2/3] clang-format: align consecutive macro definitions Karthik Nayak
2024-10-14 21:12 ` Kyle Lippincott
2024-10-15 7:57 ` karthik nayak
2024-10-12 1:49 ` [PATCH v3 3/3] clang-format: don't align expressions after linebreaks Karthik Nayak
2024-10-14 21:23 ` Kyle Lippincott
2024-10-15 11:17 ` karthik nayak
2024-10-18 8:46 ` Karthik Nayak [this message]
2024-10-18 8:46 ` [PATCH v4 1/2] clang-format: re-adjust line break penalties Karthik Nayak
2024-10-25 2:37 ` Justin Tobler
2024-10-25 9:48 ` karthik nayak
2024-10-18 8:46 ` [PATCH v4 2/2] clang-format: align consecutive macro definitions Karthik Nayak
2024-10-18 21:37 ` [PATCH v4 0/2] Subject: clang-format: fix rules to make the CI job cleaner Taylor Blau
2024-10-20 11:17 ` karthik nayak
2024-10-21 21:48 ` Taylor Blau
2024-10-22 8:31 ` karthik nayak
2024-10-22 16:42 ` Taylor Blau
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=cover.1729241030.git.karthik.188@gmail.com \
--to=karthik.188@gmail.com \
--cc=git@vger.kernel.org \
--cc=jltobler@gmail.com \
--cc=spectral@google.com \
--cc=toon@iotcl.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).