Google Git
Sign in
android / platform / external / n2 / refs/heads/upstream
commit110d191d73e8b42aec329a358d332cd6862cbc78[log] [tgz]
authorCole Faust <[email protected]>Thu Mar 21 14:12:44 2024 -0700
committerCole Faust <[email protected]>Thu Mar 21 14:26:48 2024 -0700
tree0b9a4453a315d92909fa1fb2812ddc3566efc11d
parent8881a661ae63e1124eb47b45f08d9fa1225a5f00 [diff]
Import n2 to android

Test: m n2
Third-Party Import of: https://github.com/evmar/n2
Request Document: go/android3p
For CL Reviewers: go/android3p#reviewing-a-cl
For Build Team: go/ab-third-party-imports
Bug: http://b/328273370
Original import of the code can be found at: https://googleplex-android.googlesource.com/platform/external/n2/+/refs/heads/third-party-review.
Security Questionnaire: http://b/328273370#comment1

Change-Id: Iab199b146d606cb1e8212f5c38d8612a5845b6bf
5 files changed
tree: 0b9a4453a315d92909fa1fb2812ddc3566efc11d
  1. .github/
  2. .vscode/
  3. benches/
  4. doc/
  5. src/
  6. tests/
  7. .gitignore
  8. Android.bp
  9. Cargo.lock
  10. Cargo.toml
  11. dprint.json
  12. git-pre-commit
  13. LICENSE
  14. METADATA
  15. MODULE_LICENSE_APACHE2
  16. OWNERS
  17. README.md
README.md

n2, an alternative ninja implementation

CI status

n2 (pronounced “into”) implements enough of Ninja to successfully build some projects that build with Ninja. Compared to Ninja, n2 missing some features but is faster to build and has a better UI; see a more detailed comparison.

Here's a small demo of n2 building some of Clang.

Install

$ cargo install --git https://github.com/evmar/n2
# (installs into ~/.cargo/bin/)

$ n2 -C some/build/dir some-target

Using with CMake

When CMake generates Ninja files it attempts run a program named ninja with some particular Ninja behaviors. In particular, it attempts to inform Ninja/n2 that its generated build files are up to date so that the build system doesn't attempt to rebuild them.

n2 can emulate the expected CMake behavior when invoked as ninja. To do this you create a symlink named ninja somewhere in your $PATH, such that CMake can discover it.

  • UNIX: ln -s path/to/n2 ninja
  • Windows(cmd): mklink ninja.exe path\to\n2
  • Windows(PowerShell): New-Item -Type Symlink ninja.exe -Target path\to\n2

Warning
If you don't have Ninja installed at all, you must install such a symlink because CMake attempts to invoke ninja itself!

The console output

While building, n2 displays build progress like this:

[=========================---------       ] 2772/4459 done, 8/930 running
Building foo/bar (2s)
Building foo/baz

The progress bar always covers all build steps needed for the targets, regardless of whether they need to be executed or not.

The bar shows three categories of state:

  • Done: The = signs show the build steps that are already up to date.
  • In progress: The - signs show steps that are in-progress; if you had enough CPUs they would all be executing. The 8/930 running after shows that n2 is currently executing 8 of the 930 available steps.
  • Unknown: The remaining empty space indicates steps whose status is yet to be known, as they depend on the in progress steps. For example, if an intermediate step doesn't write its outputs n2 may not need to execute the dependent steps.

The lines below the progress bar show some build steps that are currrently running, along with how long they've been running if it has been a while. Their text is controlled by the input build.ninja file.

More reading

I wrote n2 to explore some alternative ideas I had around how to structure a build system. In a very real sense the exploration is more important than the actual software itself, so you can view the design notes as one of the primary artifacts of this.