Improve help output.

Make the links in markdown for the "args" command and target variable
work by disambiguating href names in by variable type.

Special-case "gn help args" on the command line by printing help for
both the command and the variable.

Fix misnaming of xcode_test_application_name.

Fix incorrect linking of switch help and bad hadings and wrapping for
input and output conversion help.

Simplify markdown tag emitting by requiring the the caller generate
a tag for linking rather than trying to autogenerate one based on
text that comes before a colon. This autogeneration code was not
used.

Change-Id: I7dd3f806eac5afaef746b2e37bf0903d9ae72b14
Reviewed-on: https://gn-review.googlesource.com/c/3520
Reviewed-by: Julie Hockett <juliehockett@google.com>
Commit-Queue: Brett Wilson <brettw@chromium.org>
7 files changed
tree: 59be3c699735adc3fef7e2345a65d31b31db77ab
  1. .clang-format
  2. .editorconfig
  3. .gitignore
  4. .style.yapf
  5. AUTHORS
  6. LICENSE
  7. OWNERS
  8. README.md
  9. base/
  10. build/
  11. docs/
  12. infra/
  13. tools/
  14. util/
README.md

GN

GN is a meta-build system that generates build files for Ninja. There is documentation in docs/ and a presentation on it.

Getting started

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.

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.