From: Jonathan Nieder <jrnieder@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Stefan Beller <sbeller@google.com>, git@vger.kernel.org
Subject: Re: [PATCH] submodule: spell out API of submodule_move_head
Date: Mon, 9 Oct 2017 17:27:31 -0700 [thread overview]
Message-ID: <20171010002731.GM19555@aiede.mtv.corp.google.com> (raw)
In-Reply-To: <xmqqtvz7rh68.fsf@gitster.mtv.corp.google.com>
Junio C Hamano wrote:
> Stefan Beller <sbeller@google.com> writes:
>> +/**
>> + * Move the HEAD and content of the active submodule at 'path' from object id
>> + * 'old' to 'new'.
>> + *
>> + * Updates the submodule at 'path' and files in its work tree to commit
>> + * 'new'. The commit previously pointed to by the submodule is named by
>> + * 'old'. This updates the submodule's HEAD, index, and work tree but
>> + * does not touch its gitlink entry in the superproject.
>> + *
>> + * If the submodule did not previously exist, then 'old' should be NULL.
>> + * Similarly, if the submodule is to be removed, 'new' should be NULL.
>> + *
>> + * If updating the submodule would cause local changes to be overwritten,
>> + * then instead of updating the submodule, this function prints an error
>> + * message and returns -1.
>
> This is not a new issue (the removed comment did not mention this at
> all), but is it correct to say that updates to "index and work tree"
> was as if we did "git -C $path checkout new" (and of course, HEAD in
> the $path submodule must be at 'old')?
I don't understand the question. This comment doesn't say it's like
"git checkout" --- are you saying it should?
The function is more like "git read-tree -m -u" (or --reset when
SUBMODULE_MOVE_HEAD_FORCE is passed) than like "git checkout".
Perhaps what you are hinting at is that read-tree --recurse-submodules
is not necessarily the right primitive to implement "git checkout"
with. But that's a separate issue from documenting the current
behavior of the function.
> What should happen if 'old' does not match reality (i.e. old is NULL
> but HEAD does point at some commit, old and HEAD are different,
> etc.)? Should the call be aborted?
No.
Thanks,
Jonathan
>> + * If the submodule is not active, this does nothing and returns 0.
>> + */
>> #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
>> #define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
>> extern int submodule_move_head(const char *path,
next prev parent reply other threads:[~2017-10-10 0:27 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-09 22:06 [PATCH] submodule: spell out API of submodule_move_head Stefan Beller
2017-10-09 22:22 ` Jonathan Nieder
2017-10-10 0:16 ` Junio C Hamano
2017-10-10 0:27 ` Jonathan Nieder [this message]
2017-10-10 0:42 ` Junio C Hamano
2017-10-10 0:55 ` Jonathan Nieder
2017-10-10 1:06 ` Junio C Hamano
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=20171010002731.GM19555@aiede.mtv.corp.google.com \
--to=jrnieder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sbeller@google.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.
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).