[bes] Reorganize Bazel BEP support files. This CL modifies how the files used to manage Ninja's Bazel Build Event Stream protocol are store in the source tree: - All related files, except those in src/ are moved to misc/fuchsia/bes/ - Add misc/fuchsia/README.md and misc/fuchsia/bes/README.md that describes the content of their respective directories. - Add misc/fuchsia/bes/android-patches/ to list the series of patches applied to the Android sources. The exact source commit is listed in the bes/README.md file. - Add the `generate_proto_header_test.py` from the Android tree as well. - Add download_and_build_requirements.sh script to download the requirements for regenerating the build_event_stream.pb.h header from scratch. This downloads Bazel and Protobuf binaries and sources from fixed versions from their respective official git archives (and checks their sha256 sums for safety), and also performs a bazel build to generate the Protobuf python source wheel. Building the source wheel is required by recent protobuf releases, as the content of protobuf/python/ is no longer directly importable. Some of the .py files in the final source wheels are auto-generated by misc Bazel rules that are too complex to replicate manually here. Hence the need for a `bazel build //python/dist:source_wheel` is needed. Even after that, its content must be copied to a different directory that also includes the pb2.py files generated by the protoc compiler. Shell script has been verified with `shellcheck` for defects. - Add the new `generate_bes_header.py` to drive the whole header generation operation. This uses the content of the requirements directory, and does all operations required to get a new header. This supports the `--run-test` flag to run the `generate_proto_header_test.py` unit-test. This replaces generate_build_event_stream_proto.sh + A new version of build_event_stream.pb.h, based on the Bazel 8.0.0 and Protobuf 29.3 sources (versions are hard-coded in download_and_build_bes_requirements.sh) Fuchsia-Topic: build-event-stream Change-Id: I62d46ac6ec1b2ecc3995dabf600860f78d318ca0
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.