From: Eric Sunshine <sunshine@sunshineco.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Christian Couder <christian.couder@gmail.com>,
Shourya Shukla <shouryashukla.oo@gmail.com>,
chrisitan.couder@gmail.com, Denton Liu <liu.denton@gmail.com>,
git <git@vger.kernel.org>
Subject: Re: Re* [PATCH v4] submodule: port subcommand 'set-url' from shell to C
Date: Fri, 8 May 2020 12:13:15 -0400 [thread overview]
Message-ID: <20200508161315.GA3504@flurp.local> (raw)
In-Reply-To: <xmqqpnbezaga.fsf@gitster.c.googlers.com>
On Fri, May 08, 2020 at 08:57:09AM -0700, Junio C Hamano wrote:
> Eric Sunshine <sunshine@sunshineco.com> writes:
> > This talks only about '=='.
>
> Yup. The text would need a matching change, though.
Here's a re-roll with the necessary changes.
> > if (!ptr)
> > BUG("...");
> > if (cnt)
> > foo(ptr, cnt);
>
> Or more succinctly:
>
> if (!ptr || cnt)
> BUG("we must have an empty array at this point");
I considered that but thought it might be too "cute", however, seeing
it written out, it looks fine, so I used it in the re-roll.
> > Also, would you want to talk about not comparing against NUL character?
>
> Yeah, it might be worth saying it explicitly. I dunno.
Rather than giving this a separate example in the re-roll, I just
mentioned '\0' in the text.
--- >8 ---
From: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] CodingGuidelines: do not ==/!= compare with 0 or '\0' or NULL
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
Documentation/CodingGuidelines | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 390ceece52..6dfc47ed7d 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -236,6 +236,18 @@ For C programs:
while( condition )
func (bar+1);
+ - Do not explicitly compare an integral value with constant 0 or '\0',
+ or a pointer value with constant NULL. For instance, to validate a
+ counted array ptr that has cnt elements, write:
+
+ if (!ptr || cnt)
+ BUG("empty array expected");
+
+ and not:
+
+ if (ptr == NULL || cnt != 0);
+ BUG("empty array expected");
+
- We avoid using braces unnecessarily. I.e.
if (bla) {
--
2.26.2.717.g5cccb0e1a8
next prev parent reply other threads:[~2020-05-08 16:13 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-06 7:37 [PATCH v4] submodule: port subcommand 'set-url' from shell to C Shourya Shukla
2020-05-06 8:09 ` Christian Couder
2020-05-06 16:31 ` Shourya Shukla
2020-05-06 17:16 ` Junio C Hamano
2020-05-06 17:12 ` Junio C Hamano
2020-05-06 18:12 ` Shourya Shukla
2020-05-06 18:22 ` Junio C Hamano
2020-05-07 4:40 ` Shourya Shukla
2020-05-07 5:08 ` Junio C Hamano
2020-05-08 5:47 ` Shourya Shukla
2020-05-08 6:18 ` Christian Couder
2020-05-08 15:18 ` Re* " Junio C Hamano
2020-05-08 15:38 ` Eric Sunshine
2020-05-08 15:57 ` Junio C Hamano
2020-05-08 16:13 ` Eric Sunshine [this message]
2020-05-08 16:38 ` Junio C Hamano
2020-05-08 17:51 ` Eric Sunshine
2020-05-08 6:21 ` [PATCH v5] " Shourya Shukla
2020-05-08 6:30 ` Denton Liu
2020-05-08 16:13 ` Junio C Hamano
2020-05-08 16:17 ` Junio C Hamano
2020-05-08 16:18 ` [PATCH v6] " 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=20200508161315.GA3504@flurp.local \
--to=sunshine@sunshineco.com \
--cc=chrisitan.couder@gmail.com \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=liu.denton@gmail.com \
--cc=shouryashukla.oo@gmail.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).