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
Gavin Mak 50b27a5308 Add gclient installhooks to add pre-commit hook
With submodules, users can accidentally stage and commit gitlink
changes. Add a new gclient command to install a pre-commit hook to
automatically drop gitlink changes that don't correspond to a DEPS
change.

Dropping gitlinks can be bypassed by setting
SKIP_GITLINK_PRECOMMIT=1.

Bug: 1481266
Change-Id: Idd8b273e7d8e37d52627964e8ed6004d068b6b7a
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/4863221
Reviewed-by: Joanna Wang <jojwang@chromium.org>
Commit-Queue: Gavin Mak <gavinmak@google.com>
Reviewed-by: Josip Sokcevic <sokcevic@chromium.org>
2 years ago
bootstrap switch to 4 space indent 2 years ago
fetch_configs switch to 4 space indent 2 years ago
git-templates
hooks Add gclient installhooks to add pre-commit hook 2 years ago
infra Roll recipe dependencies (trivial). 2 years ago
man switch to 4 space indent 2 years ago
metadata [ssci] Return relative license filepath instead of absolute 2 years ago
python-bin
python2-bin
recipes Roll recipe dependencies (trivial). 2 years ago
testing_support switch to 4 space indent 2 years ago
tests Add gclient installhooks to add pre-commit hook 2 years ago
third_party Remove last py2 workarounds 2 years ago
win_toolchain switch to 4 space indent 2 years ago
zsh-goodies
.cipd_impl.ps1
.gitattributes Define main metadata validation functions 2 years ago
.gitignore
.isort.cfg
.style.yapf switch to 4 space indent 2 years ago
.vpython
.vpython3
BUILD_OWNERS
CROS_OWNERS
DIR_METADATA
LICENSE
LUCI_OWNERS add peep-software-deploy team to luci owners 2 years ago
OWNERS Update OWNERS for new reclient_metrics* files 2 years ago
PRESUBMIT.py switch to 4 space indent 2 years ago
README.gclient.md
README.git-cl.md
README.md Remove last py2 workarounds 2 years ago
RECLIENT_OWNERS
WATCHLISTS
auth.py switch to 4 space indent 2 years ago
autoninja
autoninja.bat
autoninja.py handle absolute and relative gn imports in autoninja 2 years ago
autosiso
autosiso.bat
autosiso.py [reclient] Add hostname to invocation ids 2 years ago
bazel
bazel.py switch to 4 space indent 2 years ago
bb
bb.bat
black
bootstrap_python3
breakpad.py switch to 4 space indent 2 years ago
cbuildbot
cipd
cipd.bat
cipd_bin_setup.bat
cipd_bin_setup.sh
cipd_client_version
cipd_client_version.digests
cipd_manifest.txt update goma to version 261 2 years ago
cipd_manifest.versions update goma to version 261 2 years ago
cipd_manifest_cros_python2.txt
cipd_manifest_cros_python2.versions
clang-format
clang-format.bat
clang_format.py switch to 4 space indent 2 years ago
codereview.settings
compile_single_file
compile_single_file.bat
compile_single_file.py switch to 4 space indent 2 years ago
cpplint.bat
cpplint.py switch to 4 space indent 2 years ago
cpplint_chromium.py switch to 4 space indent 2 years ago
cros switch to 4 space indent 2 years ago
cros_python2.vpython
cros_sdk
crosjobs
detect_host_arch.py switch to 4 space indent 2 years ago
dirmd
dirmd.bat
download_from_google_storage
download_from_google_storage.bat
download_from_google_storage.py switch to 4 space indent 2 years ago
ensure_bootstrap
fetch
fetch.bat
fetch.py switch to 4 space indent 2 years ago
fix_encoding.py switch to 4 space indent 2 years ago
gclient
gclient-new-workdir.py switch to 4 space indent 2 years ago
gclient.bat
gclient.py Add gclient installhooks to add pre-commit hook 2 years ago
gclient_completion.sh
gclient_eval.py Remove last py2 workarounds 2 years ago
gclient_paths.py switch to 4 space indent 2 years ago
gclient_scm.py [gclient_scm] Disable push recurseSubmodule 2 years ago
gclient_utils.py switch to 4 space indent 2 years ago
gerrit
gerrit_client.py Remove last py2 workarounds 2 years ago
gerrit_util.py Remove last py2 workarounds 2 years ago
git-cache
git-cl
git-crrev-parse
git-drover
git-find-releases
git-footers
git-freeze
git-gs
git-hyper-blame
git-map
git-map-branches
git-mark-merge-base
git-migrate-default-branch
git-nav-downstream
git-nav-upstream
git-new-branch
git-number
git-rebase-update
git-rename-branch
git-reparent-branch
git-retry
git-runhooks
git-squash-branch
git-thaw
git-upstream-diff
git_cache.py switch to 4 space indent 2 years ago
git_cl.py Add experimental --google-java-format flag to "git cl format" 2 years ago
git_cl_completion.sh
git_common.py Fix squash_current_branch on dirty submodules 2 years ago
git_completion.sh Bash autocompletion for 'git new-branch' and 'git reparent-branch' 2 years ago
git_dates.py switch to 4 space indent 2 years ago
git_drover.py switch to 4 space indent 2 years ago
git_find_releases.py switch to 4 space indent 2 years ago
git_footers.py switch to 4 space indent 2 years ago
git_freezer.py switch to 4 space indent 2 years ago
git_hyper_blame.py switch to 4 space indent 2 years ago
git_map.py switch to 4 space indent 2 years ago
git_map_branches.py switch to 4 space indent 2 years ago
git_mark_merge_base.py switch to 4 space indent 2 years ago
git_migrate_default_branch.py switch to 4 space indent 2 years ago
git_nav_downstream.py switch to 4 space indent 2 years ago
git_new_branch.py switch to 4 space indent 2 years ago
git_number.py switch to 4 space indent 2 years ago
git_rebase_update.py switch to 4 space indent 2 years ago
git_rename_branch.py switch to 4 space indent 2 years ago
git_reparent_branch.py switch to 4 space indent 2 years ago
git_retry.py switch to 4 space indent 2 years ago
git_squash_branch.py switch to 4 space indent 2 years ago
git_upstream_diff.py switch to 4 space indent 2 years ago
gn
gn.bat
gn.py switch to 4 space indent 2 years ago
goma_auth
goma_auth.bat
goma_ctl
goma_ctl.bat
gsutil.py switch to 4 space indent 2 years ago
gsutil.py.bat
gsutil.vpython3
infra_to_superproject
infra_to_superproject.bat
infra_to_superproject.py switch to 4 space indent 2 years ago
isort switch to 4 space indent 2 years ago
led
led.bat
lockfile.py switch to 4 space indent 2 years ago
luci-auth
luci-auth.bat
lucicfg
lucicfg.bat
mac_toolchain
metrics.README.md
metrics.py switch to 4 space indent 2 years ago
metrics_utils.py switch to 4 space indent 2 years ago
my_activity.py switch to 4 space indent 2 years ago
ninja
ninja.bat
ninja.py switch to 4 space indent 2 years ago
ninja_reclient.py Enable racing for ninja+reclient developer builds 2 years ago
ninjalog.README.md
ninjalog_uploader.py Remove last py2 workarounds 2 years ago
ninjalog_uploader_wrapper.py switch to 4 space indent 2 years ago
owners_client.py switch to 4 space indent 2 years ago
owners_finder.py switch to 4 space indent 2 years ago
pinpoint
pinpoint.bat
post_build_ninja_summary.py Automatically run siso metrics summary for siso builds 2 years ago
presubmit_canned_checks.py presubmit: support checking new TODO format 2 years ago
presubmit_support.py switch to 4 space indent 2 years ago
profile.xml
prpc
prpc.bat
pylint-2.6 switch to 4 space indent 2 years ago
pylint-2.6.bat
pylint-2.7 switch to 4 space indent 2 years ago
pylint-2.7.bat
pylint_main.py switch to 4 space indent 2 years ago
pylintrc
python_runner.sh
rdb
rdb.bat
rdb_wrapper.py switch to 4 space indent 2 years ago
reclient_helper.py [reclient] Only print reproxy start/stop times if NINJA_SUMMARIZE_BUILD=1 2 years ago
reclient_metrics Add reclient_metrics command 2 years ago
reclient_metrics.README.md
reclient_metrics.bat Add reclient_metrics command 2 years ago
reclient_metrics.py switch to 4 space indent 2 years ago
reclientreport
reclientreport.bat
reclientreport.py switch to 4 space indent 2 years ago
repo switch to 4 space indent 2 years ago
repo_launcher repo_launcher: pull latest version 2 years ago
roll-dep
roll-dep.bat
roll_dep.py switch to 4 space indent 2 years ago
rustfmt.py switch to 4 space indent 2 years ago
scm.py switch to 4 space indent 2 years ago
setup_color.py switch to 4 space indent 2 years ago
siso
siso.bat
siso.py switch to 4 space indent 2 years ago
split_cl.py switch to 4 space indent 2 years ago
subcommand.py switch to 4 space indent 2 years ago
subprocess2.py switch to 4 space indent 2 years ago
swift-format
swift_format.py switch to 4 space indent 2 years ago
update_depot_tools
update_depot_tools.bat
update_depot_tools_toggle.py switch to 4 space indent 2 years ago
upload_metrics.py switch to 4 space indent 2 years ago
upload_to_google_storage.py switch to 4 space indent 2 years ago
utils.py switch to 4 space indent 2 years ago
vpython
vpython.bat
vpython3
vpython3.bat
watchlists.py switch to 4 space indent 2 years ago
weekly switch to 4 space indent 2 years ago
whitespace.txt
win32imports.py switch to 4 space indent 2 years ago
wtf switch to 4 space indent 2 years ago
yapf
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.