Add some more docs on source sets, static libraries, and shlibs.

Hopefully this clarifies the decision process for when to use
which a little bit more.

Change-Id: If23015e935b90af5031e86e03962a4dbfb618147
Reviewed-on: https://gn-review.googlesource.com/c/3100
Reviewed-by: Brett Wilson <brettw@google.com>
Commit-Queue: Dirk Pranke <dpranke@chromium.org>
1 file changed
tree: 15ceb6f781b93070d3d694ca853f124a5fbf2151
  1. base/
  2. build/
  3. docs/
  4. infra/
  5. tools/
  6. util/
  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. There is documentation in docs/.

Getting started

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.

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 w/ GN‘s development on Chromium’s gn-dev@ Google Group.