1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/submodules.R
3\name{git_submodule_list}
4\alias{git_submodule_list}
5\alias{git_submodule_info}
6\alias{git_submodule_init}
7\alias{git_submodule_set_to}
8\alias{git_submodule_add}
9\alias{git_submodule_fetch}
10\title{Submodules}
11\usage{
12git_submodule_list(repo = ".")
13
14git_submodule_info(submodule, repo = ".")
15
16git_submodule_init(submodule, overwrite = FALSE, repo = ".")
17
18git_submodule_set_to(submodule, ref, checkout = TRUE, repo = ".")
19
20git_submodule_add(url, path = basename(url), ref = "HEAD", ..., repo = ".")
21
22git_submodule_fetch(submodule, ..., repo = ".")
23}
24\arguments{
25\item{repo}{The path to the git repository. If the directory is not a
26repository, parent directories are considered (see \link{git_find}). To disable
27this search, provide the filepath protected with \code{\link[=I]{I()}}. When using this
28parameter, always explicitly call by name (i.e. \verb{repo = }) because future
29versions of gert may have additional parameters.}
30
31\item{submodule}{name of the submodule}
32
33\item{overwrite}{overwrite existing entries}
34
35\item{ref}{a branch or tag or hash with}
36
37\item{checkout}{actually switch the contents of the directory to this commit}
38
39\item{url}{full git url of the submodule}
40
41\item{path}{relative of the submodule}
42
43\item{...}{extra arguments for \link{git_fetch} for authentication things}
44}
45\description{
46Interact with submodules in the repository.
47}
48