git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, "Elijah Newren" <newren@gmail.com>,
	"Martin Ågren" <martin.agren@gmail.com>,
	"Andrzej Hunt" <ajrhunt@google.com>, "Jeff King" <peff@peff.net>
Subject: Re: [PATCH v2 5/7] ls-files: fix a trivial dir_clear() leak
Date: Wed, 13 Oct 2021 15:39:55 +0200	[thread overview]
Message-ID: <8735p5hwg6.fsf@evledraar.gmail.com> (raw)
In-Reply-To: <xmqqily8o3kw.fsf@gitster.g>


On Thu, Oct 07 2021, Junio C Hamano wrote:

> Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:
>
>> This does add a bit of complexity, but I think it's worth it to just
>> fix these leaks when it's easy in built-ins. It allows them to serve
>> as canaries for underlying APIs that shouldn't be leaking, it
>> encourages us to make those freeing APIs nicer for all their users,
>> and it prevents other leaking regressions by being able to mark the
>> entire test as TEST_PASSES_SANITIZE_LEAK=true.
>
> This does more than necessary, though.  Introducing "ret", replacing
> an early return with an assignment to it, and returning "ret"
> instead of hardcoded 0, would have been the "fix a trivial leak",
> and the "ah, report_path_error() always returns true" does not
> belong here.
>
> These things look small, but small things add up.

I think you mean that you'd have liked:

diff --git a/builtin/ls-files.c b/builtin/ls-files.c
index a2000ed6bf2..5e6b6f2d4a0 100644
--- a/builtin/ls-files.c
+++ b/builtin/ls-files.c
@@ -672,6 +672,7 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
                         N_("suppress duplicate entries")),
                OPT_END()
        };
+       int ret = 0;
 
        if (argc == 2 && !strcmp(argv[1], "-h"))
                usage_with_options(ls_files_usage, builtin_ls_files_options);
@@ -776,15 +777,13 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
                show_ru_info(the_repository->index);
 
        if (ps_matched) {
-               int bad;
-               bad = report_path_error(ps_matched, &pathspec);
-               if (bad)
+               if (report_path_error(ps_matched, &pathspec)) {
                        fprintf(stderr, "Did you forget to 'git add'?\n");
-
-               return bad ? 1 : 0;
+                       ret = 1;
+               }
        }
 
        dir_clear(&dir);
        free(max_prefix);
-       return 0;
+       return ret;
 }

Instead of this:

diff --git a/builtin/ls-files.c b/builtin/ls-files.c
index a2000ed6bf2..fcc685947f9 100644
--- a/builtin/ls-files.c
+++ b/builtin/ls-files.c
@@ -672,6 +672,7 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
                         N_("suppress duplicate entries")),
                OPT_END()
        };
+       int ret = 0;
 
        if (argc == 2 && !strcmp(argv[1], "-h"))
                usage_with_options(ls_files_usage, builtin_ls_files_options);
@@ -775,16 +776,12 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
        if (show_resolve_undo)
                show_ru_info(the_repository->index);
 
-       if (ps_matched) {
-               int bad;
-               bad = report_path_error(ps_matched, &pathspec);
-               if (bad)
-                       fprintf(stderr, "Did you forget to 'git add'?\n");
-
-               return bad ? 1 : 0;
+       if (ps_matched && report_path_error(ps_matched, &pathspec)) {
+               fprintf(stderr, "Did you forget to 'git add'?\n");
+               ret = 1;
        }
 
        dir_clear(&dir);
        free(max_prefix);
-       return 0;
+       return ret;
 }

Doesn't make much sense, but I can re-roll with it if you feel strongly
about it. I think the current version is ready to be picked up.

Yeah we should avoid refactoring-while-at-it, but in cases where a patch
removes the only reason a nested if/if statement exists, unrolling it
into a single "if" handly seems too much. I think the alternative just
leaves the reader squinting at the diff wondering why we still need that
nesting...

  reply	other threads:[~2021-10-13 13:43 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-06 10:02 [PATCH 0/7] leak tests: fix "test-tool" & other small leaks Ævar Arnfjörð Bjarmason
2021-10-06 10:02 ` [PATCH 1/7] tests: fix a memory leak in test-prio-queue.c Ævar Arnfjörð Bjarmason
2021-10-06 10:02 ` [PATCH 2/7] tests: fix a memory leak in test-parse-options.c Ævar Arnfjörð Bjarmason
2021-10-06 16:37   ` Elijah Newren
2021-10-06 10:02 ` [PATCH 3/7] tests: fix a memory leak in test-oidtree.c Ævar Arnfjörð Bjarmason
2021-10-06 10:02 ` [PATCH 4/7] tests: fix test-oid-array leak, test in SANITIZE=leak Ævar Arnfjörð Bjarmason
2021-10-06 10:02 ` [PATCH 5/7] ls-files: fix a trivial dir_clear() leak Ævar Arnfjörð Bjarmason
2021-10-06 10:02 ` [PATCH 6/7] ls-files: add missing string_list_clear() Ævar Arnfjörð Bjarmason
2021-10-06 10:02 ` [PATCH 7/7] merge: add missing strbuf_release() Ævar Arnfjörð Bjarmason
2021-10-06 16:47 ` [PATCH 0/7] leak tests: fix "test-tool" & other small leaks Elijah Newren
2021-10-07 10:01 ` [PATCH v2 " Ævar Arnfjörð Bjarmason
2021-10-07 10:01   ` [PATCH v2 1/7] tests: fix a memory leak in test-prio-queue.c Ævar Arnfjörð Bjarmason
2021-10-07 10:01   ` [PATCH v2 2/7] tests: fix a memory leak in test-parse-options.c Ævar Arnfjörð Bjarmason
2021-10-07 10:01   ` [PATCH v2 3/7] tests: fix a memory leak in test-oidtree.c Ævar Arnfjörð Bjarmason
2021-10-07 10:01   ` [PATCH v2 4/7] tests: fix test-oid-array leak, test in SANITIZE=leak Ævar Arnfjörð Bjarmason
2021-10-07 10:01   ` [PATCH v2 5/7] ls-files: fix a trivial dir_clear() leak Ævar Arnfjörð Bjarmason
2021-10-07 22:46     ` Junio C Hamano
2021-10-13 13:39       ` Ævar Arnfjörð Bjarmason [this message]
2021-10-13 19:01         ` Junio C Hamano
2021-10-14  0:15           ` Ævar Arnfjörð Bjarmason
2021-10-14 17:38             ` Junio C Hamano
2021-10-07 10:01   ` [PATCH v2 6/7] ls-files: add missing string_list_clear() Ævar Arnfjörð Bjarmason
2021-10-07 10:01   ` [PATCH v2 7/7] merge: add missing strbuf_release() Ævar Arnfjörð Bjarmason

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8735p5hwg6.fsf@evledraar.gmail.com \
    --to=avarab@gmail.com \
    --cc=ajrhunt@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=martin.agren@gmail.com \
    --cc=newren@gmail.com \
    --cc=peff@peff.net \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).