submodule

Documentation

Overview

Package submodule manages submodules as used by the Microsoft Go repository.

Index

• func Init(rootDir, origin, fetchBearerToken string, shallow bool) error
• func Reset(rootDir, submoduleDir string, force bool) error

Functions

func Init

func Init(rootDir, origin, fetchBearerToken string, shallow bool) error

Init initializes and updates the submodule, but does not clean it. This func offers more options for initialization than Reset. If origin is defined, fetch the submodule from there instead of the default defined in '.gitmodules'. If fetchBearerToken is nonempty, use it as a bearer token during the fetch. If shallow is true, clone the submodule with depth 1.

func Reset

func Reset(rootDir, submoduleDir string, force bool) error

Reset updates the submodule (with '--init'). If "force", throw away changes in the submodule, abort all in-progress Git operations like rebases, and clean all untracked files.