For Developers‎ > ‎How-Tos‎ > ‎

Get the Code: Checkout, Build, Run & Submit

Welcome to Chromium! If you're here, you want to learn how to check out the Chromium repository and contribute changes to the Chromium project. This guide will show you how to do that.

Getting Started

Chromium supports building on Windows, Mac and Linux. You can also build the mobile versions, iOS (from Mac) and Android (from Linux).

Setting up your environment

There are two main components to your build environment:
  1. depot_tools this is our bootstrapped collection of utils that will help you checkout, compile, run and submit changes to the code
  2. src a git repo; your local copy of the chromium code. This will need to be updated regularly as other users submit changes.
The instructions for setting up your machine and checking out the code can be found in our depot_tools man page: http://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up
iOS
If you're building for iOS, run echo "{ 'GYP_DEFINES': 'OS=ios', 'GYP_GENERATOR_FLAGS': 'xcode_project_version=3.2', }" > chromium.gyp_env before you rufetch in the tutorial.
For navigating the codebase, we recommend either browsing the repo or using the code search tool, but there are other ways to browse the Chromium code.

Building Chromium

If you've checked out the code, you should see the following files and folders in the directory where you ran fetch:
  • .gclient This file (generated by fetch) defines the configuration of your checkout. It contains the location of the repository, as well as some other useful configuration
  • .gclient_entries This file (also generated by fetch) contains the repository and version information for each of Chromium's sub-repositories (dependencies)
  • src/ Contains the Chromium codebase (an explanation of the directory structure)
    • out/ Contains the generated output from builds
      • Debug/ One of the default build folders; builds the debug build
      • Release/ One of the default build folders; builds the release build

GYP build (standard)

GYP (Generate-Your-Project) is our current build system, it works for all targets. The build configurations for GYP are stored in  *.gyp or *.gypi files.

Generating the build files

If you've changed (or updated and have changes to) any *.gyp or *.gypi files, you'll need to re-generate the build files:
$ ./build/gyp_chromium
By default, this will add the build files to the out/ directory, but you can specify a different directory if you wish, e.g.:
$ ./build/gyp_chromium -Goutput_dir=out_cros
Each generator output directory will have its own Debug and Release subdirectories. For a full list of parameters GYP supports, run ./build/gyp_chromium --help .

Specifying build parameters

You can specify custom build parameters that affect the target or speed of your build. For more info, see GYP build parameters.

Building Chrome

You can then build Chromium (the chrome target) using:

$ ninja -C out/Debug chrome
For a release build, replace out/Debug with out/Release .

GN build (experimental - Linux only)

GN is our newer-style build system. It regenerates build files on-the-fly. The build configurations for GN are stored in  *.gn files. To create a GN build directory, generate one with:
$ gn gen out/Default
Do not use the GYP's out/Debug or out/Release directories, as they may conflict with GYP builds. To specify build parameters for GN, you can do so on the command line:
$ gn args out/Default
This will open an editor where you can change the build parameters, e.g.:
is_component_build=true
visual_studio_path="C:/foo/bar"
For a full list of arguments and their default values, run:
$ gn args --list out/Default
For more info on GN, run gn or append --help to any command. Also see the GN wiki page or the GN quick start guide for more details.

Building chrome

You can then build Chromium (the chrome target) using:

$ ninja -C out/Default chrome
You can replace out/Default with any GN directory you've set up. For a release build, run gn args out/Default and add the lines is_official_build=true and  is_debug=false .

For a full list of parameters to ninja and what they do, run ninja --help . You can also find more specific build instructions depending on your host and target platform:
Linux
ninja -C out/Debug chrome && out/Debug/chrome
Linux build instructions
Windows
ninja -C out\Debug chrome && out\Debug\chrome.exe
Windows build instructions
Mac
ninja -C out/Release chrome && out/Release/Chromium.app/Contents
/MacOS/Chromium

Mac build instructions
ChromeOS
ninja -C out/Debug chrome && out/Debug chrome
ChromeOS build instructions
Android
See build instructions.
Android build instructions
iOS
See build instructions.
iOS build instructions

    Targets

    You can build other targets, such as unit_tests, by changing the target:

    $ ninja -C out/Debug unit_tests

    Targets are specified in the  *.gyp and *.gypi files, in the targets section. Searching for 'target_name': in these files will give you a list of all the targets you can build. Some targets of interest are:
    • chrome , which builds the main chrome executable
    • unit_tests , which builds the main set of unit tests
    • browser_tests , which builds Chrome's browser tests

    Running Chromium

    You can run chrome with:

    $ out/Debug/chrome

    You can also pass parameters, such as flags, on the command line:

    $ out/Debug/chrome --enable-app-info-dialog --show-app-list --user-data-dir=/tmp/profile

    For a full list of command-line flags, see the *_switches.cc files.

    Running tests

    You can run the unit tests, for example, with:

    $ out/Debug/unit_tests

    You can specify only a certain set of tests to run using --gtest_filter , e.g.:

    $ out/Debug/unit_tests --gtest_filter=PushClientTest.*

    You can find out more about GoogleTest on the GoogleTest wiki page.

    Debugging

    The best way to debug chrome depends on your platform:

    Submitting your code

    You can find detailed instructions on how to submitting your code on the depot_tools manpage:

    Create a new review with:

    $ git cl upload

    This will upload your code to https://codereview.chromium.org/. You should then add reviewers (see wiki page) and submit your code for review. You can also run your code on the trybots to see if it passes all the tests:

    $ git cl try

    For a full list of options, run git cl help , or for help with a particular command just append --help , e.g.  git cl upload --help .

    Keeping Multiple Changes

    You can use branches in your local repository to help separate multiple changes you are submitting to the Chromium code. For more help with branches, see the Working with Branches tutorial, or the Managing Multiple CLs and Managing Dependent CLs sections of the man page. You can also set up multiple working directories to have multiple directories that build Chrome all share the same git database.

    Changing the Repo

    Chromium uses branches and tags to separate the various versions and releases it manages (see Working with Release Branches). The repository also contains many sub-repositories that point to external repos using the DEPS files (see the Working with Nested Repositories tutorial). Although we would prefer if you commit changes using the process above, sometimes you do need to commit or revert changes manually. You can also find out more about merging changes into release branches on the git-drover tutorial page:

    Getting Help

    If you can't get chrome to build and you're not sure why, try the following:
    • Ensure your checkout has been properly updated ( git rebase-update )
    • Check you're on a stable, unmodified branch from master ( git map-branches )
    • Check you have no uncommitted changes ( git status )
    • Check you have all the dependencies installed: try run gclient --version and  ninja --version from your src/ directory
    • Join the #chromium IRC channel on irc.freenode.net (see the IRC page for more info)
    • E-mail chromium-dev@chromium.org with your question, after taking the time to write it carefully. Note that this is not a support channel for chrome itself, just a forum for developers. You can also join the chromium-dev Google Group.
    • If you think this is a serious problem that affects many users, file a new bug with the label 'Infra'. It will be looked at by our infrastructure team.
    • Check out the legacy documentation for this page, or the other developer documentation available in this wiki
    • If you work at Google, check out the Googler-specific Chrome documentation