You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Robert Iannucci 15d9af9d86 [gclient_utils] Make git tools set `gitcommit` modeline in vim.
This will improve the ergonomics of `git cl upload`, `git cl
description`, etc. for `vim` users.

I'm sure there are analogues for emacs, vscode, etc, but I'll leave
that as an exercise for a user of those editors :)

R=aravindvasudev@google.com

Change-Id: I194718326bc34092ef8c669a97eae9598592137d
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/4676559
Reviewed-by: Aravind Vasudevan <aravindvasudev@google.com>
Auto-Submit: Robbie Iannucci <iannucci@chromium.org>
Commit-Queue: Robbie Iannucci <iannucci@chromium.org>
2 years ago
bootstrap Minor update to git. 2 years ago
fetch_configs Set managed:True for infra_superproject configs. 2 years ago
git-templates
infra Roll recipe dependencies (trivial). 2 years ago
man [docs] Improve `git cl patch --help` 2 years ago
python-bin cipd/python: optimize cat usage 2 years ago
python2-bin cipd/python: optimize cat usage 2 years ago
recipes [gclient] Export CONFIG_CTX for other modules to extend. 2 years ago
testing_support Adding batch CIPD version resolution to gclient. 2 years ago
tests Write git dependencies to submodules 2 years ago
third_party [ssci] Added Shipped field to READMEs 2 years ago
win_toolchain Improve .boto message visibility 2 years ago
zsh-goodies
.cipd_impl.ps1 Import Get-FileHash from PowerShell's version specific path 2 years ago
.gitattributes Add lib to recipe cipd package 2 years ago
.gitignore Implement reclient metrics uploading 2 years ago
.isort.cfg isort: make available to users 3 years ago
.style.yapf Update "git cl format --python" to default to PEP-8 5 years ago
.vpython Add explicit vpython verification tags which include mac-arm64. 4 years ago
.vpython3 Add brotli to .vpython3 for depot_tools 2 years ago
BUILD_OWNERS add siso wrapper 2 years ago
CROS_OWNERS CROS_OWNERS: switch to our common shared lists 3 years ago
DIR_METADATA [depot_tools] Migrate metadata to DIR_METADATA. 4 years ago
LICENSE
LUCI_OWNERS Revert "New vpython to depot_tools" 2 years ago
OWNERS Implement reclient metrics uploading 2 years ago
PRESUBMIT.py PRESUBMIT.py: remove `USE_PYTHON3 = True` 2 years ago
README.gclient.md
README.git-cl.md Replace non-inclusive terms 4 years ago
README.md Indicate py3 compatibility for update_depot_tools_toggle.py 3 years ago
RECLIENT_OWNERS Add convenience wrapper for reclientreport for autoninja users 2 years ago
WATCHLISTS Update WATCHLISTS for ninja, siso and reclient changes 2 years ago
auth.py [auth] log errors from luci-auth token invocation. 4 years ago
autoninja [autoninja] Respect user-provided AUTONINJA_BUILD_ID 3 years ago
autoninja.bat Handle goma_ctl/autoninja /? 2 years ago
autoninja.py Create reclient specific ninja wrapper to properly handle reproxy lifecyle 2 years ago
autosiso [siso] add autosiso wrappers 2 years ago
autosiso.bat [autosiso] Do not double quote arguments on Windows. 2 years ago
autosiso.py Mark reclient build metrics with the tool that started reclient 2 years ago
bb Add revert instructions 4 years ago
bb.bat Add revert instructions 4 years ago
black black: add helper for formatting Python 3 years ago
bootstrap_python3 Use relative path for cipd 2 years ago
breakpad.py
cbuildbot simplify the chromite wrappers 6 years ago
cipd Revert "loongarch64: Add loongarch64 architecture detection support." 2 years ago
cipd.bat [cipd] Run cipd_impl.ps1 in constrained language mode 2 years ago
cipd_bin_setup.bat Revert "Retry switching to use CIPD ninja v1.8.2" 3 years ago
cipd_bin_setup.sh Revert "put goma client in depot_tools" 6 years ago
cipd_client_version [auth]: Update CIPD to include version update of luci-auth change. 2 years ago
cipd_client_version.digests [auth]: Update CIPD to include version update of luci-auth change. 2 years ago
cipd_manifest.txt [mac_toolchain] Roll mac_toolchain in depot_tools to latest version 2 years ago
cipd_manifest.versions [mac_toolchain] Roll mac_toolchain in depot_tools to latest version 2 years ago
cipd_manifest_cros_python2.txt Redirect cros calls to py2.7 scripts to the vpython2.7 package. 2 years ago
cipd_manifest_cros_python2.versions Redirect cros calls to py2.7 scripts to the vpython2.7 package. 2 years ago
clang-format Use py3 for remaining tools in depot_tools path 4 years ago
clang-format.bat Use py3 for remaining tools in depot_tools path 4 years ago
clang_format.py clang-format: lookup for binary under third_party/clang-format 2 years ago
clang_format_merge_driver Use py3 for remaining tools in depot_tools path 4 years ago
clang_format_merge_driver.bat Use py3 for remaining tools in depot_tools path 4 years ago
clang_format_merge_driver.py Use pylint 2.7 for depot_tools 3 years ago
codereview.settings update stale codereview.chromium.org links 4 years ago
compile_single_file Use py3 for remaining tools in depot_tools path 4 years ago
compile_single_file.bat Use py3 for remaining tools in depot_tools path 4 years ago
compile_single_file.py Call ninja.py from compile_single_file.py 2 years ago
cpplint.bat Use python3 for cpplint and get_toolchain on Win 3 years ago
cpplint.py Update TODO pattern to not match other names 2 years ago
cpplint_chromium.py Fix various lint false positives. 2 years ago
cros cros: Enforce minimum Python version of 3.8 2 years ago
cros_python2.vpython Redirect cros calls to py2.7 scripts to the vpython2.7 package. 2 years ago
cros_sdk simplify the chromite wrappers 6 years ago
crosjobs Add revert instructions 4 years ago
detect_host_arch.py Revert "loongarch64: Add loongarch64 architecture detection support." 2 years ago
dirmd Add revert instructions 4 years ago
dirmd.bat Add revert instructions 4 years ago
download_from_google_storage Switch download_from_google_storage to py3 4 years ago
download_from_google_storage.bat use python3 for download_from_google_storage.bat 3 years ago
download_from_google_storage.py Handle 401 from gsutil 2 years ago
ensure_bootstrap Use python3 for gsutil bootstrapping 3 years ago
fetch [py2] Drop envvar to run scripts with py2 2 years ago
fetch.bat [py2] Drop envvar to run scripts with py2 2 years ago
fetch.py fetch: make --no-history and --no-hooks switches consistent 3 years ago
fix_encoding.py Fix \r\r\n line endings in presubmit output 3 years ago
gclient [py2] Drop envvar to run scripts with py2 2 years ago
gclient-new-workdir.py Explicitly run everything with python3 3 years ago
gclient.bat [py2] Drop envvar to run scripts with py2 2 years ago
gclient.py Fix gclient read submodule path 2 years ago
gclient_completion.sh
gclient_eval.py Add git_dependencies flag to DEPS 2 years ago
gclient_paths.py Suppress stderr of the git rev-parse command 2 years ago
gclient_scm.py Set ignoreSubmodule=all for all repos. 2 years ago
gclient_utils.py [gclient_utils] Make git tools set `gitcommit` modeline in vim. 2 years ago
gerrit Symlink gerrit CLI into depot_tools 2 years ago
gerrit_client.py gerrit_client: changes: support raw search queries 2 years ago
gerrit_util.py Bump Gerrit fetch retry logic to 6 tries and 12s initial sleep 2 years ago
git-cache Add quotes around paths in bash scripts 5 years ago
git-cl Add quotes around paths in bash scripts. 5 years ago
git-crrev-parse Fix git-crrev-parse to work with both master & main branches 4 years ago
git-drover Add quotes around paths in bash scripts 5 years ago
git-find-releases Add quotes around paths in bash scripts 5 years ago
git-footers Add quotes around paths in bash scripts 5 years ago
git-freeze Add quotes around paths in bash scripts 5 years ago
git-gs Add *.ts (typescript files) to git-gs 3 years ago
git-hyper-blame Add quotes around paths in bash scripts 5 years ago
git-map Add quotes around paths in bash scripts 5 years ago
git-map-branches Add quotes around paths in bash scripts 5 years ago
git-mark-merge-base Add quotes around paths in bash scripts 5 years ago
git-migrate-default-branch Add git-migrate-default-branch 5 years ago
git-nav-downstream Add quotes around paths in bash scripts 5 years ago
git-nav-upstream Make git-nav-upstream use the upstream branch name 6 years ago
git-new-branch Add quotes around paths in bash scripts 5 years ago
git-number Add quotes around paths in bash scripts 5 years ago
git-rebase-update Add quotes around paths in bash scripts 5 years ago
git-rename-branch Add quotes around paths in bash scripts 5 years ago
git-reparent-branch Add quotes around paths in bash scripts 5 years ago
git-retry Add quotes around paths in bash scripts 5 years ago
git-runhooks Revert "Remove unused functionality in bot_update.py" 3 years ago
git-squash-branch Add quotes around paths in bash scripts 5 years ago
git-thaw Add quotes around paths in bash scripts 5 years ago
git-upstream-diff Add quotes around paths in bash scripts 5 years ago
git_cache.py Reset git_cache mirror when HEAD points to master 2 years ago
git_cl.py [docs] Improve `git cl patch --help` 2 years ago
git_cl_completion.sh Add git completion helper to cl upload 5 years ago
git_common.py Remove some Python 2 test code 2 years ago
git_dates.py
git_drover.py Explicitly run everything with python3 3 years ago
git_find_releases.py Explicitly run everything with python3 3 years ago
git_footers.py Explicitly run everything with python3 3 years ago
git_freezer.py Explicitly run everything with python3 3 years ago
git_hyper_blame.py Explicitly run everything with python3 3 years ago
git_map.py Explicitly run everything with python3 3 years ago
git_map_branches.py git-map-branches: Fix --show-subject for branches that are gone 2 years ago
git_mark_merge_base.py Explicitly run everything with python3 3 years ago
git_migrate_default_branch.py Revert "Move scm.py to lib/" 2 years ago
git_nav_downstream.py Explicitly run everything with python3 3 years ago
git_new_branch.py Explicitly run everything with python3 3 years ago
git_number.py Use pylint 2.7 for depot_tools 3 years ago
git_rebase_update.py [git-rebase-update] Ignore submodules when checking tree status. 2 years ago
git_rename_branch.py Explicitly run everything with python3 3 years ago
git_reparent_branch.py [git-reparent-branch] Keep empty branches when doing rebase-update. 2 years ago
git_retry.py Fix git-retry on errors 3 years ago
git_squash_branch.py Explicitly run everything with python3 3 years ago
git_upstream_diff.py Explicitly run everything with python3 3 years ago
gn gn: Call gn.bat in msysgit on Windows. 4 years ago
gn.bat Revert "Call python3.bat explicitly from gn.bat on Windows." 4 years ago
gn.py Use pylint 2.7 for depot_tools 3 years ago
goma_auth Reland "Reland "use python3 for goma related scripts"" 4 years ago
goma_auth.bat Set errorlevel in .bat wrappers on exit /b where appropriate. 3 years ago
goma_ctl Skip goma on unsupported platforms 2 years ago
goma_ctl.bat Handle goma_ctl/autoninja /? 2 years ago
gsutil.py Improve .boto message visibility 2 years ago
gsutil.py.bat Reland "Make depot_tools scripts return exit codes properly on all platforms." 3 years ago
gsutil.vpython3 Reland "Update gsutil to use gsutil version 4.68" 3 years ago
infra_to_superproject Use shutil.copytree instead for migration script instead. 2 years ago
infra_to_superproject.bat Use shutil.copytree instead for migration script instead. 2 years ago
infra_to_superproject.py Fix infra_to_superproject for Linux 2 years ago
isort isort: make available to users 3 years ago
led Add revert instructions 4 years ago
led.bat Add revert instructions 4 years ago
lockfile.py Reland "Use OS level locking in git_cache.py" 5 years ago
luci-auth Add revert instructions 4 years ago
luci-auth.bat Add revert instructions 4 years ago
lucicfg Add revert instructions 4 years ago
lucicfg.bat Add revert instructions 4 years ago
mac_toolchain do not hardcode the path to bash by using the #!/usr/bin/env bash shebang 6 years ago
metrics.README.md Replace non-inclusive terms 4 years ago
metrics.py Update env_vars metrics name. 2 years ago
metrics_utils.py Replace metrics link to point to main 2 years ago
my_activity.py Use pylint 2.7 for depot_tools 3 years ago
ninja Revert "Use depot_tools python3 to call ninja.py" 2 years ago
ninja.bat Add single file compile support for Windows in ninja wrappers 2 years ago
ninja.py Fix a spelling error in a comment 2 years ago
ninja_reclient.py Mark reclient build metrics with the tool that started reclient 2 years ago
ninjalog.README.md ninjalog_uploader: use goma_auth to detect googler 3 years ago
ninjalog_uploader.py [ninjalog_uploader] Exclude absolute paths and options from targets 2 years ago
ninjalog_uploader_wrapper.py Typo when countdown is more than 1. 3 years ago
owners_client.py Update code-owners documentation links 2 years ago
owners_finder.py Use pylint 2.7 for depot_tools 3 years ago
pinpoint Add revert instructions 4 years ago
pinpoint.bat Add revert instructions 4 years ago
post_build_ninja_summary.py Add elapsed-time sorting option to build summary 2 years ago
presubmit_canned_checks.py [depot_tools] Clarify error message for license headers. 2 years ago
presubmit_support.py config: use lucicfg validate to validate the config files 2 years ago
profile.xml
prpc Add revert instructions 4 years ago
prpc.bat Add revert instructions 4 years ago
pylint-2.6 Update pylint vpython specs to use a specific minor version. 3 years ago
pylint-2.6.bat Get pylint-2.6 to work under vpython3 on Windows. 4 years ago
pylint-2.7 Update pylint vpython specs to use a specific minor version. 3 years ago
pylint-2.7.bat Add pylint-2.7 4 years ago
pylint_main.py Explicitly run everything with python3 3 years ago
pylintrc CodeInclusion: Rename whitelist/blacklist -> allowlist/blocklist 5 years ago
python_runner.sh [py2] Drop envvar to run scripts with py2 2 years ago
rdb Add revert instructions 4 years ago
rdb.bat Add revert instructions 4 years ago
rdb_wrapper.py Add snippets to presubmit failures in resultdb 3 years ago
reclient_helper.py Revert "reclient: Enable racing for chrome developers" 2 years ago
reclient_metrics.README.md Implement reclient metrics uploading 2 years ago
reclient_metrics.py Implement reclient metrics uploading 2 years ago
reclientreport Add convenience wrapper for reclientreport for autoninja users 2 years ago
reclientreport.bat Remove unnesisary quotes from propagated args in reclientreport.bat 2 years ago
reclientreport.py Fix reclientreport after functions moved to reclient_helper 2 years ago
repo repo: restore fstrings for Python 3.6 4 years ago
repo_launcher Update link for filing repo issues 2 years ago
roll-dep [py2] Drop envvar to run scripts with py2 2 years ago
roll-dep.bat [py2] Drop envvar to run scripts with py2 2 years ago
roll_dep.py Fix roll dep to use update-index 2 years ago
rustfmt.py Use rustfmt from third_party/rust-toolchain/bin directory. 2 years ago
scm.py Revert "Move scm.py to lib/" 2 years ago
setup_color.py Explicitly run everything with python3 3 years ago
siso add siso wrapper 2 years ago
siso.bat add siso wrapper 2 years ago
siso.py [siso] check presence of .sisoenv file 2 years ago
split_cl.py Created disable-auto-submit flag for git cl split 2 years ago
subcommand.py Use empty argument list in cmdhelp 3 years ago
subprocess2.py [subprocess2] Replace VOID with DEVNULL 4 years ago
swift-format Support git cl formatting for swift files 3 years ago
swift_format.py Make swift-format default True on Mac hosts 3 years ago
update_depot_tools Call goma_ctl update_hook only after python3 is bootstrapped. 2 years ago
update_depot_tools.bat Call goma_ctl update_hook only after python3 is bootstrapped. 2 years ago
update_depot_tools_toggle.py Indicate py3 compatibility for update_depot_tools_toggle.py 3 years ago
upload_metrics.py Catch RemoteDisconnected on upload metrics 3 years ago
upload_to_google_storage.py Fix code check in upload to google storage. 3 years ago
utils.py Revert "Extract searching relevat files in utils function" 2 years ago
vpython Remove Python 2 support for presubmit Commands 2 years ago
vpython.bat Remove Python 2 support for presubmit Commands 2 years ago
vpython3 Revert "Resolve symlinks to cipd, vpython3" 2 years ago
vpython3.bat Use the bundled interpreter instead of passing -vpython-interpreter. 3 years ago
watchlists.py Explicitly run everything with python3 3 years ago
weekly Explicitly run everything with python3 3 years ago
whitespace.txt Change whitespace.txt 4 years ago
win32imports.py Reland "Use OS level locking in git_cache.py" 5 years ago
wtf Explicitly run everything with python3 3 years ago
yapf Update vpython spec for yapf to 0.31.0 2 years ago
yapf.bat Run yapf with vpython3 4 years ago

README.md

depot_tools

Tools for working with Chromium development. It requires python 2.7 or 3.8 for python 3 support.

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.