1REPO(1) Repo Manual REPO(1)
2
6 repo - repo sync - manual page for repo sync
7
9 repo sync [<project>...]
10
12 Summary
13 Update working tree to the latest revision
15
17 -h, --help
18 show this help message and exit
19 -j JOBS, --jobs=JOBS
21 number of jobs to run in parallel (default: based on number of
22 CPU cores)
23 --jobs-network=JOBS
25 number of network jobs to run in parallel (defaults to --jobs or
26 1)
27 --jobs-checkout=JOBS
29 number of local checkout jobs to run in parallel (defaults to
30 --jobs or 8)
31 -f, --force-broken
33 obsolete option (to be deleted in the future)
34 --fail-fast
36 stop syncing after first error is hit
37 --force-sync
39 overwrite an existing git directory if it needs to point to a
40 different object directory. WARNING: this may cause loss of data
41 --force-remove-dirty
43 force remove projects with uncommitted modifications if projects
44 no longer exist in the manifest. WARNING: this may cause loss of
45 data
46 -l, --local-only
48 only update working tree, don't fetch
49 --no-manifest-update, --nmu
51 use the existing manifest checkout as-is. (do not update to the
52 latest revision)
53 -n, --network-only
55 fetch only, don't update working tree
56 -d, --detach
58 detach projects back to manifest revision
59 -c, --current-branch
61 fetch only current branch from server
62 --no-current-branch
64 fetch all branches from server
65 -m NAME.xml, --manifest-name=NAME.xml
67 temporary manifest to use for this sync
68 --clone-bundle
70 enable use of /clone.bundle on HTTP/HTTPS
71 --no-clone-bundle
73 disable use of /clone.bundle on HTTP/HTTPS
74 -u MANIFEST_SERVER_USERNAME, --manifest-server-username=MANI‐
76 FEST_SERVER_USERNAME
77 username to authenticate with the manifest server
78 -p MANIFEST_SERVER_PASSWORD, --manifest-server-password=MANI‐
80 FEST_SERVER_PASSWORD
81 password to authenticate with the manifest server
82 --fetch-submodules
84 fetch submodules from server
85 --use-superproject
87 use the manifest superproject to sync projects; implies -c
88 --no-use-superproject
90 disable use of manifest superprojects
91 --tags fetch tags
93 --no-tags
95 don't fetch tags (default)
96 --optimized-fetch
98 only fetch projects fixed to sha1 if revision does not exist lo‐
99 cally
100 --retry-fetches=RETRY_FETCHES
102 number of times to retry fetches on transient errors
103 --prune
105 delete refs that no longer exist on the remote (default)
106 --no-prune
108 do not delete refs that no longer exist on the remote
109 -s, --smart-sync
111 smart sync using manifest from the latest known good build
112 -t SMART_TAG, --smart-tag=SMART_TAG
114 smart sync using manifest from a known tag
115 Logging options:
117 -v, --verbose
118 show all output
119 -q, --quiet
121 only show errors
122 Multi-manifest options:
124 --outer-manifest
125 operate starting at the outermost manifest
126 --no-outer-manifest
128 do not operate on outer manifests
129 --this-manifest-only
131 only operate on this (sub)manifest
132 --no-this-manifest-only, --all-manifests
134 operate on this manifest and its submanifests
135 repo Version options:
137 --no-repo-verify
138 do not verify repo source code
139 Run `repo help sync` to view the detailed manual.
141
143 The 'repo sync' command synchronizes local project directories with the
144 remote repositories specified in the manifest. If a local project does
145 not yet exist, it will clone a new local directory from the remote
146 repository and set up tracking branches as specified in the manifest.
147 If the local project already exists, 'repo sync' will update the remote
148 branches and rebase any new local changes on top of the new remote
149 changes.
150 'repo sync' will synchronize all projects listed at the command line.
152 Projects can be specified either by name, or by a relative or absolute
153 path to the project's local directory. If no projects are specified,
154 'repo sync' will synchronize all projects listed in the manifest.
155 The -d/--detach option can be used to switch specified projects back to
157 the manifest revision. This option is especially helpful if the project
158 is currently on a topic branch, but the manifest revision is temporar‐
159 ily needed.
160 The -s/--smart-sync option can be used to sync to a known good build as
162 specified by the manifest-server element in the current manifest. The
163 -t/--smart-tag option is similar and allows you to specify a custom
164 tag/label.
165 The -u/--manifest-server-username and -p/--manifest-server-password op‐
167 tions can be used to specify a username and password to authenticate
168 with the manifest server when using the -s or -t option.
169 If -u and -p are not specified when using the -s or -t option, 'repo
171 sync' will attempt to read authentication credentials for the manifest
172 server from the user's .netrc file.
173 'repo sync' will not use authentication credentials from -u/-p or
175 .netrc if the manifest server specified in the manifest file already
176 includes credentials.
177 By default, all projects will be synced. The --fail-fast option can be
179 used to halt syncing as soon as possible when the first project fails
180 to sync.
181 The --force-sync option can be used to overwrite existing git directo‐
183 ries if they have previously been linked to a different object direc‐
184 tory. WARNING: This may cause data to be lost since refs may be removed
185 when overwriting.
186 The --force-remove-dirty option can be used to remove previously used
188 projects with uncommitted changes. WARNING: This may cause data to be
189 lost since uncommitted changes may be removed with projects that no
190 longer exist in the manifest.
191 The --no-clone-bundle option disables any attempt to use
193 $URL/clone.bundle to bootstrap a new Git repository from a resumeable
194 bundle file on a content delivery network. This may be necessary if
195 there are problems with the local Python HTTP client or proxy configu‐
196 ration, but the Git binary works.
197 The --fetch-submodules option enables fetching Git submodules of a
199 project from server.
200 The -c/--current-branch option can be used to only fetch objects that
202 are on the branch specified by a project's revision.
203 The --optimized-fetch option can be used to only fetch projects that
205 are fixed to a sha1 revision if the sha1 revision does not already ex‐
206 ist locally.
207 The --prune option can be used to remove any refs that no longer exist
209 on the remote.
210 SSH Connections
212 If at least one project remote URL uses an SSH connection (ssh://,
214 git+ssh://, or user@host:path syntax) repo will automatically enable
215 the SSH ControlMaster option when connecting to that host. This feature
216 permits other projects in the same 'repo sync' session to reuse the
217 same SSH tunnel, saving connection setup overheads.
218 To disable this behavior on UNIX platforms, set the GIT_SSH environment
220 variable to 'ssh'. For example:
221 export GIT_SSH=ssh repo sync
223 Compatibility
225 This feature is automatically disabled on Windows, due to the lack of
227 UNIX domain socket support.
228 This feature is not compatible with url.insteadof rewrites in the
230 user's ~/.gitconfig. 'repo sync' is currently not able to perform the
231 rewrite early enough to establish the ControlMaster tunnel.
232 If the remote SSH daemon is Gerrit Code Review, version 2.0.10 or later
234 is required to fix a server side protocol bug.
235repo sync August 2022 REPO(1)