From: Stefan Beller <sbeller@google.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>,
"brian m. carlson" <sandals@crustytoothpaste.net>,
Jonathan Nieder <jrnieder@gmail.com>,
Brandon Williams <bmwill@google.com>
Subject: Re: [PATCH 05/15] connect_work_tree_and_git_dir: safely create leading directories
Date: Thu, 16 Feb 2017 13:16:34 -0800 [thread overview]
Message-ID: <CAGZ79kbMmPQ1ZxtdaoFof36g1An-xsAx85etiskirJfY4tGHaQ@mail.gmail.com> (raw)
In-Reply-To: <xmqqh93tx3f3.fsf@gitster.mtv.corp.google.com>
On Thu, Feb 16, 2017 at 12:54 PM, Junio C Hamano <gitster@pobox.com> wrote:
> Stefan Beller <sbeller@google.com> writes:
>
>> In a later patch we'll use connect_work_tree_and_git_dir when the
>> directory for the gitlink file doesn't exist yet. Safely create
>> the directory first.
>>
>> One of the two users of 'connect_work_tree_and_git_dir' already checked
>> for the directory being there, so we can loose that check.
>>
>> Signed-off-by: Stefan Beller <sbeller@google.com>
>> ---
>> dir.c | 32 +++++++++++++++++++++-----------
>> submodule.c | 11 ++---------
>> 2 files changed, 23 insertions(+), 20 deletions(-)
>>
>> diff --git a/dir.c b/dir.c
>> index 4541f9e146..6f52af7abb 100644
>> --- a/dir.c
>> +++ b/dir.c
>> @@ -2728,23 +2728,33 @@ void untracked_cache_add_to_index(struct index_state *istate,
>> /* Update gitfile and core.worktree setting to connect work tree and git dir */
>> void connect_work_tree_and_git_dir(const char *work_tree_, const char *git_dir_)
>> {
>> - struct strbuf file_name = STRBUF_INIT;
>> + struct strbuf gitfile_sb = STRBUF_INIT;
>> + struct strbuf cfg_sb = STRBUF_INIT;
>> struct strbuf rel_path = STRBUF_INIT;
>> - char *git_dir = real_pathdup(git_dir_);
>> - char *work_tree = real_pathdup(work_tree_);
>> + char *git_dir, *work_tree;
>>
>> - /* Update gitfile */
>> - strbuf_addf(&file_name, "%s/.git", work_tree);
>> - write_file(file_name.buf, "gitdir: %s",
>> - relative_path(git_dir, work_tree, &rel_path));
>> + /* Prepare .git file */
>> + strbuf_addf(&gitfile_sb, "%s/.git", work_tree_);
>> + if (safe_create_leading_directories_const(gitfile_sb.buf))
>> + die(_("could not create directories for %s"), gitfile_sb.buf);
>> +
>> + /* Prepare config file */
>> + strbuf_addf(&cfg_sb, "%s/config", git_dir_);
>> + if (safe_create_leading_directories_const(cfg_sb.buf))
>> + die(_("could not create directories for %s"), cfg_sb.buf);
>>
>> + git_dir = real_pathdup(git_dir_);
>> + work_tree = real_pathdup(work_tree_);
>> +
>> + /* Write .git file */
>> + write_file(gitfile_sb.buf, "gitdir: %s",
>> + relative_path(git_dir, work_tree, &rel_path));
>
> The above does somewhat more than advertised and was a bit hard to
> grok. Initially I thought the reason why pathdup()s were delayed
> was perhaps because you pathdup() something potentially different
> from the given parameter to the function (i.e. new code before
> pathdup() may tweak what is pathdup()ed).
>
> But that is not what is happening. I suspect that you did this to
> avoid leaking allocated memory when the code calls die().
That is not what is happening, either.
AFAICT real_pathdup resolves a path to its real path. But the path
*must* exist already (except the very last part, i.e. the file name).
So the SCLD must come before the real_pathdup, which has to come
before its consumers, which are the relative_path calls for write_file
as well as git_config_set_in_file.
So structurally we need to:
1a) construct $GIT_DIR/modules/<name>/config
1b) SCLD 1a)
1c) get absolute path of 1a)
2a) construct <submodule path>/.git file
2b) SCLD 2a)
2c) get absolute path of 2a)
3) compute relative path of 1c and 2c
both ways, write to appropriate places.
I chose to structure it as:
1a
1b
2a
2b
1c
2c
3
because the a/b steps seemed very related and the order is valid.
>
> If the code was written like so from the beginning, I do not see a
> reason to move the pathdup() up to deliberately make it leak [*1*].
> But as a part of this change, I found it distracting and getting in
> the way of understanding the change. If you really care, it is
> nicer to do it to reviewers as a separate preparatory clean-up step,
> or follow-up standalone clean-up patch after the series settles.
I considered doing it in multiple patches as we have different things
going on here:
1) as the commit claims have SCLD in connect_work_tree_and_git_dir
2) keep the dependencies of SCLD and real_pathdup in order. C.f.
the deleted lines of code in submodule.c
> It is a good thing to do to make sure git_dir_ exists and it should
> be mentioned in the log message. Adding "Do the same for the place
> where the per-repo config file is created". at the end of the first
> paragraph should be sufficient.
>
will do.
Thanks for thorough review!
Stefan
next prev parent reply other threads:[~2017-02-16 21:16 UTC|newest]
Thread overview: 94+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-15 0:34 [RFCv3 PATCH 00/14] Checkout aware of Submodules! Stefan Beller
2017-02-15 0:34 ` [PATCH 01/14] lib-submodule-update.sh: reorder create_lib_submodule_repo Stefan Beller
2017-02-15 1:44 ` brian m. carlson
2017-02-15 0:34 ` [PATCH 02/14] lib-submodule-update.sh: define tests for recursing into submodules Stefan Beller
2017-02-15 16:51 ` Brandon Williams
2017-02-15 18:52 ` Stefan Beller
2017-02-15 0:34 ` [PATCH 03/14] make is_submodule_populated gently Stefan Beller
2017-02-15 18:10 ` Junio C Hamano
2017-02-15 22:42 ` Stefan Beller
2017-02-15 0:34 ` [PATCH 04/14] connect_work_tree_and_git_dir: safely create leading directories Stefan Beller
2017-02-15 18:22 ` Junio C Hamano
2017-02-15 22:52 ` Stefan Beller
2017-02-15 23:19 ` Junio C Hamano
2017-02-15 0:34 ` [PATCH 05/14] update submodules: add submodule config parsing Stefan Beller
2017-02-15 18:29 ` Junio C Hamano
2017-02-15 0:34 ` [PATCH 06/14] update submodules: add a config option to determine if submodules are updated Stefan Beller
2017-02-15 0:34 ` [PATCH 07/14] update submodules: introduce is_interesting_submodule Stefan Beller
2017-02-15 17:04 ` Brandon Williams
2017-02-15 18:46 ` Stefan Beller
2017-02-15 0:34 ` [PATCH 08/14] update submodules: move up prepare_submodule_repo_env Stefan Beller
2017-02-15 0:34 ` [PATCH 09/14] update submodules: add submodule_go_from_to Stefan Beller
2017-02-15 2:06 ` brian m. carlson
2017-02-15 0:34 ` [PATCH 10/14] unpack-trees: pass old oid to verify_clean_submodule Stefan Beller
2017-02-15 0:34 ` [PATCH 11/14] unpack-trees: check if we can perform the operation for submodules Stefan Beller
2017-02-15 0:34 ` [PATCH 12/14] read-cache: remove_marked_cache_entries to wipe selected submodules Stefan Beller
2017-02-15 0:34 ` [PATCH 13/14] entry.c: update submodules when interesting Stefan Beller
2017-02-15 0:34 ` [PATCH 14/14] builtin/checkout: add --recurse-submodules switch Stefan Beller
2017-02-15 2:08 ` brian m. carlson
2017-02-16 0:33 ` Stefan Beller
2017-02-15 2:13 ` [RFCv3 PATCH 00/14] Checkout aware of Submodules! brian m. carlson
2017-02-15 18:34 ` Junio C Hamano
2017-02-16 0:37 ` [RFCv4 " Stefan Beller
2017-02-16 0:37 ` [PATCH 01/15] lib-submodule-update.sh: reorder create_lib_submodule_repo Stefan Beller
2017-02-16 0:37 ` [PATCH 02/15] lib-submodule-update.sh: do not use ./. as submodule remote Stefan Beller
2017-02-16 0:37 ` [PATCH 03/15] lib-submodule-update.sh: define tests for recursing into submodules Stefan Beller
2017-02-16 20:39 ` Junio C Hamano
2017-02-22 18:43 ` Stefan Beller
2017-02-16 0:38 ` [PATCH 04/15] make is_submodule_populated gently Stefan Beller
2017-02-16 0:38 ` [PATCH 05/15] connect_work_tree_and_git_dir: safely create leading directories Stefan Beller
2017-02-16 20:54 ` Junio C Hamano
2017-02-16 21:16 ` Stefan Beller [this message]
2017-02-16 21:25 ` Junio C Hamano
2017-02-16 0:38 ` [PATCH 06/15] update submodules: add submodule config parsing Stefan Beller
2017-02-17 18:24 ` Jacob Keller
2017-02-21 19:42 ` Stefan Beller
2017-02-21 20:48 ` Jacob Keller
2017-02-16 0:38 ` [PATCH 07/15] update submodules: add a config option to determine if submodules are updated Stefan Beller
2017-02-16 0:38 ` [PATCH 08/15] submodules: introduce check to see whether to touch a submodule Stefan Beller
2017-02-16 21:02 ` Junio C Hamano
2017-02-16 22:34 ` Jacob Keller
2017-02-17 18:36 ` Jacob Keller
2017-02-21 20:56 ` Stefan Beller
2017-02-16 0:38 ` [PATCH 09/15] update submodules: move up prepare_submodule_repo_env Stefan Beller
2017-02-16 0:38 ` [PATCH 10/15] update submodules: add submodule_go_from_to Stefan Beller
2017-02-16 21:15 ` Junio C Hamano
2017-02-16 21:33 ` Stefan Beller
2017-02-16 0:38 ` [PATCH 11/15] unpack-trees: pass old oid to verify_clean_submodule Stefan Beller
2017-02-16 21:19 ` Junio C Hamano
2017-02-16 0:38 ` [PATCH 12/15] unpack-trees: check if we can perform the operation for submodules Stefan Beller
2017-02-16 18:01 ` Brandon Williams
2017-02-16 21:23 ` Junio C Hamano
2017-02-17 18:42 ` Jacob Keller
2017-02-21 22:16 ` Stefan Beller
2017-02-21 23:35 ` Jacob Keller
2017-02-21 23:44 ` Stefan Beller
2017-02-22 0:31 ` Jacob Keller
2017-02-16 0:38 ` [PATCH 13/15] read-cache: remove_marked_cache_entries to wipe selected submodules Stefan Beller
2017-02-16 21:32 ` Junio C Hamano
2017-02-16 0:38 ` [PATCH 14/15] entry.c: update submodules when interesting Stefan Beller
2017-02-16 0:38 ` [PATCH 15/15] builtin/checkout: add --recurse-submodules switch Stefan Beller
2017-02-16 22:00 ` [RFCv4 PATCH 00/14] Checkout aware of Submodules! Junio C Hamano
2017-02-16 22:54 ` Jacob Keller
2017-02-16 22:56 ` Stefan Beller
2017-02-16 23:27 ` Jacob Keller
2017-02-23 22:57 ` [RFCv5 " Stefan Beller
2017-02-23 22:57 ` [PATCH 01/15] lib-submodule-update.sh: reorder create_lib_submodule_repo Stefan Beller
2017-02-23 22:57 ` [PATCH 02/15] lib-submodule-update.sh: do not use ./. as submodule remote Stefan Beller
2017-02-23 22:57 ` [PATCH 03/15] lib-submodule-update.sh: define tests for recursing into submodules Stefan Beller
2017-02-23 22:57 ` [PATCH 04/15] make is_submodule_populated gently Stefan Beller
2017-02-23 22:57 ` [PATCH 05/15] connect_work_tree_and_git_dir: safely create leading directories Stefan Beller
2017-02-23 22:57 ` [PATCH 06/15] update submodules: add submodule config parsing Stefan Beller
2017-02-23 22:57 ` [PATCH 07/15] update submodules: add a config option to determine if submodules are updated Stefan Beller
2017-02-23 22:57 ` [PATCH 08/15] submodules: introduce check to see whether to touch a submodule Stefan Beller
2017-02-23 22:57 ` [PATCH 09/15] update submodules: move up prepare_submodule_repo_env Stefan Beller
2017-02-23 22:57 ` [PATCH 10/15] update submodules: add submodule_move_head Stefan Beller
2017-02-24 1:21 ` Ramsay Jones
2017-02-24 19:08 ` Stefan Beller
2017-02-23 22:57 ` [PATCH 11/15] unpack-trees: pass old oid to verify_clean_submodule Stefan Beller
2017-02-23 22:57 ` [PATCH 12/15] unpack-trees: check if we can perform the operation for submodules Stefan Beller
2017-02-23 22:57 ` [PATCH 13/15] read-cache, remove_marked_cache_entries: wipe selected submodules Stefan Beller
2017-02-23 22:57 ` [PATCH 14/15] entry.c: update submodules when interesting Stefan Beller
2017-02-23 22:57 ` [PATCH 15/15] builtin/checkout: add --recurse-submodules switch Stefan Beller
2017-02-24 1:25 ` Ramsay Jones
2017-02-24 19:20 ` Stefan Beller
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=CAGZ79kbMmPQ1ZxtdaoFof36g1An-xsAx85etiskirJfY4tGHaQ@mail.gmail.com \
--to=sbeller@google.com \
--cc=bmwill@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=sandals@crustytoothpaste.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).