blob: 6e77f182d88504aac9ddfb8dee77d9830ee4e323 [file] [log] [blame]
Roger Shimizu0a1f5332021-06-20 21:41:05 +09001.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
Gavin Mak85352822025-06-11 00:13:52 +00002.TH REPO "1" "June 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 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
Gavin Mak85352822025-06-11 00:13:52 +000061\fB\-\-interleaved\fR
62fetch and checkout projects in parallel (experimental)
63.TP
Roger Shimizu0a1f5332021-06-20 21:41:05 +090064\fB\-n\fR, \fB\-\-network\-only\fR
65fetch only, don't update working tree
66.TP
67\fB\-d\fR, \fB\-\-detach\fR
68detach projects back to manifest revision
69.TP
70\fB\-c\fR, \fB\-\-current\-branch\fR
71fetch only current branch from server
72.TP
73\fB\-\-no\-current\-branch\fR
74fetch all branches from server
75.TP
76\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml
77temporary manifest to use for this sync
78.TP
79\fB\-\-clone\-bundle\fR
80enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
81.TP
82\fB\-\-no\-clone\-bundle\fR
83disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
84.TP
85\fB\-u\fR MANIFEST_SERVER_USERNAME, \fB\-\-manifest\-server\-username\fR=\fI\,MANIFEST_SERVER_USERNAME\/\fR
86username to authenticate with the manifest server
87.TP
88\fB\-p\fR MANIFEST_SERVER_PASSWORD, \fB\-\-manifest\-server\-password\fR=\fI\,MANIFEST_SERVER_PASSWORD\/\fR
89password to authenticate with the manifest server
90.TP
91\fB\-\-fetch\-submodules\fR
92fetch submodules from server
93.TP
94\fB\-\-use\-superproject\fR
Mike Frysingere6601062021-11-12 01:41:29 -050095use the manifest superproject to sync projects;
96implies \fB\-c\fR
Roger Shimizu0a1f5332021-06-20 21:41:05 +090097.TP
98\fB\-\-no\-use\-superproject\fR
99disable use of manifest superprojects
100.TP
101\fB\-\-tags\fR
102fetch tags
103.TP
104\fB\-\-no\-tags\fR
Mike Frysingere6601062021-11-12 01:41:29 -0500105don't fetch tags (default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900106.TP
107\fB\-\-optimized\-fetch\fR
108only fetch projects fixed to sha1 if revision does not
109exist locally
110.TP
111\fB\-\-retry\-fetches\fR=\fI\,RETRY_FETCHES\/\fR
112number of times to retry fetches on transient errors
113.TP
114\fB\-\-prune\fR
115delete refs that no longer exist on the remote
Mike Frysingere6601062021-11-12 01:41:29 -0500116(default)
117.TP
118\fB\-\-no\-prune\fR
119do not delete refs that no longer exist on the remote
LaMont Jones7efab532022-09-01 15:41:12 +0000120.TP
121\fB\-\-auto\-gc\fR
122run garbage collection on all synced projects
123.TP
124\fB\-\-no\-auto\-gc\fR
125do not run garbage collection on any projects
126(default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900127.SS Logging options:
128.TP
129\fB\-v\fR, \fB\-\-verbose\fR
130show all output
131.TP
132\fB\-q\fR, \fB\-\-quiet\fR
133only show errors
Mike Frysingerd47d9ff2022-07-10 05:15:19 -0400134.SS Multi\-manifest options:
135.TP
136\fB\-\-outer\-manifest\fR
137operate starting at the outermost manifest
138.TP
139\fB\-\-no\-outer\-manifest\fR
140do not operate on outer manifests
141.TP
142\fB\-\-this\-manifest\-only\fR
143only operate on this (sub)manifest
144.TP
145\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR
146operate on this manifest and its submanifests
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900147.SS repo Version options:
148.TP
149\fB\-\-no\-repo\-verify\fR
150do not verify repo source code
151.PP
152Run `repo help smartsync` to view the detailed manual.
153.SH DETAILS
154.PP
155The 'repo smartsync' command is a shortcut for sync \fB\-s\fR.