git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 5/7] ls-files: fix a trivial dir_clear() leak

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Oct 13, 2021, 13:39 UTC
Message-ID
<8735p5hwg6.fsf@evledraar.gmail.com>
In-Reply-To
<xmqqily8o3kw.fsf@gitster.g>
On Thu, Oct 07 2021, Junio C Hamano wrote:
Show 16 quoted lines
> Æ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...
Previous: Junio C HamanoNext: Junio C Hamano
Message 20 of 23 in “leak tests: fix "test-tool" & other small leaks”
  1. 0/7 leak tests: fix "test-tool" & other small leaksÆvar Arnfjörð Bjarmason, Oct 6, 2021
  2. 1/7 tests: fix a memory leak in test-prio-queue.cÆvar Arnfjörð Bjarmason, Oct 6, 2021
  3. 2/7 tests: fix a memory leak in test-parse-options.cÆvar Arnfjörð Bjarmason, Oct 6, 2021
  4. Elijah NewrenOct 6, 2021
  5. 3/7 tests: fix a memory leak in test-oidtree.cÆvar Arnfjörð Bjarmason, Oct 6, 2021
  6. 5/7 ls-files: fix a trivial dir_clear() leakÆvar Arnfjörð Bjarmason, Oct 6, 2021
  7. 4/7 tests: fix test-oid-array leak, test in SANITIZE=leakÆvar Arnfjörð Bjarmason, Oct 6, 2021
  8. 6/7 ls-files: add missing string_list_clear()Ævar Arnfjörð Bjarmason, Oct 6, 2021
  9. 7/7 merge: add missing strbuf_release()Ævar Arnfjörð Bjarmason, Oct 6, 2021
  10. Elijah NewrenOct 6, 2021
  11. 0/7 leak tests: fix "test-tool" & other small leaksÆvar Arnfjörð Bjarmason, Oct 7, 2021
  12. 1/7 tests: fix a memory leak in test-prio-queue.cÆvar Arnfjörð Bjarmason, Oct 7, 2021
  13. 2/7 tests: fix a memory leak in test-parse-options.cÆvar Arnfjörð Bjarmason, Oct 7, 2021
  14. 3/7 tests: fix a memory leak in test-oidtree.cÆvar Arnfjörð Bjarmason, Oct 7, 2021
  15. 4/7 tests: fix test-oid-array leak, test in SANITIZE=leakÆvar Arnfjörð Bjarmason, Oct 7, 2021
  16. 7/7 merge: add missing strbuf_release()Ævar Arnfjörð Bjarmason, Oct 7, 2021
  17. 6/7 ls-files: add missing string_list_clear()Ævar Arnfjörð Bjarmason, Oct 7, 2021
  18. 5/7 ls-files: fix a trivial dir_clear() leakÆvar Arnfjörð Bjarmason, Oct 7, 2021
  19. Junio C HamanoOct 7, 2021
  20. Ævar Arnfjörð BjarmasonOct 13, 2021
  21. Junio C HamanoOct 13, 2021
  22. Ævar Arnfjörð BjarmasonOct 14, 2021
  23. Junio C HamanoOct 14, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.