Move source files into src/, and move tools/gn/misc to the toplevel.

See "Opinion on moving gn source files around?" on gn-dev.

Ran:
  mkdir src
  git mv tools/gn src
  git mv base src
  git mv util base
  git mv src/gn/misc .

Updated include paths with:
  grep -lR tools/gn src/ | xargs sed -i 's:tools/gn:gn:'

And then manually fixed up:
  misc/emacs/gn-mode.el
  misc/vim/README.md
  src/gn/command_format_unittest.cc
  src/gn/function_rebase_path_unittest.cc
  src/gn/label.cc
  src/gn/visual_studio_writer_unittest.cc

Updated build/gen.py manually.

No intended behavior change.

Change-Id: I186efa6775327d613bf849e20527103548ac454b
Reviewed-on: https://gn-review.googlesource.com/c/gn/+/6440
Commit-Queue: Brett Wilson <brettw@chromium.org>
Reviewed-by: Brett Wilson <brettw@chromium.org>
627 files changed
tree: 16057fce0c65fa756ed1348b12aed4b8b676998a
  1. build/
  2. docs/
  3. examples/
  4. infra/
  5. misc/
  6. src/
  7. .clang-format
  8. .editorconfig
  9. .gitignore
  10. .style.yapf
  11. AUTHORS
  12. LICENSE
  13. OWNERS
  14. README.md
README.md

GN

GN is a meta-build system that generates build files for Ninja.

Related resources:

Getting a binary

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.

Examples

There is a simple example in examples/simple_build directory that is a good place to get started with the minimal configuration.

For a maximal configuration see the Chromium setup:

and the Fuchsia setup:

Reporting bugs

If you find a bug, you can see if it is known or report it in the bug database.

Sending patches

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’).

Community

You may ask questions and follow along with GN‘s development on Chromium’s gn-dev@ Google Group.