Ниндзя

Ниндзя — это небольшая система сборки с акцентом на скорость. https://ninja-build.org/

Дополнительную информацию и подробности можно найти в руководстве или в файле doc/manual.asciidoc, входящем в распределение.

Бинарники для Linux, macOS и Windows доступны на GitHub. Запустите ./ninja -h для получения справки по Ниндзя.

Установка не требуется, так как единственным необходимым файлом является полученный бинарник Ниндзя. Однако, чтобы активировать такие возможности, как автозавершение команд Bash, режимы редактирования Emacs и Vim, некоторые файлы из папки misc/ должны быть скопированы в соответствующие места.

Если вы хотите внести изменения в Ниндзя, рекомендуется сначала ознакомиться с CONTRIBUTING.md.

Сборка Ниндзя самой собой

Вы можете собрать Ниндзя либо через специальный генератор, написанный на Python, либо через CMake. Для более подробной информации см. вики.

Python

./configure.py --bootstrap

Это создаст бинарник ninja и файл build.ninja, который вы сможете использовать для сборки Ниндзя самой собой.

Если у вас есть директория с исходным кодом GoogleTest, вы можете собрать тесты, передав путь к этой директории с помощью опции --gtest-source-dir=ПУТЬ или переменной окружения GTEST_SOURCE_DIR, например:

./configure.py --bootstrap --gtest-source-dir=/путь/к/google_test
./ninja all     # собирает ninja_test и другие вспомогательные бинарники
./ninja_test    # запускает набор юнит-тестов.

Используйте нижеследующую сборку через CMake, если вы хотите использовать предустановленную версию библиотеки.

CMake

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

Бинарник ninja теперь будет находиться внутри директории build-cmake (вы можете выбрать любое другое имя по своему выбору).

Чтобы запустить юнит-тесты:

./build-cmake/ninja_test

Генерация документации

Руководство Ниндзя

Необходимо наличие asciidoc и xsltproc в вашей переменной PATH, затем выполните:

./configure.py
ninja manual doc/manual.html

Что создаст doc/manual.html.

Чтобы сгенерировать PDF-версию руководства, вам потребуется наличие dblatex в вашей переменной PATH, затем выполните:

./configure.py    # только если вы еще не выполняли эту команду ранее.
ninja doc/manual.pdf

Что создаст doc/manual.pdf.

Документация Doxygen

Если у вас установлен doxygen, вы можете сгенерировать документацию, извлеченную из объявлений C++ и комментариев, чтобы помочь вам ориентироваться в коде. Обратите внимание, что Ниндзя представляет собой самостоятельное исполняемое приложение, а не библиотеку, поэтому нет открытого API, все детали здесь являются внутренними.

./configure.py   # если необходимо
ninja doxygen

Затем откройте doc/doxygen/html/index.html в браузере для просмотра.