Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man. |
Mike Frysinger | c615c96 | 2025-08-21 10:40:14 -0400 | [diff] [blame^] | 2 | .TH REPO "1" "August 2025" "repo smartsync" "Repo Manual" |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 3 | .SH NAME |
| 4 | repo \- repo smartsync - manual page for repo smartsync |
| 5 | .SH SYNOPSIS |
| 6 | .B repo |
| 7 | \fI\,smartsync \/\fR[\fI\,<project>\/\fR...] |
| 8 | .SH DESCRIPTION |
| 9 | Summary |
| 10 | .PP |
| 11 | Update working tree to the latest known good revision |
| 12 | .SH OPTIONS |
| 13 | .TP |
| 14 | \fB\-h\fR, \fB\-\-help\fR |
| 15 | show this help message and exit |
| 16 | .TP |
| 17 | \fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR |
Mike Frysinger | df8b1cb | 2021-07-26 15:59:20 -0400 | [diff] [blame] | 18 | number of jobs to run in parallel (default: based on |
| 19 | number of CPU cores) |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 20 | .TP |
| 21 | \fB\-\-jobs\-network\fR=\fI\,JOBS\/\fR |
| 22 | number of network jobs to run in parallel (defaults to |
Mike Frysinger | c615c96 | 2025-08-21 10:40:14 -0400 | [diff] [blame^] | 23 | \fB\-\-jobs\fR or 1). Ignored unless \fB\-\-no\-interleaved\fR is set |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 24 | .TP |
| 25 | \fB\-\-jobs\-checkout\fR=\fI\,JOBS\/\fR |
| 26 | number of local checkout jobs to run in parallel |
Mike Frysinger | c615c96 | 2025-08-21 10:40:14 -0400 | [diff] [blame^] | 27 | (defaults to \fB\-\-jobs\fR or 8). Ignored unless \fB\-\-nointerleaved\fR is set |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 28 | .TP |
| 29 | \fB\-f\fR, \fB\-\-force\-broken\fR |
| 30 | obsolete option (to be deleted in the future) |
| 31 | .TP |
| 32 | \fB\-\-fail\-fast\fR |
| 33 | stop syncing after first error is hit |
| 34 | .TP |
| 35 | \fB\-\-force\-sync\fR |
| 36 | overwrite an existing git directory if it needs to |
| 37 | point to a different object directory. WARNING: this |
| 38 | may cause loss of data |
| 39 | .TP |
Mike Frysinger | cbd78a9 | 2024-04-11 08:32:40 -0400 | [diff] [blame] | 40 | \fB\-\-force\-checkout\fR |
| 41 | force checkout even if it results in throwing away |
| 42 | uncommitted modifications. WARNING: this may cause |
| 43 | loss of data |
| 44 | .TP |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 45 | \fB\-\-force\-remove\-dirty\fR |
| 46 | force remove projects with uncommitted modifications |
| 47 | if projects no longer exist in the manifest. WARNING: |
| 48 | this may cause loss of data |
| 49 | .TP |
Kaushik Lingarkar | fabab4e | 2024-09-24 16:17:05 -0700 | [diff] [blame] | 50 | \fB\-\-rebase\fR |
| 51 | rebase local commits regardless of whether they are |
| 52 | published |
| 53 | .TP |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 54 | \fB\-l\fR, \fB\-\-local\-only\fR |
| 55 | only update working tree, don't fetch |
| 56 | .TP |
| 57 | \fB\-\-no\-manifest\-update\fR, \fB\-\-nmu\fR |
| 58 | use the existing manifest checkout as\-is. (do not |
| 59 | update to the latest revision) |
| 60 | .TP |
Gavin Mak | 8535282 | 2025-06-11 00:13:52 +0000 | [diff] [blame] | 61 | \fB\-\-interleaved\fR |
Mike Frysinger | c615c96 | 2025-08-21 10:40:14 -0400 | [diff] [blame^] | 62 | fetch and checkout projects in parallel (default) |
| 63 | .TP |
| 64 | \fB\-\-no\-interleaved\fR |
| 65 | fetch and checkout projects in phases |
Gavin Mak | 8535282 | 2025-06-11 00:13:52 +0000 | [diff] [blame] | 66 | .TP |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 67 | \fB\-n\fR, \fB\-\-network\-only\fR |
| 68 | fetch only, don't update working tree |
| 69 | .TP |
| 70 | \fB\-d\fR, \fB\-\-detach\fR |
| 71 | detach projects back to manifest revision |
| 72 | .TP |
| 73 | \fB\-c\fR, \fB\-\-current\-branch\fR |
| 74 | fetch only current branch from server |
| 75 | .TP |
| 76 | \fB\-\-no\-current\-branch\fR |
| 77 | fetch all branches from server |
| 78 | .TP |
| 79 | \fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml |
| 80 | temporary manifest to use for this sync |
| 81 | .TP |
| 82 | \fB\-\-clone\-bundle\fR |
| 83 | enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS |
| 84 | .TP |
| 85 | \fB\-\-no\-clone\-bundle\fR |
| 86 | disable 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 |
| 89 | username 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 |
| 92 | password to authenticate with the manifest server |
| 93 | .TP |
| 94 | \fB\-\-fetch\-submodules\fR |
| 95 | fetch submodules from server |
| 96 | .TP |
| 97 | \fB\-\-use\-superproject\fR |
Mike Frysinger | e660106 | 2021-11-12 01:41:29 -0500 | [diff] [blame] | 98 | use the manifest superproject to sync projects; |
| 99 | implies \fB\-c\fR |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 100 | .TP |
| 101 | \fB\-\-no\-use\-superproject\fR |
| 102 | disable use of manifest superprojects |
| 103 | .TP |
| 104 | \fB\-\-tags\fR |
| 105 | fetch tags |
| 106 | .TP |
| 107 | \fB\-\-no\-tags\fR |
Mike Frysinger | e660106 | 2021-11-12 01:41:29 -0500 | [diff] [blame] | 108 | don't fetch tags (default) |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 109 | .TP |
| 110 | \fB\-\-optimized\-fetch\fR |
| 111 | only fetch projects fixed to sha1 if revision does not |
| 112 | exist locally |
| 113 | .TP |
| 114 | \fB\-\-retry\-fetches\fR=\fI\,RETRY_FETCHES\/\fR |
| 115 | number of times to retry fetches on transient errors |
| 116 | .TP |
| 117 | \fB\-\-prune\fR |
| 118 | delete refs that no longer exist on the remote |
Mike Frysinger | e660106 | 2021-11-12 01:41:29 -0500 | [diff] [blame] | 119 | (default) |
| 120 | .TP |
| 121 | \fB\-\-no\-prune\fR |
| 122 | do not delete refs that no longer exist on the remote |
LaMont Jones | 7efab53 | 2022-09-01 15:41:12 +0000 | [diff] [blame] | 123 | .TP |
| 124 | \fB\-\-auto\-gc\fR |
| 125 | run garbage collection on all synced projects |
| 126 | .TP |
| 127 | \fB\-\-no\-auto\-gc\fR |
| 128 | do not run garbage collection on any projects |
| 129 | (default) |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 130 | .SS Logging options: |
| 131 | .TP |
| 132 | \fB\-v\fR, \fB\-\-verbose\fR |
| 133 | show all output |
| 134 | .TP |
| 135 | \fB\-q\fR, \fB\-\-quiet\fR |
| 136 | only show errors |
Mike Frysinger | d47d9ff | 2022-07-10 05:15:19 -0400 | [diff] [blame] | 137 | .SS Multi\-manifest options: |
| 138 | .TP |
| 139 | \fB\-\-outer\-manifest\fR |
| 140 | operate starting at the outermost manifest |
| 141 | .TP |
| 142 | \fB\-\-no\-outer\-manifest\fR |
| 143 | do not operate on outer manifests |
| 144 | .TP |
| 145 | \fB\-\-this\-manifest\-only\fR |
| 146 | only operate on this (sub)manifest |
| 147 | .TP |
| 148 | \fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR |
| 149 | operate on this manifest and its submanifests |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 150 | .SS repo Version options: |
| 151 | .TP |
| 152 | \fB\-\-no\-repo\-verify\fR |
| 153 | do not verify repo source code |
Mike Frysinger | c615c96 | 2025-08-21 10:40:14 -0400 | [diff] [blame^] | 154 | .SS post\-sync hooks: |
| 155 | .TP |
| 156 | \fB\-\-no\-verify\fR |
| 157 | Do not run the post\-sync hook. |
| 158 | .TP |
| 159 | \fB\-\-verify\fR |
| 160 | Run the post\-sync hook without prompting. |
| 161 | .TP |
| 162 | \fB\-\-ignore\-hooks\fR |
| 163 | Do not abort if post\-sync hooks fail. |
Roger Shimizu | 0a1f533 | 2021-06-20 21:41:05 +0900 | [diff] [blame] | 164 | .PP |
| 165 | Run `repo help smartsync` to view the detailed manual. |
| 166 | .SH DETAILS |
| 167 | .PP |
| 168 | The 'repo smartsync' command is a shortcut for sync \fB\-s\fR. |