Google GitGoogle Git
Sign in
fuchsia/third_party/github.com/ninja-build/ninja/20e1df18fa81986a00f2bd7fdbda5da132f0b2dd
commit
20e1df18fa81986a00f2bd7fdbda5da132f0b2dd
[log]
author
David 'Digit' Turner <digit@google.com>
Sat Jun 10 22:25:57 2023 +0200
committer
David Turner <digit@google.com>
Thu Jun 27 08:52:40 2024 +0000
tree
a28a02a7659703a9014b1ab291b9bc0ad6387a01
parent
b0ffc17a31fe25a6a9f0f3cb4a4728516cecabf9 [diff]
Add PersistentService class

A class that implements a generic facility to spawn
a background server process and communicate with it.

This comes with a small persistent_service_test_helper[.exe]
executable that will be launched during unit-testing
to verify that things work as expected.

Fuchsia-Topic: persistent-mode
Original-Change-Id: Ifeca100d77e97193a9d347ccbdbee73661a550d8
Original-Change-Id: Ica91c9d138ab9f355b81ea20ad89330badc5aebd
Original-Change-Id: I5aa72a6433f9259ed33ed23af35c59b4e1f40a98
Original-Change-Id: I2a1d34f848144601a320c0b8eb6bbb3071df6ca5
Original-Change-Id: I81e4efac0f8c56979e8abdcd7459dada62aca929
Original-Change-Id: I8bdffeaaa8445cbef845793048bbc891b3e23332
Change-Id: I946e2845cc9030a3a6fddc56f4ade864b0fff096
Reviewed-on: https://fuchsia-review.googlesource.com/c/third_party/github.com/ninja-build/ninja/+/1071427
Reviewed-by: David Fang <fangism@google.com>
8 files changed
tree: a28a02a7659703a9014b1ab291b9bc0ad6387a01
  1. .github/
  2. doc/
  3. misc/
  4. src/
  5. windows/
  6. .clang-format
  7. .clang-tidy
  8. .editorconfig
  9. .gitignore
  10. appveyor.yml
  11. CMakeLists.txt
  12. configure.py
  13. CONTRIBUTING.md
  14. COPYING
  15. README.fuchsia
  16. README.md
  17. RELEASING.md
README.md

Ninja

Ninja is a small build system with a focus on speed. https://ninja-build.org/

See the manual or doc/manual.asciidoc included in the distribution for background and more details.

Binaries for Linux, Mac and Windows are available on GitHub. Run ./ninja -h for Ninja help.

Installation is not necessary because the only required file is the resulting ninja binary. However, to enable features like Bash completion and Emacs and Vim editing modes, some files in misc/ must be copied to appropriate locations.

If you're interested in making changes to Ninja, read CONTRIBUTING.md first.

Building Ninja itself

You can either build Ninja via the custom generator script written in Python or via CMake. For more details see the wiki.

Python

./configure.py --bootstrap

This will generate the ninja binary and a build.ninja file you can now use to build Ninja with itself.

If you have a GoogleTest source directory, you can build the tests by passing its path with --gtest-source-dir=PATH option, or the GTEST_SOURCE_DIR environment variable, e.g.:

./configure.py --bootstrap --gtest-source-dir=/path/to/googletest
./ninja all     # build ninja_test and other auxiliary binaries
./ninja_test`   # run the unit-test suite.

Use the CMake build below if you want to use a preinstalled binary version of the library.

CMake

cmake -Bbuild-cmake
cmake --build build-cmake

The ninja binary will now be inside the build-cmake directory (you can choose any other name you like).

To run the unit tests:

./build-cmake/ninja_test

Generating documentation

Ninja Manual

You must have asciidoc and xsltproc in your PATH, then do:

./configure.py
ninja manual doc/manual.pdf

Which will generate doc/manual.html.

To generate the PDF version of the manual, you must have dblatext in your PATH then do:

./configure.py    # only if you didn't do it previously.
ninja doc/manual.pdf

Which will generate doc/manual.pdf.

Doxygen documentation

If you have doxygen installed, you can build documentation extracted from C++ declarations and comments to help you navigate the code. Note that Ninja is a standalone executable, not a library, so there is no public API, all details exposed here are internal.

./configure.py   # if needed
ninja doxygen

Then open doc/doxygen/html/index.html in a browser to look at it.