diff options
| author | Mike Frysinger <vapier@google.com> | 2025-01-30 19:11:36 -0500 |
|---|---|---|
| committer | LUCI <gerrit-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2025-01-30 19:17:24 -0800 |
| commit | dfdf577e98f6e9b13a3236767316863b3a995c01 (patch) | |
| tree | 80174e5979fec68b97180e80827bd965f2710b29 /docs/manifest-format.md | |
| parent | 747ec83f58aceb855e92aa2befaba17f04da1bee (diff) | |
| download | git-repo-dfdf577e98f6e9b13a3236767316863b3a995c01.tar.gz | |
docs: smart-sync: split out & expand details
The existing documentation on smart-sync behavior is a bit light on
details, and out of date wrt what the code actually does. Start a
dedicated document and fill it out more.
Change-Id: I1a8a3ac6edf9291d72182ad55db865035d9b683e
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/450002
Commit-Queue: Mike Frysinger <vapier@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
Reviewed-by: Josip Sokcevic <sokcevic@chromium.org>
Diffstat (limited to 'docs/manifest-format.md')
| -rw-r--r-- | docs/manifest-format.md | 21 |
1 files changed, 1 insertions, 20 deletions
diff --git a/docs/manifest-format.md b/docs/manifest-format.md index cfb80164..71fa04c5 100644 --- a/docs/manifest-format.md +++ b/docs/manifest-format.md | |||
| @@ -231,26 +231,7 @@ At most one manifest-server may be specified. The url attribute | |||
| 231 | is used to specify the URL of a manifest server, which is an | 231 | is used to specify the URL of a manifest server, which is an |
| 232 | XML RPC service. | 232 | XML RPC service. |
| 233 | 233 | ||
| 234 | The manifest server should implement the following RPC methods: | 234 | See the [smart sync documentation](./smart-sync.md) for more details. |
| 235 | |||
| 236 | GetApprovedManifest(branch, target) | ||
| 237 | |||
| 238 | Return a manifest in which each project is pegged to a known good revision | ||
| 239 | for the current branch and target. This is used by repo sync when the | ||
| 240 | --smart-sync option is given. | ||
| 241 | |||
| 242 | The target to use is defined by environment variables TARGET_PRODUCT | ||
| 243 | and TARGET_BUILD_VARIANT. These variables are used to create a string | ||
| 244 | of the form $TARGET_PRODUCT-$TARGET_BUILD_VARIANT, e.g. passion-userdebug. | ||
| 245 | If one of those variables or both are not present, the program will call | ||
| 246 | GetApprovedManifest without the target parameter and the manifest server | ||
| 247 | should choose a reasonable default target. | ||
| 248 | |||
| 249 | GetManifest(tag) | ||
| 250 | |||
| 251 | Return a manifest in which each project is pegged to the revision at | ||
| 252 | the specified tag. This is used by repo sync when the --smart-tag option | ||
| 253 | is given. | ||
| 254 | 235 | ||
| 255 | 236 | ||
| 256 | ### Element submanifest | 237 | ### Element submanifest |
