| commit | 6e8e7a693ac977034ad8062e125b7deb51f1b4eb | [log] [tgz] |
|---|---|---|
| author | David 'Digit' Turner <digit@google.com> | Thu Jun 05 14:36:03 2025 +0200 |
| committer | David 'Digit' Turner <digit@google.com> | Thu Jun 05 17:38:25 2025 +0200 |
| tree | 330688d7aefc46942ecc354d45dc7542e590b06a | |
| parent | 4fd24ada1573b0201960133ff1a133941dc8a17a [diff] |
Add GzipOutputStream class. This compresses the output into a gzip stream. This can be useful to compress the --chrome_trace output which compress very well due to the extremely high amount of redundancy (e.g. 180 MiB -> 9 MiB). Because zlib is not provided by the Fuchsia Linux sysroot and likely not by the Windows SDK, the class provides a static IsSupported() method to return true only when zlib could be linked to the Ninja library. If the method returns false, calling the constructor will crash with a Fatal() message. This allows committing this CL directly, and later updating the LUCI recipe that builds Ninja on Fuchsia infra builders to add the missing zlib-dev dependency. + Add OutputStream::Flush() method. + Modify the build-ninja.sh script to deal with the Fuchsia sysroot not providing zlib.h / libz.so / libz.a at all. The work-around is to compie zlib from source as a static library and link it into the Ninja binary. This uses the sources from $FUCHSIA_DIR/third_party/zlib when --fuchsia-dir=FUCHSIA_DIR is used, otherwise, this checkout the sources from the fuchsia git mirror instead. Fuchsia-Topic: chrome-tracing Fuchsia-Topic: build-event-stream Change-Id: I6e3ac3a732364523882c018a18ad2b7131b6d06a
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.
You can either build Ninja via the custom generator script written in Python or via CMake. For more details see the wiki.
./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 -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
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.
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.