Go to file
Allen Li b471d6f709 [scm] Fix type annotations
Change-Id: If18010e076b4b9bac540ff03daefc7d312713778
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/5867128
Reviewed-by: Josip Sokcevic <sokcevic@chromium.org>
Commit-Queue: Allen Li <ayatane@chromium.org>
bootstrap New cpython3 and vpython3 packages to depot_tools.
fetch_configs Add fetch config for web-workload
hooks pre-commit: do not ignore submodule when running diff-index
infra Roll recipe dependencies (trivial).
infra_lib/telemetry Add config to the telemetry lib
man Add --tree option to rebase-update.
metadata Do not warn about using "and" / "or" in License: fields
python-bin cipd/python: optimize cat usage
python2-bin cipd/python: optimize cat usage
recipes Roll recipe dependencies (trivial).
testing_support [scm.py] Fix error with missing_ok in GitConfig.
tests Add end_commit for calculating GitChange diffs.
third_party [depot_tools] annotate third_party/colorama as non security critical
win_toolchain Revert "Reland "Add support for GCS deps""
zsh-goodies
.cipd_impl.ps1 Import Get-FileHash from PowerShell's version specific path
.flake8 Add a config file for the flake8 linter.
.gitattributes Establish a directory for chrome infra telemetry
.gitignore autoninja: check RBE project, not account
.isort.cfg isort: make available to users
.style.yapf switch to 4 space indent
.vpython3 autoninja: check RBE project, not account
BUILD_OWNERS add siso wrapper
CROS_OWNERS CROS_OWNERS: switch to our common shared lists
DIR_METADATA
LICENSE
LUCI_OWNERS add peep-software-deploy team to luci owners
OWNERS autoninja: Implement build_telemetry utils
PRESUBMIT.py [PRESUBMIT] Increase unit test timeout
README.gclient.md
README.git-cl.md
README.md Switch to using issues.chromium.org bug links
RECLIENT_OWNERS Add convenience wrapper for reclientreport for autoninja users
WATCHLISTS Update WATCHLISTS for ninja, siso and reclient changes
auth.py [auth.py] Fix quoting of scopes
autoninja autoninja: check RBE project, not account
autoninja.bat autoninja: check RBE project, not account
autoninja.py autoninja: fix strings with invalid escape sequences
bazel [ChromiumOS] Add a launcher for Bazel
bazel.py switch to 4 space indent
bb provide a way to override cipd root for *nix systems.
bb.bat
black black: add helper for formatting Python
bootstrap_python3 Use relative path for cipd
breakpad.py switch to 4 space indent
build_telemetry autoninja: Implement build_telemetry utils
build_telemetry.bat autoninja: Implement build_telemetry utils
build_telemetry.py build_telemetry: Do not print warning message for cipd auth-info error
cbuildbot
cipd cipd: allow overriding the location of where cipd binary is installed
cipd.bat [cipd] Run cipd_impl.ps1 in constrained language mode
cipd_bin_setup.bat Revert "Retry switching to use CIPD ninja v1.8.2"
cipd_bin_setup.sh provide a way to override cipd root for *nix systems.
cipd_client_version [depot_tools] Roll CIPD.
cipd_client_version.digests [depot_tools] Roll CIPD.
cipd_manifest.txt [depot_tools] Roll everything.
cipd_manifest.versions [depot_tools] Roll everything.
cipd_manifest_cros_python2.txt remove goma CIPD package
cipd_manifest_cros_python2.versions Redirect cros calls to py2.7 scripts to the vpython2.7 package.
clang-format Use py3 for remaining tools in depot_tools path
clang-format.bat Use py3 for remaining tools in depot_tools path
clang_format.py [clang_format] Update clang path
codereview.settings
compile_single_file Make 'compile_single_file' use vpython3
compile_single_file.bat Make 'compile_single_file' use vpython3
compile_single_file.py Make 'compile_single_file' use vpython3
cpplint.bat Use python3 for cpplint and get_toolchain on Win
cpplint.py [jumbo] Update various places for changes to C++ standards.
cpplint_chromium.py switch to 4 space indent
cros cros: expand to cover more roots
cros_python2.vpython Redirect cros calls to py2.7 scripts to the vpython2.7 package.
cros_sdk
detect_host_arch.py enable fetch and gclient to run on z/OS part 1
dirmd provide a way to override cipd root for *nix systems.
dirmd.bat
download_from_google_storage
download_from_google_storage.bat use python3 for download_from_google_storage.bat
download_from_google_storage.py [depot_tools] Update GCS dotfile naming
ensure_bootstrap redirect stdout and stderr of cipd_bin_setup to /dev/null
fetch [py2] Drop envvar to run scripts with py2
fetch.bat [py2] Drop envvar to run scripts with py2
fetch.py fail if fetch command is called in Cog
gclient [py2] Drop envvar to run scripts with py2
gclient-new-workdir.py fail gracefully if gclient-new-workdir.py is called in non-git env
gclient.bat [py2] Drop envvar to run scripts with py2
gclient.py Prevent sync from deleting existing non-git-sources when in cog.
gclient_completion.sh
gclient_eval.py [gclient] remove output_file from gcs object setdep
gclient_paths.py gclient: resolve symlink in gclient_entries before checking with current path
gclient_scm.py Fix spelling error and wrap output at 80 columns.
gclient_utils.py [gclient] Use lowercase and when merging conditions
gerrit Symlink gerrit CLI into depot_tools
gerrit_client.py [gerrit_client.py] Add restore command
gerrit_util.py [gerrit_util] Fix ShouldUseSSO with no account
git-cache
git-cl
git-credential-luci provide a way to override cipd root for *nix systems.
git-credential-luci.bat [cipd] Add git-credential-luci (reland)
git-crrev-parse Fix git-crrev-parse to work with both master & main branches
git-drover
git-find-releases
git-footers
git-freeze
git-gs Enable searching starlark files with git gs.
git-hyper-blame
git-map Add quotes around paths in bash scripts
git-map-branches
git-mark-merge-base
git-nav-downstream
git-nav-upstream print slightly better message if git nav-upstream is not called in git repo
git-new-branch
git-number
git-rebase-update
git-rename-branch Add quotes around paths in bash scripts
git-reparent-branch Add quotes around paths in bash scripts
git-retry
git-runhooks Revert "Remove unused functionality in bot_update.py"
git-squash-branch
git-squash-branch-tree Add git squash-branch-tree
git-thaw Add quotes around paths in bash scripts
git-upstream-diff
git_auth.py [gclient_scm] Add new auth stack setup to gclient
git_cache.py error if git cache commands are called in cog env.
git_cl.py Add end_commit for calculating GitChange diffs.
git_cl_completion.sh
git_common.py [git_common] Fix memoize_one type check
git_completion.sh Bash autocompletion for 'git new-branch' and 'git reparent-branch'
git_dates.py Fix multiline comment formatting
git_find_releases.py fail gracefully if git find-releases is called in cog
git_footers.py fail gracefully if git footers is called in cog
git_freezer.py fail gracefully if git freeze or git thaw are called in cog
git_hyper_blame.py fail gracefully if git hyper-blame are called in cog
git_map.py fail gracefully if git map is called in cog
git_map_branches.py fail gracefully if git map-branches is called in cog
git_mark_merge_base.py fail gracefully if git mark-merge-base is called in cog
git_nav_downstream.py fail gracefully if git nav-downstream is called in cog
git_new_branch.py fail gracefully if git new-branch is called in cog
git_number.py Revert "[git-number] Remove unused git-number script."
git_rebase_update.py Add --tree option to rebase-update.
git_rename_branch.py fail gracefully if git rename-branch is called in cog
git_reparent_branch.py fail gracefully if git reparent-branch is called in cog
git_retry.py Fix multiline comment formatting
git_squash_branch.py fail gracefully if git squash-branch is called in cog
git_squash_branch_tree.py Add git squash-branch-tree
git_upstream_diff.py fail gracefully if git upstream-diff is called in cog
gn gn: Call gn.bat in msysgit on Windows.
gn.bat Revert "Call python3.bat explicitly from gn.bat on Windows."
gn.py Reland "[depot_tools] Support both gn paths in gn.py"
gn_helper.py gn_helper: ignore spaces on gn lines
google-java-format [depot_tools] add google_java_format.py
google-java-format.bat [depot_tools] add google_java_format.py
google_java_format.py Fix google-java-format/cipd exists check.
gsutil.py [gsutil] Fix race when downloading gsutil
gsutil.py.bat Reland "Make depot_tools scripts return exit codes properly on all platforms."
gsutil.vpython3 Reland "Update gsutil to use gsutil version 4.68"
isort switch to 4 space indent
led provide a way to override cipd root for *nix systems.
led.bat
lockfile.py [gsutil] Fix race when downloading gsutil
luci-auth provide a way to override cipd root for *nix systems.
luci-auth.bat
lucicfg provide a way to override cipd root for *nix systems.
lucicfg.bat
mac_toolchain provide a way to override cipd root for *nix systems.
metrics.README.md [metrics] Add new auth metric
metrics.py [metrics] Add new auth metric
metrics_utils.py [metrics] Add new auth metric
my_activity.py [fix_encoding] Remove fix_encoding
newauth.py [git_cl] Let creds-check revert new auth config changes
ninja Revert "Use depot_tools python3 to call ninja.py"
ninja.bat Add single file compile support for Windows in ninja wrappers
ninja.py ninja: error if trying to build for use_remoteexec=true
ninjalog_uploader.py ninjalog_uploader: Distinguish between explicit and default build configs
owners_client.py [owners] Limit number of concurrent Gerrit connections
owners_finder.py Remove __future__ imports
pinpoint provide a way to override cipd root for *nix systems.
pinpoint.bat
post_build_ninja_summary.py allow v6 ninja log format
presubmit_canned_checks.py [PRESUBMIT] Read DEPS file from Git in CheckForCommitObjects
presubmit_diff.py Handle binaries in presubmit_diff
presubmit_support.py Add end_commit for calculating GitChange diffs.
prpc provide a way to override cipd root for *nix systems.
prpc.bat
pylint-2.6 switch to 4 space indent
pylint-2.6.bat
pylint-2.7 switch to 4 space indent
pylint-2.7.bat Add pylint-2.7
pylint-2.17 pylint: Add pylint 2.17
pylint-2.17.bat pylint: Add pylint 2.17
pylint_main.py Remove __future__ imports
pylintrc
pylintrc-2.17 pylint: Add pylint 2.17
python_runner.sh [py2] Drop envvar to run scripts with py2
rdb provide a way to override cipd root for *nix systems.
rdb.bat
rdb_wrapper.py Fix multiline comment formatting
reclient_helper.py autoninja: Use AUTONINJA_BUILD_ID for RBE_invocation_id as is.
reclientreport Add convenience wrapper for reclientreport for autoninja users
reclientreport.bat Remove unnesisary quotes from propagated args in reclientreport.bat
reclientreport.py [reclient] Keep previous 5 builds worth of logs
repo error if repo command is called in Cog environment
repo_launcher [repo_launcher] Update repo_launcher to v2.45
roll-dep [py2] Drop envvar to run scripts with py2
roll-dep.bat [py2] Drop envvar to run scripts with py2
roll_dep.py error if roll-dep command is called in Cog environment
roll_downstream_gcs_deps.py Add a script to copy GCS packages from one DEPS file to another
rustfmt.py switch to 4 space indent
scm.py [scm] Fix type annotations
setup_color.py Fix multiline comment formatting
siso add siso wrapper
siso.bat add siso wrapper
siso.py siso: print error if siso binary doesn't exist in third_party/siso
split_cl.py Edit warning in split_cl.py
subcommand.py Fix multiline comment formatting
subprocess2.py Fix multiline comment formatting
swift-format Support git cl formatting for swift files
swift_format.py switch to 4 space indent
update_depot_tools Make update_depot_tools tell you if it's skipping an update.
update_depot_tools.bat remove goma CIPD package
update_depot_tools_toggle.py switch to 4 space indent
upload_metrics.py switch to 4 space indent
upload_to_google_storage.py Revert "Reland "Add support for GCS deps""
upload_to_google_storage_first_class.py [GCS] Add prefix option to upload_to_gs_f_c
utils.py Use $HOME/.config/depot_tools on linux for .cfg files
vpython3 Don't write pyc files if running from Cog
vpython3.bat Use the bundled interpreter instead of passing -vpython-interpreter.
watchlists.py Fix multiline comment formatting
whitespace.txt
win32imports.py switch to 4 space indent
yapf Always run yapf with vpython3.
yapf.bat

