Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

IconStateDescription

Uninitialized

The submodule has not yet been initialized.

  • Use Initialize or Pull to initialize/fetch this submodule.
  • Use Deactivate to get the submodule rid from the Files view. It will only show up if View|Show Ignored Files is selected.
  • Use Unregister to remove the submodule from the repository.

Inactive 

The submodule has been Deactivated.

  • Use Initialize or Pull to initialize/fetch this submodule.

Image Added

Empty

The submodule has been initialized, but contents have not been fetched yet.

  • Use Pull to fetch this submodule.

As IndexThe submodule is correctly initialized and pointing to the same commit as registered in the parent repository's HEAD and Index.
Added

The submodule has been scheduled for addition in the parent repository.

  • Use Commit to confirm the addition.
  • Use Discard to unscheduled the addition.
Removed

The submodule has been scheduled for removal in the parent repository.

  • Use Commit to confirm the removal.
  • Use Discard to unscheduled the removal and (if necessary) reset to the submodule commit registered in the parent repository.
Modified

The submodule points to a different commit than registered in the parent repository's Index. This is usually the result after e.g. you've done a commit in the submodule repository.

  • Use Stage to stage the change in the parent repository's Index.
  • Use Commit to update the submodule link in the parent repository.
  • Use Discard to reset the submodule to the commit recorded in the parent repository's Index.
  • Use Reset to reset the submodule to the commit recorded in the parent repository's HEAD.
Conflict

The submodule is in conflicting state where it's unclear to which commit it should point.

  • Check the Log and make sure to Check Out the appropriate commit in the submodule repository, then confirm with Stage.
  • Use Discard to reset the submodule to the commit recorded in the parent repository's Index.
  • Use Reset to reset the submodule to the commit recorded in the parent repository's HEAD.
Note

Submodule conflicts are usually complex to resolve and may require additional commits in the submodule itself. Hence, if you are unsure, better contact the other authors of the conflicting submodule conflicts.

Nested root

The nested Git repository is not properly linked as submodule.

  • Use Stage to scheduled the Git repository as submodule in the parent repository
  • Otherwise, if this Git repository should not be a submodule, use Ignore or completely get rid of the sub-directory.
MissingMight happen if initializing a submodule has failed, e.g. after cancelling the credentials dialog. Use Initialize to initialize/fetch again.