blob: 5ea063e6bf653ff451d549618dac0fedcea36c33 [file] [log] [blame]
Roger Shimizu0a1f5332021-06-20 21:41:05 +09001.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
Mike Frysingerc615c962025-08-21 10:40:14 -04002.TH REPO "1" "August 2025" "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 Frysingerc615c962025-08-21 10:40:14 -040023\fB\-\-jobs\fR or 1). Ignored unless \fB\-\-no\-interleaved\fR is set
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 Frysingerc615c962025-08-21 10:40:14 -040027(defaults to \fB\-\-jobs\fR or 8). Ignored unless \fB\-\-nointerleaved\fR is set
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
Gavin Mak85352822025-06-11 00:13:52 +000061\fB\-\-interleaved\fR
Mike Frysingerc615c962025-08-21 10:40:14 -040062fetch and checkout projects in parallel (default)
63.TP
64\fB\-\-no\-interleaved\fR
65fetch and checkout projects in phases
Gavin Mak85352822025-06-11 00:13:52 +000066.TP
Roger Shimizu0a1f5332021-06-20 21:41:05 +090067\fB\-n\fR, \fB\-\-network\-only\fR
68fetch only, don't update working tree
69.TP
70\fB\-d\fR, \fB\-\-detach\fR
71detach projects back to manifest revision
72.TP
73\fB\-c\fR, \fB\-\-current\-branch\fR
74fetch only current branch from server
75.TP
76\fB\-\-no\-current\-branch\fR
77fetch all branches from server
78.TP
79\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml
80temporary manifest to use for this sync
81.TP
82\fB\-\-clone\-bundle\fR
83enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
84.TP
85\fB\-\-no\-clone\-bundle\fR
86disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
87.TP
88\fB\-u\fR MANIFEST_SERVER_USERNAME, \fB\-\-manifest\-server\-username\fR=\fI\,MANIFEST_SERVER_USERNAME\/\fR
89username to authenticate with the manifest server
90.TP
91\fB\-p\fR MANIFEST_SERVER_PASSWORD, \fB\-\-manifest\-server\-password\fR=\fI\,MANIFEST_SERVER_PASSWORD\/\fR
92password to authenticate with the manifest server
93.TP
94\fB\-\-fetch\-submodules\fR
95fetch submodules from server
96.TP
97\fB\-\-use\-superproject\fR
Mike Frysingere6601062021-11-12 01:41:29 -050098use the manifest superproject to sync projects;
99implies \fB\-c\fR
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900100.TP
101\fB\-\-no\-use\-superproject\fR
102disable use of manifest superprojects
103.TP
104\fB\-\-tags\fR
105fetch tags
106.TP
107\fB\-\-no\-tags\fR
Mike Frysingere6601062021-11-12 01:41:29 -0500108don't fetch tags (default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900109.TP
110\fB\-\-optimized\-fetch\fR
111only fetch projects fixed to sha1 if revision does not
112exist locally
113.TP
114\fB\-\-retry\-fetches\fR=\fI\,RETRY_FETCHES\/\fR
115number of times to retry fetches on transient errors
116.TP
117\fB\-\-prune\fR
118delete refs that no longer exist on the remote
Mike Frysingere6601062021-11-12 01:41:29 -0500119(default)
120.TP
121\fB\-\-no\-prune\fR
122do not delete refs that no longer exist on the remote
LaMont Jones7efab532022-09-01 15:41:12 +0000123.TP
124\fB\-\-auto\-gc\fR
125run garbage collection on all synced projects
126.TP
127\fB\-\-no\-auto\-gc\fR
128do not run garbage collection on any projects
129(default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900130.SS Logging options:
131.TP
132\fB\-v\fR, \fB\-\-verbose\fR
133show all output
134.TP
135\fB\-q\fR, \fB\-\-quiet\fR
136only show errors
Mike Frysingerd47d9ff2022-07-10 05:15:19 -0400137.SS Multi\-manifest options:
138.TP
139\fB\-\-outer\-manifest\fR
140operate starting at the outermost manifest
141.TP
142\fB\-\-no\-outer\-manifest\fR
143do not operate on outer manifests
144.TP
145\fB\-\-this\-manifest\-only\fR
146only operate on this (sub)manifest
147.TP
148\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR
149operate on this manifest and its submanifests
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900150.SS repo Version options:
151.TP
152\fB\-\-no\-repo\-verify\fR
153do not verify repo source code
Mike Frysingerc615c962025-08-21 10:40:14 -0400154.SS post\-sync hooks:
155.TP
156\fB\-\-no\-verify\fR
157Do not run the post\-sync hook.
158.TP
159\fB\-\-verify\fR
160Run the post\-sync hook without prompting.
161.TP
162\fB\-\-ignore\-hooks\fR
163Do not abort if post\-sync hooks fail.
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900164.PP
165Run `repo help smartsync` to view the detailed manual.
166.SH DETAILS
167.PP
168The 'repo smartsync' command is a shortcut for sync \fB\-s\fR.