diff options
Diffstat (limited to 'docs/smart-sync.md')
| -rw-r--r-- | docs/smart-sync.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/smart-sync.md b/docs/smart-sync.md index 24f37461b..905a004a0 100644 --- a/docs/smart-sync.md +++ b/docs/smart-sync.md | |||
| @@ -204,6 +204,10 @@ still fails the sync, as before. Options that specify an explicit target or | |||
| 204 | manifest source (such as `-t`/`--smart-tag`, `-m`/`--manifest-name` or | 204 | manifest source (such as `-t`/`--smart-tag`, `-m`/`--manifest-name` or |
| 205 | `--superproject-revision`) will also disable the default Smart Sync behavior. | 205 | `--superproject-revision`) will also disable the default Smart Sync behavior. |
| 206 | 206 | ||
| 207 | Users can override this manifest default on their workstation with the | ||
| 208 | `sync.smartsync` user setting; see | ||
| 209 | [Per-user default](#Per_user-default-sync_smartsync) below. | ||
| 210 | |||
| 207 | ### --smart-sync / -s | 211 | ### --smart-sync / -s |
| 208 | 212 | ||
| 209 | Explicitly enables Smart Sync. Repo will call | 213 | Explicitly enables Smart Sync. Repo will call |
| @@ -231,6 +235,18 @@ match the settings Android build environments automatically setup. | |||
| 231 | Explicitly disables Smart Sync, overriding any `sync-smartsync="true"` setting | 235 | Explicitly disables Smart Sync, overriding any `sync-smartsync="true"` setting |
| 232 | declared in the manifest `<default>` element. | 236 | declared in the manifest `<default>` element. |
| 233 | 237 | ||
| 238 | ### Per-user default (sync.smartsync) | ||
| 239 | |||
| 240 | A user can decide once, for all their checkouts, whether `repo sync` should | ||
| 241 | Smart Sync by default by setting the boolean `sync.smartsync` key in their | ||
| 242 | [per-user repo config](./repoconfig.md#smartsync). | ||
| 243 | |||
| 244 | Command line flags (`-s`, `--no-smart-sync`, `-t`) override the user setting, | ||
| 245 | which in turn overrides the manifest's `sync-smartsync` default. A Smart Sync | ||
| 246 | enabled this way is treated as an explicit request, so it is subject to the | ||
| 247 | same restrictions as `-s` and fails the sync if no manifest can be obtained | ||
| 248 | from the server instead of silently falling back to ToT. | ||
| 249 | |||
| 234 | ### --smart-tag=TAG / -t | 250 | ### --smart-tag=TAG / -t |
| 235 | 251 | ||
| 236 | Repo will call `GetManifest(TAG)`. | 252 | Repo will call `GetManifest(TAG)`. |
