From: Junio C Hamano <gitster@pobox.com>
To: Elijah Newren <newren@gmail.com>
Cc: "Elijah Newren via GitGitGadget" <gitgitgadget@gmail.com>,
"Git Mailing List" <git@vger.kernel.org>,
"Jeff King" <peff@peff.net>,
"Jonathan Nieder" <jrnieder@gmail.com>,
"Sergey Organov" <sorganov@gmail.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Neeraj Singh" <nksingh85@gmail.com>
Subject: Re: [PATCH 1/9] tmp_objdir: add a helper function for discarding all contained objects
Date: Tue, 21 Dec 2021 22:23:51 -0800 [thread overview]
Message-ID: <xmqqlf0dkvig.fsf@gitster.g> (raw)
In-Reply-To: <CABPp-BEuzorQkesgyNCvS05wsfqaH4Yv5JDFgy+AenrAC+JJNQ@mail.gmail.com> (Elijah Newren's message of "Tue, 21 Dec 2021 15:51:35 -0800")
Elijah Newren <newren@gmail.com> writes:
>> > +void tmp_objdir_discard_objects(struct tmp_objdir *t)
>> > +{
>> > + remove_dir_recursively(&t->path, REMOVE_DIR_KEEP_TOPLEVEL);
>> > +}
>> > +
>>
>> OK.
>>
>> Without a caller, it is a bit hard to judge if a separate helper
>> makes the caller easier to read and understand, or becomes an extra
>> layer of abstraction that obscures the logic. Hopefully, having a
>> more specific function name with "tmp" and "discard" in it makes the
>> intent at callers more clear than the function that is named after
>> the detail of the operation.
>
> This isn't just a convenience; since tmp_objdir is defined in
> tmp-objdir.c rather than tmp-objdir.h, t->path is not accessible
> outside of tmp-objdir.c. Because of this, some kind of helper
> function is necessary.
But adding this function as an extra level of abstration is *not*
the only way to expose the feature. Instead the internal of "struct
tmp_objdir" could be exposed to the caller that wants to discard the
files inside the path.
I think we now have enough material to fill between these two lines
to help readers ;-)
>> > From: Elijah Newren <newren@gmail.com>
>> >
>> > Signed-off-by: Elijah Newren <newren@gmail.com>
Thanks.
next prev parent reply other threads:[~2021-12-22 6:23 UTC|newest]
Thread overview: 113+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-21 18:05 [PATCH 0/9] Add a new --remerge-diff capability to show & log Elijah Newren via GitGitGadget
2021-12-21 18:05 ` [PATCH 1/9] tmp_objdir: add a helper function for discarding all contained objects Elijah Newren via GitGitGadget
2021-12-21 23:26 ` Junio C Hamano
2021-12-21 23:51 ` Elijah Newren
2021-12-22 6:23 ` Junio C Hamano [this message]
2021-12-25 2:29 ` Elijah Newren
2021-12-21 18:05 ` [PATCH 2/9] ll-merge: make callers responsible for showing warnings Elijah Newren via GitGitGadget
2021-12-21 21:19 ` Ævar Arnfjörð Bjarmason
2021-12-21 21:57 ` Elijah Newren
2021-12-21 23:02 ` Ævar Arnfjörð Bjarmason
2021-12-21 23:15 ` Elijah Newren
2021-12-21 23:44 ` Junio C Hamano
2021-12-23 18:26 ` Elijah Newren
2021-12-21 18:05 ` [PATCH 3/9] merge-ort: capture and print ll-merge warnings in our preferred fashion Elijah Newren via GitGitGadget
2021-12-22 0:00 ` Junio C Hamano
2021-12-23 18:36 ` Elijah Newren
2021-12-21 18:05 ` [PATCH 4/9] merge-ort: mark a few more conflict messages as omittable Elijah Newren via GitGitGadget
2021-12-22 0:06 ` Junio C Hamano
2021-12-23 18:38 ` Elijah Newren
2021-12-21 18:05 ` [PATCH 5/9] merge-ort: make path_messages available to external callers Elijah Newren via GitGitGadget
2021-12-21 18:05 ` [PATCH 6/9] diff: add ability to insert additional headers for paths Elijah Newren via GitGitGadget
2021-12-22 0:24 ` Junio C Hamano
2021-12-25 2:35 ` Elijah Newren
2021-12-21 18:05 ` [PATCH 7/9] merge-ort: format messages slightly different for use in headers Elijah Newren via GitGitGadget
2021-12-21 18:05 ` [PATCH 8/9] show, log: provide a --remerge-diff capability Elijah Newren via GitGitGadget
2021-12-21 21:23 ` Ævar Arnfjörð Bjarmason
2021-12-21 22:18 ` Elijah Newren
2021-12-21 18:05 ` [PATCH 9/9] doc/diff-options: explain the new --remerge-diff option Elijah Newren via GitGitGadget
2021-12-21 21:28 ` Ævar Arnfjörð Bjarmason
2021-12-21 22:24 ` Elijah Newren
2021-12-21 23:47 ` Ævar Arnfjörð Bjarmason
2021-12-22 19:05 ` Elijah Newren
2021-12-21 23:20 ` [PATCH 0/9] Add a new --remerge-diff capability to show & log Junio C Hamano
2021-12-21 23:43 ` Elijah Newren
2021-12-22 0:33 ` Junio C Hamano
2021-12-25 7:59 ` [PATCH v2 0/8] " Elijah Newren via GitGitGadget
2021-12-25 7:59 ` [PATCH v2 1/8] show, log: provide a --remerge-diff capability Elijah Newren via GitGitGadget
2021-12-28 10:56 ` Johannes Altmanninger
2021-12-28 22:34 ` Elijah Newren
2021-12-28 23:01 ` brian m. carlson
2021-12-28 23:45 ` Elijah Newren
2021-12-25 7:59 ` [PATCH v2 2/8] log: clean unneeded objects during `log --remerge-diff` Elijah Newren via GitGitGadget
2021-12-25 7:59 ` [PATCH v2 3/8] ll-merge: make callers responsible for showing warnings Elijah Newren via GitGitGadget
2021-12-28 10:56 ` Johannes Altmanninger
2021-12-28 19:37 ` Elijah Newren
2021-12-28 22:05 ` Johannes Altmanninger
2021-12-25 7:59 ` [PATCH v2 4/8] merge-ort: capture and print ll-merge warnings in our preferred fashion Elijah Newren via GitGitGadget
2021-12-25 7:59 ` [PATCH v2 5/8] merge-ort: mark a few more conflict messages as omittable Elijah Newren via GitGitGadget
2021-12-25 7:59 ` [PATCH v2 6/8] merge-ort: format messages slightly different for use in headers Elijah Newren via GitGitGadget
2021-12-26 18:30 ` In-tree strbuf "in-place" search/replace (was: [PATCH v2 6/8] merge-ort: format messages slightly different for use in headers) Ævar Arnfjörð Bjarmason
2021-12-28 10:56 ` [PATCH v2 6/8] merge-ort: format messages slightly different for use in headers Johannes Altmanninger
2021-12-28 21:48 ` Elijah Newren
2021-12-25 7:59 ` [PATCH v2 7/8] diff: add ability to insert additional headers for paths Elijah Newren via GitGitGadget
2021-12-28 10:57 ` Johannes Altmanninger
2021-12-28 21:09 ` Elijah Newren
2021-12-29 0:16 ` Johannes Altmanninger
2021-12-30 22:04 ` Elijah Newren
2021-12-31 3:07 ` Johannes Altmanninger
2021-12-25 7:59 ` [PATCH v2 8/8] show, log: include conflict/warning messages in --remerge-diff headers Elijah Newren via GitGitGadget
2021-12-28 10:57 ` Johannes Altmanninger
2021-12-28 23:42 ` Elijah Newren
2021-12-26 21:52 ` [PATCH v2 0/8] Add a new --remerge-diff capability to show & log Ævar Arnfjörð Bjarmason
2021-12-27 21:11 ` Elijah Newren
2022-01-10 15:48 ` Ævar Arnfjörð Bjarmason
2021-12-28 10:55 ` Johannes Altmanninger
2021-12-30 23:36 ` [PATCH v3 0/9] " Elijah Newren via GitGitGadget
2021-12-30 23:36 ` [PATCH v3 1/9] show, log: provide a --remerge-diff capability Elijah Newren via GitGitGadget
2022-01-19 15:49 ` Ævar Arnfjörð Bjarmason
2022-01-20 2:31 ` Elijah Newren
2022-01-20 7:53 ` Elijah Newren
2022-01-19 16:01 ` Ævar Arnfjörð Bjarmason
2022-01-20 2:33 ` Elijah Newren
2021-12-30 23:36 ` [PATCH v3 2/9] log: clean unneeded objects during `log --remerge-diff` Elijah Newren via GitGitGadget
2021-12-30 23:36 ` [PATCH v3 3/9] ll-merge: make callers responsible for showing warnings Elijah Newren via GitGitGadget
2022-01-19 16:41 ` Ævar Arnfjörð Bjarmason
2022-01-20 3:29 ` Elijah Newren
2021-12-30 23:36 ` [PATCH v3 4/9] merge-ort: capture and print ll-merge warnings in our preferred fashion Elijah Newren via GitGitGadget
2021-12-30 23:36 ` [PATCH v3 5/9] merge-ort: mark a few more conflict messages as omittable Elijah Newren via GitGitGadget
2021-12-30 23:36 ` [PATCH v3 6/9] merge-ort: format messages slightly different for use in headers Elijah Newren via GitGitGadget
2021-12-30 23:36 ` [PATCH v3 7/9] diff: add ability to insert additional headers for paths Elijah Newren via GitGitGadget
2021-12-30 23:36 ` [PATCH v3 8/9] show, log: include conflict/warning messages in --remerge-diff headers Elijah Newren via GitGitGadget
2022-01-19 16:19 ` Ævar Arnfjörð Bjarmason
2022-01-21 2:16 ` Elijah Newren
2022-01-21 16:55 ` Elijah Newren
2021-12-30 23:36 ` [PATCH v3 9/9] merge-ort: mark conflict/warning messages from inner merges as omittable Elijah Newren via GitGitGadget
2021-12-31 8:46 ` [PATCH v3 0/9] Add a new --remerge-diff capability to show & log Junio C Hamano
2022-01-21 19:12 ` [PATCH v4 00/10] " Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 01/10] show, log: provide a --remerge-diff capability Elijah Newren via GitGitGadget
2022-02-01 9:09 ` Ævar Arnfjörð Bjarmason
2022-02-01 16:40 ` Elijah Newren
2022-01-21 19:12 ` [PATCH v4 02/10] log: clean unneeded objects during `log --remerge-diff` Elijah Newren via GitGitGadget
2022-02-01 9:35 ` Ævar Arnfjörð Bjarmason
2022-02-01 16:54 ` Elijah Newren
2022-02-02 11:17 ` Ævar Arnfjörð Bjarmason
2022-01-21 19:12 ` [PATCH v4 03/10] ll-merge: make callers responsible for showing warnings Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 04/10] merge-ort: capture and print ll-merge warnings in our preferred fashion Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 05/10] merge-ort: mark a few more conflict messages as omittable Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 06/10] merge-ort: format messages slightly different for use in headers Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 07/10] diff: add ability to insert additional headers for paths Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 08/10] show, log: include conflict/warning messages in --remerge-diff headers Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 09/10] merge-ort: mark conflict/warning messages from inner merges as omittable Elijah Newren via GitGitGadget
2022-01-21 19:12 ` [PATCH v4 10/10] diff-merges: avoid history simplifications when diffing merges Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 00/10] Add a new --remerge-diff capability to show & log Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 01/10] show, log: provide a --remerge-diff capability Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 02/10] log: clean unneeded objects during `log --remerge-diff` Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 03/10] ll-merge: make callers responsible for showing warnings Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 04/10] merge-ort: capture and print ll-merge warnings in our preferred fashion Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 05/10] merge-ort: mark a few more conflict messages as omittable Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 06/10] merge-ort: format messages slightly different for use in headers Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 07/10] diff: add ability to insert additional headers for paths Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 08/10] show, log: include conflict/warning messages in --remerge-diff headers Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 09/10] merge-ort: mark conflict/warning messages from inner merges as omittable Elijah Newren via GitGitGadget
2022-02-02 2:37 ` [PATCH v5 10/10] diff-merges: avoid history simplifications when diffing merges Elijah Newren via GitGitGadget
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=xmqqlf0dkvig.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=jrnieder@gmail.com \
--cc=newren@gmail.com \
--cc=nksingh85@gmail.com \
--cc=peff@peff.net \
--cc=sorganov@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.