README.md

depot_tools

Tools for working with Chromium development. It requires python 3.8.

Tools

The most important tools are:

  • fetch: A gclient wrapper to checkout a project. Use fetch --help for more details.
  • gclient: A meta-checkout tool. Think repo or git submodules, except that it support OS-specific rules, e.g. do not checkout Windows only dependencies when checking out for Android. Use gclient help for more details and README.gclient.md.
  • git cl: A code review tool to interact with Rietveld or Gerrit. Use git cl help for more details and README.git-cl.md.
  • roll-dep: A gclient dependency management tool to submit a dep roll, updating a dependency to a newer revision.

There are a lot of git utilities included.

Updating

depot_tools updates itself automatically when running gclient tool. To disable auto update, set the environment variable DEPOT_TOOLS_UPDATE=0 or run ./update_depot_tools_toggle.py --disable.

To update package manually, run update_depot_tools.bat on Windows, or ./update_depot_tools on Linux or Mac.

On Windows only, running gclient will install git and python.

Contributing

To contribute change for review:

git new-branch <somename>
# Hack
git add .
git commit -a -m "Fixes goat teleporting"
# find reviewers
git cl owners
git log -- <yourfiles>

# Request a review.
git cl upload -r reviewer1@chromium.org,reviewer2@chromium.org --send-mail

# Edit change description if needed.
git cl desc

# If change is approved, flag it to be committed.
git cl set-commit

# If change needs more work.
git rebase-update
...
git cl upload -t "Fixes goat teleporter destination to be Australia"

See also open bugs, open reviews, forum or report problems.

cpplint.py

Until 2018, our cpplint.py was a copy of the upstream version at https://github.com/google/styleguide/tree/gh-pages/cpplint. Unfortunately, that repository is not maintained any more. If you want to update cpplint.py in depot_tools, just upload a patch to do so. We will figure out a long-term strategy via issue https://crbug.com/916550.

Note that the cpplint.py here is also used by the Tricium analyzer, so if the cpplint.py here changes, we should also update the copy used there.