From d5d4b956e23cdb46b253bad18994a6f709062ce4 Mon Sep 17 00:00:00 2001 From: Fumitoshi Ukai Date: Wed, 30 Apr 2025 17:08:52 -0700 Subject: [PATCH] explain build tools and depot_tools installations Bug: 414330998 Change-Id: If65a11c2dc5448636ee608866959aad0bf298fd6 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/6497244 Auto-Submit: Fumitoshi Ukai Commit-Queue: Fumitoshi Ukai Reviewed-by: Brian Ryner Reviewed-by: Philipp Wollermann Reviewed-by: Junji Watanabe Reviewed-by: Takuto Ikuta --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2358b1e210..e8e87570d9 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,38 @@ The most important tools are: There are a lot of git utilities included. +Also, includes shell script/batch file for tools required to build chromium, +e.g. + +- `gn`: a meta-build system that generates build files for Ninja +- `autoninja`: a wrapper for `siso` and `ninja`. +- `siso`: a build tool that aims to significantly speed up Chromium's build. +- `ninja`: a small build system with a focus on speed. deprecated by Siso. + +These shell script/batch file runs python script with `python-bin/python3` +that find binaries in chromium checkout, and run with proper setup/check. +To use these wrappers, you need to initialize/bootstrap depot_tools (using +`gclient`, `update_depot_tools` or `ensure_bootstrap`). + +## Installing + +See [set-up documentation](https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up). + +depot_tools is also available in + +- chromium's third_party/depot_tools: + propagated by [autoroller](https://autoroll.skia.org/r/depot-tools-chromium-autoroll). + +- on builder: + [infra_internal/recipe_bundles/chrome-internal.googlesource.com/chrome/tools/build](https://chrome-infra-packages.appspot.com/p/infra_internal/recipe_bundles/chrome-internal.googlesource.com/chrome/tools/build) bundles depot_tools. + propagated by [build_internal recipe roller](https://ci.chromium.org/ui/p/infra-internal/builders/cron/build_internal%20recipe%20roller) + +These depot_tools would not be initialized/bootstrapped (i.e. no +`python-bin/python3` binary available), so the build tool wrapper won't work, +unless it is explicitly initialized by `ensure_bootstrap`. +Or, directly call the python script instead of using the shell script/batch +file. + ## Updating @@ -32,7 +64,7 @@ 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 `python`. +Running `gclient` will install `python3` binary. ## Contributing