diff options
| author | Dan Albert <danalbert@google.com> | 2023-12-05 22:51:17 +0000 |
|---|---|---|
| committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2023-12-05 22:51:17 +0000 |
| commit | f2475ef3e97265ca5c1c52dfa091ac50efa43b25 (patch) | |
| tree | 762f902c45354208da0d75a98b0583965e543141 | |
| parent | cb7deded41880b256a885cba36004c066f28201a (diff) | |
| parent | 15ef536f4582275b274a3f0fbb53933f118af01e (diff) | |
| download | external_updater-f2475ef3e97265ca5c1c52dfa091ac50efa43b25.tar.gz | |
Update docs to explain path resolution change. am: 7779ff6bfd am: 15ef536f45
Original change: https://android-review.googlesource.com/c/platform/tools/external_updater/+/2860552
Change-Id: I5d2a201236f77b054fd8fc0083129aa00174570e
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
| -rw-r--r-- | README.md | 23 |
1 files changed, 18 insertions, 5 deletions
@@ -4,34 +4,47 @@ external updater is a tool to automatically update libraries in external/. ## Usage +In each of the examples below, `$PROJECT_PATH` is the path to the project to +operate on. If more than one path is given, external_updater will operate on +each in turn. + +Note: Older versions of external_updater used a different path resolution +method. Relative paths were resolved relative to `//external` rather than the +CWD, which meant tab-completed paths would only work if the CWD was +`//external`, and that wildcards had to be escaped for processing by +external_updater rather than the shell (e.g. +`updater.sh 'check rust/crates/*'`). That behavior was removed to support CWD +relative paths. If you want the old behavior back, leave a comment on +http://b/243685332 or https://r.android.com/2855445. + Check updates for a library or verify METADATA is valid: ```shell -tools/external_updater/updater.sh check ${LIBNAME} +tools/external_updater/updater.sh check $PROJECT_PATH ``` Update a library, commit, and upload the change to Gerrit: ```shell -tools/external_updater/updater.sh update ${LIBNAME} +tools/external_updater/updater.sh update $PROJECT_PATH ``` Update a library without committing and uploading to Gerrit: ```shell -tools/external_updater/updater.sh update --no-upload ${LIBNAME} +tools/external_updater/updater.sh update --no-upload $PROJECT_PATH ``` Update a library on top of the local changes in the current branch, commit, and upload the change to Gerrit: ```shell -tools/external_updater/updater.sh update --keep-local-changes ${LIBNAME} +tools/external_updater/updater.sh update --keep-local-changes $PROJECT_PATH ``` Update a library without building: ```shell -tools/external_updater/updater.sh update --no-build ${LIBNAME} +tools/external_updater/updater.sh update --no-build $PROJECT_PATH ``` LIBNAME can be the path to a library under external/, e.g. kotlinc, or |