summaryrefslogtreecommitdiffstats
path: root/man/repo-sync.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/repo-sync.1')
-rw-r--r--man/repo-sync.1209
1 files changed, 209 insertions, 0 deletions
diff --git a/man/repo-sync.1 b/man/repo-sync.1
new file mode 100644
index 00000000..c87c9701
--- /dev/null
+++ b/man/repo-sync.1
@@ -0,0 +1,209 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "July 2021" "repo sync" "Repo Manual"
3.SH NAME
4repo \- repo sync - manual page for repo sync
5.SH SYNOPSIS
6.B repo
7\fI\,sync \/\fR[\fI\,<project>\/\fR...]
8.SH DESCRIPTION
9Summary
10.PP
11Update working tree to the latest revision
12.SH OPTIONS
13.TP
14\fB\-h\fR, \fB\-\-help\fR
15show this help message and exit
16.TP
17\fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR
18number of jobs to run in parallel (default: based on
19number of CPU cores)
20.TP
21\fB\-\-jobs\-network\fR=\fI\,JOBS\/\fR
22number of network jobs to run in parallel (defaults to
23\fB\-\-jobs\fR)
24.TP
25\fB\-\-jobs\-checkout\fR=\fI\,JOBS\/\fR
26number of local checkout jobs to run in parallel
27(defaults to \fB\-\-jobs\fR)
28.TP
29\fB\-f\fR, \fB\-\-force\-broken\fR
30obsolete option (to be deleted in the future)
31.TP
32\fB\-\-fail\-fast\fR
33stop syncing after first error is hit
34.TP
35\fB\-\-force\-sync\fR
36overwrite an existing git directory if it needs to
37point to a different object directory. WARNING: this
38may cause loss of data
39.TP
40\fB\-\-force\-remove\-dirty\fR
41force remove projects with uncommitted modifications
42if projects no longer exist in the manifest. WARNING:
43this may cause loss of data
44.TP
45\fB\-l\fR, \fB\-\-local\-only\fR
46only update working tree, don't fetch
47.TP
48\fB\-\-no\-manifest\-update\fR, \fB\-\-nmu\fR
49use the existing manifest checkout as\-is. (do not
50update to the latest revision)
51.TP
52\fB\-n\fR, \fB\-\-network\-only\fR
53fetch only, don't update working tree
54.TP
55\fB\-d\fR, \fB\-\-detach\fR
56detach projects back to manifest revision
57.TP
58\fB\-c\fR, \fB\-\-current\-branch\fR
59fetch only current branch from server
60.TP
61\fB\-\-no\-current\-branch\fR
62fetch all branches from server
63.TP
64\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml
65temporary manifest to use for this sync
66.TP
67\fB\-\-clone\-bundle\fR
68enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
69.TP
70\fB\-\-no\-clone\-bundle\fR
71disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
72.TP
73\fB\-u\fR MANIFEST_SERVER_USERNAME, \fB\-\-manifest\-server\-username\fR=\fI\,MANIFEST_SERVER_USERNAME\/\fR
74username to authenticate with the manifest server
75.TP
76\fB\-p\fR MANIFEST_SERVER_PASSWORD, \fB\-\-manifest\-server\-password\fR=\fI\,MANIFEST_SERVER_PASSWORD\/\fR
77password to authenticate with the manifest server
78.TP
79\fB\-\-fetch\-submodules\fR
80fetch submodules from server
81.TP
82\fB\-\-use\-superproject\fR
83use the manifest superproject to sync projects
84.TP
85\fB\-\-no\-use\-superproject\fR
86disable use of manifest superprojects
87.TP
88\fB\-\-tags\fR
89fetch tags
90.TP
91\fB\-\-no\-tags\fR
92don't fetch tags
93.TP
94\fB\-\-optimized\-fetch\fR
95only fetch projects fixed to sha1 if revision does not
96exist locally
97.TP
98\fB\-\-retry\-fetches\fR=\fI\,RETRY_FETCHES\/\fR
99number of times to retry fetches on transient errors
100.TP
101\fB\-\-prune\fR
102delete refs that no longer exist on the remote
103.TP
104\fB\-s\fR, \fB\-\-smart\-sync\fR
105smart sync using manifest from the latest known good
106build
107.TP
108\fB\-t\fR SMART_TAG, \fB\-\-smart\-tag\fR=\fI\,SMART_TAG\/\fR
109smart sync using manifest from a known tag
110.SS Logging options:
111.TP
112\fB\-v\fR, \fB\-\-verbose\fR
113show all output
114.TP
115\fB\-q\fR, \fB\-\-quiet\fR
116only show errors
117.SS repo Version options:
118.TP
119\fB\-\-no\-repo\-verify\fR
120do not verify repo source code
121.PP
122Run `repo help sync` to view the detailed manual.
123.SH DETAILS
124.PP
125The 'repo sync' command synchronizes local project directories with the remote
126repositories specified in the manifest. If a local project does not yet exist,
127it will clone a new local directory from the remote repository and set up
128tracking branches as specified in the manifest. If the local project already
129exists, 'repo sync' will update the remote branches and rebase any new local
130changes on top of the new remote changes.
131.PP
132\&'repo sync' will synchronize all projects listed at the command line. Projects
133can be specified either by name, or by a relative or absolute path to the
134project's local directory. If no projects are specified, 'repo sync' will
135synchronize all projects listed in the manifest.
136.PP
137The \fB\-d\fR/\-\-detach option can be used to switch specified projects back to the
138manifest revision. This option is especially helpful if the project is currently
139on a topic branch, but the manifest revision is temporarily needed.
140.PP
141The \fB\-s\fR/\-\-smart\-sync option can be used to sync to a known good build as
142specified by the manifest\-server element in the current manifest. The
143\fB\-t\fR/\-\-smart\-tag option is similar and allows you to specify a custom tag/label.
144.PP
145The \fB\-u\fR/\-\-manifest\-server\-username and \fB\-p\fR/\-\-manifest\-server\-password options can
146be used to specify a username and password to authenticate with the manifest
147server when using the \fB\-s\fR or \fB\-t\fR option.
148.PP
149If \fB\-u\fR and \fB\-p\fR are not specified when using the \fB\-s\fR or \fB\-t\fR option, 'repo sync' will
150attempt to read authentication credentials for the manifest server from the
151user's .netrc file.
152.PP
153\&'repo sync' will not use authentication credentials from \fB\-u\fR/\-p or .netrc if the
154manifest server specified in the manifest file already includes credentials.
155.PP
156By default, all projects will be synced. The \fB\-\-fail\-fast\fR option can be used to
157halt syncing as soon as possible when the first project fails to sync.
158.PP
159The \fB\-\-force\-sync\fR option can be used to overwrite existing git directories if
160they have previously been linked to a different object directory. WARNING: This
161may cause data to be lost since refs may be removed when overwriting.
162.PP
163The \fB\-\-force\-remove\-dirty\fR option can be used to remove previously used projects
164with uncommitted changes. WARNING: This may cause data to be lost since
165uncommitted changes may be removed with projects that no longer exist in the
166manifest.
167.PP
168The \fB\-\-no\-clone\-bundle\fR option disables any attempt to use \fI\,$URL/clone.bundle\/\fP to
169bootstrap a new Git repository from a resumeable bundle file on a content
170delivery network. This may be necessary if there are problems with the local
171Python HTTP client or proxy configuration, but the Git binary works.
172.PP
173The \fB\-\-fetch\-submodules\fR option enables fetching Git submodules of a project from
174server.
175.PP
176The \fB\-c\fR/\-\-current\-branch option can be used to only fetch objects that are on the
177branch specified by a project's revision.
178.PP
179The \fB\-\-optimized\-fetch\fR option can be used to only fetch projects that are fixed
180to a sha1 revision if the sha1 revision does not already exist locally.
181.PP
182The \fB\-\-prune\fR option can be used to remove any refs that no longer exist on the
183remote.
184.PP
185SSH Connections
186.PP
187If at least one project remote URL uses an SSH connection (ssh://, git+ssh://,
188or user@host:path syntax) repo will automatically enable the SSH ControlMaster
189option when connecting to that host. This feature permits other projects in the
190same 'repo sync' session to reuse the same SSH tunnel, saving connection setup
191overheads.
192.PP
193To disable this behavior on UNIX platforms, set the GIT_SSH environment variable
194to 'ssh'. For example:
195.IP
196export GIT_SSH=ssh
197repo sync
198.PP
199Compatibility
200.PP
201This feature is automatically disabled on Windows, due to the lack of UNIX
202domain socket support.
203.PP
204This feature is not compatible with url.insteadof rewrites in the user's
205~/.gitconfig. 'repo sync' is currently not able to perform the rewrite early
206enough to establish the ControlMaster tunnel.
207.PP
208If the remote SSH daemon is Gerrit Code Review, version 2.0.10 or later is
209required to fix a server side protocol bug.