blob: a793b7bc443c851efa8d764c985f46b722be2f59 [file] [log] [blame]
Roger Shimizu0a1f5332021-06-20 21:41:05 +09001.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
Kaushik Lingarkarfabab4e2024-09-24 16:17:05 -07002.TH REPO "1" "September 2024" "repo smartsync" "Repo Manual"
Roger Shimizu0a1f5332021-06-20 21:41:05 +09003.SH NAME
4repo \- repo smartsync - manual page for repo smartsync
5.SH SYNOPSIS
6.B repo
7\fI\,smartsync \/\fR[\fI\,<project>\/\fR...]
8.SH DESCRIPTION
9Summary
10.PP
11Update working tree to the latest known good 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
Mike Frysingerdf8b1cb2021-07-26 15:59:20 -040018number of jobs to run in parallel (default: based on
19number of CPU cores)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090020.TP
21\fB\-\-jobs\-network\fR=\fI\,JOBS\/\fR
22number of network jobs to run in parallel (defaults to
Mike Frysinger7fa8eed2022-08-04 04:27:17 -040023\fB\-\-jobs\fR or 1)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090024.TP
25\fB\-\-jobs\-checkout\fR=\fI\,JOBS\/\fR
26number of local checkout jobs to run in parallel
Mike Frysinger7fa8eed2022-08-04 04:27:17 -040027(defaults to \fB\-\-jobs\fR or 8)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090028.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
Mike Frysingercbd78a92024-04-11 08:32:40 -040040\fB\-\-force\-checkout\fR
41force checkout even if it results in throwing away
42uncommitted modifications. WARNING: this may cause
43loss of data
44.TP
Roger Shimizu0a1f5332021-06-20 21:41:05 +090045\fB\-\-force\-remove\-dirty\fR
46force remove projects with uncommitted modifications
47if projects no longer exist in the manifest. WARNING:
48this may cause loss of data
49.TP
Kaushik Lingarkarfabab4e2024-09-24 16:17:05 -070050\fB\-\-rebase\fR
51rebase local commits regardless of whether they are
52published
53.TP
Roger Shimizu0a1f5332021-06-20 21:41:05 +090054\fB\-l\fR, \fB\-\-local\-only\fR
55only update working tree, don't fetch
56.TP
57\fB\-\-no\-manifest\-update\fR, \fB\-\-nmu\fR
58use the existing manifest checkout as\-is. (do not
59update to the latest revision)
60.TP
61\fB\-n\fR, \fB\-\-network\-only\fR
62fetch only, don't update working tree
63.TP
64\fB\-d\fR, \fB\-\-detach\fR
65detach projects back to manifest revision
66.TP
67\fB\-c\fR, \fB\-\-current\-branch\fR
68fetch only current branch from server
69.TP
70\fB\-\-no\-current\-branch\fR
71fetch all branches from server
72.TP
73\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml
74temporary manifest to use for this sync
75.TP
76\fB\-\-clone\-bundle\fR
77enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
78.TP
79\fB\-\-no\-clone\-bundle\fR
80disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
81.TP
82\fB\-u\fR MANIFEST_SERVER_USERNAME, \fB\-\-manifest\-server\-username\fR=\fI\,MANIFEST_SERVER_USERNAME\/\fR
83username to authenticate with the manifest server
84.TP
85\fB\-p\fR MANIFEST_SERVER_PASSWORD, \fB\-\-manifest\-server\-password\fR=\fI\,MANIFEST_SERVER_PASSWORD\/\fR
86password to authenticate with the manifest server
87.TP
88\fB\-\-fetch\-submodules\fR
89fetch submodules from server
90.TP
91\fB\-\-use\-superproject\fR
Mike Frysingere6601062021-11-12 01:41:29 -050092use the manifest superproject to sync projects;
93implies \fB\-c\fR
Roger Shimizu0a1f5332021-06-20 21:41:05 +090094.TP
95\fB\-\-no\-use\-superproject\fR
96disable use of manifest superprojects
97.TP
98\fB\-\-tags\fR
99fetch tags
100.TP
101\fB\-\-no\-tags\fR
Mike Frysingere6601062021-11-12 01:41:29 -0500102don't fetch tags (default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900103.TP
104\fB\-\-optimized\-fetch\fR
105only fetch projects fixed to sha1 if revision does not
106exist locally
107.TP
108\fB\-\-retry\-fetches\fR=\fI\,RETRY_FETCHES\/\fR
109number of times to retry fetches on transient errors
110.TP
111\fB\-\-prune\fR
112delete refs that no longer exist on the remote
Mike Frysingere6601062021-11-12 01:41:29 -0500113(default)
114.TP
115\fB\-\-no\-prune\fR
116do not delete refs that no longer exist on the remote
LaMont Jones7efab532022-09-01 15:41:12 +0000117.TP
118\fB\-\-auto\-gc\fR
119run garbage collection on all synced projects
120.TP
121\fB\-\-no\-auto\-gc\fR
122do not run garbage collection on any projects
123(default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900124.SS Logging options:
125.TP
126\fB\-v\fR, \fB\-\-verbose\fR
127show all output
128.TP
129\fB\-q\fR, \fB\-\-quiet\fR
130only show errors
Mike Frysingerd47d9ff2022-07-10 05:15:19 -0400131.SS Multi\-manifest options:
132.TP
133\fB\-\-outer\-manifest\fR
134operate starting at the outermost manifest
135.TP
136\fB\-\-no\-outer\-manifest\fR
137do not operate on outer manifests
138.TP
139\fB\-\-this\-manifest\-only\fR
140only operate on this (sub)manifest
141.TP
142\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR
143operate on this manifest and its submanifests
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900144.SS repo Version options:
145.TP
146\fB\-\-no\-repo\-verify\fR
147do not verify repo source code
148.PP
149Run `repo help smartsync` to view the detailed manual.
150.SH DETAILS
151.PP
152The 'repo smartsync' command is a shortcut for sync \fB\-s\fR.