Сценарий обслуживания Nim

"Великий повар — это художник, которого я глубоко уважаю" — Роберт Стак.

Введение

Программа koch является скриптом обслуживания Nim. Она заменяет make и shell-скрипты, имея преимущество высокой переносимости. Слово koch означает повар на немецком языке. koch используется главным образом для сборки компилятора Nim, но также может быть использована для других задач. Этот документ описывает поддерживаемые команды и их опции.

Команды

Команда boot

Команда boot выполняет загрузку компилятора и принимает различные опции:

-d:release

По умолчанию создаётся отладочная версия. Передача этой опции принудительно создаёт релизную сборку, которая значительно быстрее и предпочтительна, если вы не отлаживаете компилятор.

-d:nimUseLinenoise

Использование библиотеки linenoise для интерактивного режима (не требуется в Windows).

-d:leanCompiler

Создание компилятора без генерации кода JS и документации для экономии оперативной памяти при загрузке.

После завершения компиляции, компилятор Nim, вероятно, будет находиться в каталоге bin. Вы можете добавить каталог bin Nim в свой $PATH или использовать команду install для размещения его в доступном месте.

Команда csource

Команда csource собирает исходные файлы C для установки. Она принимает те же опции, что и команда boot.

Команда temp

Команда temp собирает компилятор Nim, но с другим конечным именем (nim_temp), поэтому не перезаписывает ваш стандартный компилятор. Вы можете использовать эту команду для тестирования различных опций, аналогично тому, как вы бы это делали для команды boot.

Команда test

Команда test также может быть вызвана с псевдонимом tests. Эта команда будет компилировать и запускать testament/tester.nim, который является основным драйвером набора тестов Nim. Вы можете передавать опции команде test, они будут перенаправлены в тестировщик. Для получения доступных опций обратитесь к исходному коду.

Команда web

Команда web конвертирует документацию в каталоге doc из формата rst в HTML. Также выполняет ту же операцию, но помещает результат в web/upload, что может быть использовано для обновления сайта по адресу https://nim-lang.org.

По умолчанию документация будет построена параллельно, используя количество доступных ядер процессора. Если какие-либо подкоманды построения документации завершатся неудачно, они будут повторены последовательно, чтобы можно было собрать полезные сообщения об ошибках для проверки. Переключатель или опция конфигурации --parallelBuild:n может быть использована для принудительного задания определённого количества параллельных задач или выполнения всего последовательно с самого начала (n == 1).

Команда pdf

Команда pdf генерирует версии документации Nim в формате PDF: Руководство, Учебник и некоторые другие документы. Для её работы необходимо предварительно установить Latex/xelatex.