libgit2

git_submodule_update

Version:

Update a submodule. This will clone a missing submodule and checkout the subrepository to the commit specified in the index of containing repository.

Signature

GitHub
int git_submodule_update(git_submodule *submodule, int init, git_submodule_update_options *options);

Parameters

git_submodule *
In
submodule

Submodule object

int
In
init

If the submodule is not initialized, setting this flag to true will initialize the submodule before updating. Otherwise, this will return an error if attempting to update an uninitialzed repository. but setting this to true forces them to be updated.

git_submodule_update_options *
In
options

configuration options for the update. If NULL, the function works as though GIT_SUBMODULE_UPDATE_OPTIONS_INIT was passed.

Returns

int

0 on success, any non-zero return value from a callback function, or a negative value to indicate an error (use giterr_last for a detailed error message).

Versions