commit | d062e74fbc255aa2d33cb71321b322fc94ae6810 | [log] [tgz] |
---|---|---|
author | Brett Wilson <brettw@chromium.org> | Wed Feb 27 09:36:10 2019 -0800 |
committer | Commit Bot <commit-bot@chromium.org> | Wed Feb 27 18:10:42 2019 +0000 |
tree | d56b38d2103c72d9085f842bb65a600727e262fa | |
parent | e15f243a7af794b1bdc915885717749af853a3bb [diff] |
Improve config documentation. I've had several questions recently about why configs exist or what they're for. This adds some background to the config documentation that should help people understand why they are the way they are. Change-Id: I68c8e38d934520e65d2854201e73413f67531b47 Reviewed-on: https://gn-review.googlesource.com/c/4140 Reviewed-by: Julie Hockett <juliehockett@google.com> Commit-Queue: Brett Wilson <brettw@chromium.org>
GN is a meta-build system that generates build files for Ninja. There is documentation in docs/ and a presentation on it.
You can download the latest version of GN binary for Linux, macOS and Windows.
Alternatively, you can build GN from source:
git clone https://gn.googlesource.com/gn cd gn python build/gen.py ninja -C out # To run tests: out/gn_unittests
On Windows, it is expected that cl.exe
, link.exe
, and lib.exe
can be found in PATH
, so you'll want to run from a Visual Studio command prompt, or similar.
On Linux and Mac, the default compiler is clang++
, a recent version is expected to be found in PATH
. This can be overridden by setting CC
, CXX
, and AR
.
If you find a bug, you can see if it is known or report it in the bug database.
GN uses Gerrit for code review. The short version of how to patch is:
Register at https://gn-review.googlesource.com. ... edit code ... ninja -C out && out/gn_unittests
Then, to upload a change for review:
git commit git cl upload --gerrit
When revising a change, use:
git commit --amend git cl upload --gerrit
which will add the new changes to the existing code review, rather than creating a new one.
We ask that all contributors sign Google's Contributor License Agreement (either individual or corporate as appropriate, select ‘any other Google project’).
You may ask questions and follow along w/ GN‘s development on Chromium’s gn-dev@ Google Group.