diff options
| author | Martin Ågren <martin.agren@gmail.com> | 2017-09-23 01:34:51 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-09-24 10:05:57 +0900 |
| commit | b2ccdf7fc15e866a883b706540055b5d05fb9aef (patch) | |
| tree | 971aea7e1716ea78dbcf3de8d9baf353d019dab3 /revision.h | |
| parent | cb7b29eb67772d08e2365ed07ede9d954d0344c1 (diff) | |
| download | git-b2ccdf7fc15e866a883b706540055b5d05fb9aef.tar.gz git-b2ccdf7fc15e866a883b706540055b5d05fb9aef.tar.xz | |
leak_pending: use `object_array_clear()`, not `free()`
Setting `leak_pending = 1` tells `prepare_revision_walk()` not to
release the `pending` array, and makes that the caller's responsibility.
See 4a43d374f (revision: add leak_pending flag, 2011-10-01) and
353f5657a (bisect: use leak_pending flag, 2011-10-01).
Commit 1da1e07c8 (clean up name allocation in prepare_revision_walk,
2014-10-15) fixed a memory leak in `prepare_revision_walk()` by
switching from `free()` to `object_array_clear()`. However, where we use
the `leak_pending`-mechanism, we're still only calling `free()`.
Use `object_array_clear()` instead. Copy some helpful comments from
353f5657a to the other callers that we update to clarify the memory
responsibilities, and to highlight that the commits are not affected
when we clear the array -- it is indeed correct to both tidy up the
commit flags and clear the object array.
Document `leak_pending` in revision.h to help future users get this
right.
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Reviewed-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'revision.h')
| -rw-r--r-- | revision.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/revision.h b/revision.h index bc18487d6..3162cc78e 100644 --- a/revision.h +++ b/revision.h @@ -149,6 +149,17 @@ struct rev_info { date_mode_explicit:1, preserve_subject:1; unsigned int disable_stdin:1; + /* + * Set `leak_pending` to prevent `prepare_revision_walk()` from clearing + * the array of pending objects (`pending`). It will still forget about + * the array and its entries, so they really are leaked. This can be + * useful if the `struct object_array` `pending` is copied before + * calling `prepare_revision_walk()`. By setting `leak_pending`, you + * effectively claim ownership of the old array, so you should most + * likely call `object_array_clear(&pending_copy)` once you are done. + * Observe that this is about ownership of the array and its entries, + * not the commits referenced by those entries. + */ unsigned int leak_pending:1; /* --show-linear-break */ unsigned int track_linear:1, |