mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 18:39:42 +00:00
Compare commits
20 Commits
50fa84c317
...
0e2d05788a
| Author | SHA1 | Date | |
|---|---|---|---|
| 0e2d05788a | |||
| 468cdef2d9 | |||
| ee9cade5c8 | |||
| 25ab25b9a2 | |||
| 360619fb78 | |||
| 4c24089cb2 | |||
| 3e810c476d | |||
| 5682792c2f | |||
| ff5d8ba4bf | |||
| 0f1fff7072 | |||
| b8cceb2945 | |||
| fce6804c32 | |||
| a988adea3a | |||
| 6575f5d2f0 | |||
| 17aa2937be | |||
| 828624860a | |||
| 66195b53e2 | |||
| 8ded7958f6 | |||
| 9c9a2d9096 | |||
| 9d033ef9a4 |
@@ -24,18 +24,18 @@ dcr run
|
||||
## Содержание
|
||||
|
||||
| Раздел | Описание |
|
||||
| ----------------------------------------------------- | -------------------------------------------- |
|
||||
| [Getting Started](/docs/getting-started/installation) | Установка и первые шаги |
|
||||
| [Commands](/docs/commands/project-commands) | Все CLI-команды DCR |
|
||||
| [Reference](/docs/reference/dcr-toml) | Конфигурация, сборка, зависимости, платформы |
|
||||
| [Testing](/docs/testing/test-framework) | Встроенный фреймворк тестирования |
|
||||
| [Recipes](/docs/recipes/cross-to-windows) | Типовые сценарии |
|
||||
| [IDE Integration](/docs/ide-integration) | VS Code, CLion, compile_commands.json |
|
||||
| [Self Update](/docs/self-update) | Автообновление |
|
||||
| [FAQ](/docs/faq) | Частые вопросы |
|
||||
| [Changelog](/docs/changelog) | История версий |
|
||||
| [License](/docs/license) | Лицензии DCR и вендорных библиотек |
|
||||
| [Contributing](/docs/contributing) | Разработка DCR |
|
||||
| --------------------------------------------------- | -------------------------------------------- |
|
||||
| [Начало работы](/docs/getting-started/installation) | Установка и первые шаги |
|
||||
| [Команды](/docs/commands/project-commands) | Все CLI-команды DCR |
|
||||
| [Ссылка](/docs/reference/dcr-toml) | Конфигурация, сборка, зависимости, платформы |
|
||||
| [Тестирование](/docs/testing/test-framework) | Встроенный фреймворк тестирования |
|
||||
| [Рецепты](/docs/recipes/cross-to-windows) | Типовые сценарии |
|
||||
| [Интеграция с IDE](/docs/ide-integration) | VS Code, CLion, compile_commands.json |
|
||||
| [Автоматическое обновление](/docs/self-update) | Автообновление |
|
||||
| [Часто задаваемые вопросы](/docs/faq) | Частые вопросы |
|
||||
| [Журнал изменений](/docs/changelog) | История версий |
|
||||
| [Лицензия](/docs/license) | Лицензии DCR и вендорных библиотек |
|
||||
| [Внести свой вклад](/docs/contributing) | Разработка DCR |
|
||||
|
||||
## Особенности
|
||||
|
||||
@@ -49,5 +49,5 @@ dcr run
|
||||
* **Registry + Git + Path** — три механизма зависимостей
|
||||
* **Генерация IDE** — VS Code, CLion, compile_commands.json, JSON metadata
|
||||
* **pkg-config** — автоматический поиск системных библиотек
|
||||
* **Per-command `--help`** — `dcr build --help`, `dcr new --help`, etc.
|
||||
* **Man pages** — `man dcr`, `man dcr-build`, `man dcr-new`
|
||||
* **Команда `--help` для каждой команды** — `dcr build --help`, `dcr new --help` и т. д.
|
||||
* **Справочные страницы** — `man dcr`, `man dcr-build`, `man dcr-new`
|
||||
|
||||
@@ -1,56 +1,56 @@
|
||||
---
|
||||
sidebar_label: Changelog
|
||||
sidebar_label: Список изменений
|
||||
---
|
||||
|
||||
# Changelog
|
||||
# Список изменений
|
||||
|
||||
## 0.7.1 (2026-06-02)
|
||||
## 0.7.1 (02.06.2026)
|
||||
|
||||
### Добавлено:
|
||||
|
||||
* **`--help` for all commands** — `dcr build --help`, `dcr run --help`, `dcr new --help`,
|
||||
* **`--help` для всех команд** — `dcr build --help`, `dcr run --help`, `dcr new --help`,
|
||||
`dcr init --help`, `dcr clean --help`, `dcr add --help`, `dcr fmt --help`,
|
||||
`dcr setup --help`, `dcr tree --help`, `dcr gen --help`, `dcr --update --help`,
|
||||
`dcr test --help`. All output uses styled headers (green) and usage lines (cyan).
|
||||
* **Man pages** — 12 troff pages in `man/man1/`: `dcr.1`, `dcr-build.1`,
|
||||
`dcr test --help`. Во всех результатах вывода используются стилизованные заголовки (зелёного цвета) и строки с информацией об использовании (голубого цвета).
|
||||
* **Справочные страницы** — 12 страниц в формате troff в каталоге `man/man1/`: `dcr.1`, `dcr-build.1`,
|
||||
`dcr-run.1`, `dcr-new.1`, `dcr-init.1`, `dcr-clean.1`, `dcr-add.1`, `dcr-test.1`,
|
||||
`dcr-gen.1`, `dcr-fmt.1`, `dcr-tree.1`, `dcr-setup.1`.
|
||||
* **Man pages in all packaging** — install.sh, install_bsd.sh, AUR PKGBUILD,
|
||||
* **Справочные страницы во всех пакетах** — install.sh, install_bsd.sh, PKGBUILD из AUR,
|
||||
Debian (cargo-deb), RPM (cargo-generate-rpm), Nix (postInstall), Homebrew
|
||||
(resource), Snap, GitHub Release assets.
|
||||
* **Project name validation** — `dcr init` and `dcr new` now validate names before
|
||||
creating files. Only ASCII letters, digits, `_` and `-` are allowed.
|
||||
* **`documentation` and `homepage` fields** — added to `Cargo.toml`.
|
||||
* **Release profile optimizations** — `opt-level = "z"`, LTO, `codegen-units = 1`,
|
||||
`panic = "abort"`, `strip = true` for smaller binaries.
|
||||
* **Linux i686, armv7, riscv64 targets** — added to release workflow and install scripts.
|
||||
* **Linux musl i686, armv7 targets** — cross-compiled via zigbuild in CI.
|
||||
* **AUR packages** — `dcr-dev`, `dcr-dev-bin` publishing workflow.
|
||||
* **Snap publishing** — automated Snapcraft publishing in CI.
|
||||
* **Snap badge** — in README.
|
||||
(ресурс), Snap, ресурсы релизов GitHub.
|
||||
* **Проверка имени проекта** — команды `dcr init` и `dcr new` теперь проверяют имена перед созданием файлов
|
||||
. Допускаются только буквы ASCII, цифры, символы `_` и `-`.
|
||||
* **Поля `documentation` и `homepage`** — добавлены в файл `Cargo.toml`.
|
||||
* **Оптимизации профиля релиза** — `opt-level = "z"`, LTO, `codegen-units = 1`,
|
||||
`panic = "abort"`, `strip = true` для уменьшения размера бинарных файлов.
|
||||
* **Платформы Linux i686, armv7, riscv64** — добавлены в рабочий процесс выпуска и скрипты установки.
|
||||
* **Платформы Linux musl i686 и armv7** — скомпилированы с помощью zigbuild в системе непрерывной интеграции (CI).
|
||||
* **Пакеты AUR** — рабочий процесс публикации `dcr-dev`, `dcr-dev-bin`.
|
||||
* **Публикация Snap** — автоматическая публикация Snapcraft в рамках непрерывной интеграции (CI).
|
||||
* **Значок Snap** — в файле README.
|
||||
|
||||
### Изменено:
|
||||
|
||||
* **`validate_package_name` made public** — callable from CLI commands.
|
||||
* **README platform table** — reorganized: libc variants as separate OS rows,
|
||||
removed extra columns. Linux architecture list updated.
|
||||
* **`gen.rs` no-args output** — now uses styled output instead of raw `eprintln!`.
|
||||
* **`tree.rs`, `fmt.rs`, and `setup.rs`** — now accept arguments for `--help`.
|
||||
* **README install commands** — `| bash` → `| sh` for POSIX compatibility.
|
||||
* **`validate_package_name` стал общедоступным** — его можно вызывать из команд CLI.
|
||||
* **Таблица платформы README** — реорганизована: варианты libc вынесены в отдельные строки по ОС,
|
||||
удалены лишние столбцы. Обновлен список архитектур Linux.
|
||||
* **Вывод `gen.rs` без аргументов** — теперь используется стилизованный вывод вместо необработанного `eprintln!`.
|
||||
* **`tree.rs`, `fmt.rs` и `setup.rs`** — теперь поддерживают аргументы для опции `--help`.
|
||||
* **Команды установки из файла README** — `| bash` → `| sh` для обеспечения совместимости с POSIX.
|
||||
|
||||
### Исправлено:
|
||||
|
||||
* **`dcr new \<invalid-name>` creates directory then fails** — validation now
|
||||
happens before any file operations.
|
||||
* **`dcr init` on invalid directory name** — same fix.
|
||||
* **Man pages missing in installed packages** — now shipped in all formats.
|
||||
* **Windows drive letter false positive** — in dependency file parser.
|
||||
* **CRLF (`\r\n`) breaks dependency parser** — now handles mixed line endings.
|
||||
* **Newline after backslash not consumed** — in `parse_d_file` escape handling.
|
||||
* **`dcr new \<invalid-name>` создает каталог, а затем завершается с ошибкой** — теперь проверка
|
||||
выполняется до начала любых операций с файлами.
|
||||
* **`dcr init` при указании недопустимого имени каталога** — то же исправление.
|
||||
* **Отсутствующие справочные страницы в установленных пакетах** — теперь поставляются во всех форматах.
|
||||
* **Ложное срабатывание по букве диска Windows** — в модуле анализа файлов зависимостей.
|
||||
* **CRLF (`\r\n`) вызывает сбой в работе парсера зависимостей** — теперь поддерживается обработка смешанных символов окончания строк.
|
||||
* **Новая строка после обратного слеша не обработана** — при обработке экранирующих символов в функции `parse_d_file`.
|
||||
|
||||
## 0.7.0 (2026-06-01)
|
||||
## 0.7.0 (01.06.2026)
|
||||
|
||||
### Added
|
||||
### Добавлено
|
||||
|
||||
* **Поддержка целевых платформ OpenBSD и NetBSD** — полная маршрутизация по платформам с динамически генерируемыми тройками целевых параметров с использованием `std::env::consts::ARCH` и `std::env::consts::OS`. Затрагивает команды `build`, `run`, `clean` и модуль платформы.
|
||||
* **`src/platform/bsd.rs`** — новый специальный модуль платформы BSD, общий для FreeBSD, OpenBSD и NetBSD, предоставляющий `bin_path`, `lib_path`, `elf_path`, `efi_path` и `shared_lib_path`.
|
||||
@@ -65,7 +65,7 @@ sidebar_label: Changelog
|
||||
* **Интеграционные тесты** — `build_with_target_config` (проверяет `build.target = «linux»`) и `build_with_out_dir` (проверяет настраиваемый каталог вывода).
|
||||
* **`get_build_string_with_profile` стал `pub`** — чтобы `run.rs` мог определять конфигурацию настраиваемого каталога вывода.
|
||||
|
||||
### Changed
|
||||
### Изменено
|
||||
|
||||
* **Изменена семантика `build.target`** — теперь строго содержит тройку целей (например, `x86_64-unknown-linux-gnu`) или короткое имя (`linux`, `macos`, `windows`). Больше не используется в качестве пользовательского каталога вывода — эта функциональность перенесена в `build.out_dir`.
|
||||
* **`build.standard` стал опциональным** — изменен с `String` на `Option\<String>`. Проверка обеспечивает только непустоту для языков, отличных от ASM. Пропускается в выводе `dcr.toml`, если пуст.
|
||||
@@ -75,7 +75,7 @@ sidebar_label: Changelog
|
||||
* **Таблица совместимости README** — статус сборки/работы на FreeBSD, OpenBSD, NetBSD повышен с «сообщество/по возможности» до «официально поддерживается».
|
||||
* **Обновлена документация** — `build-section.md` описывает новые поля `build.target` и `build.out_dir`. `target-directory.md` переписан для уточнения различия.
|
||||
|
||||
### Fixed
|
||||
### Исправлено
|
||||
|
||||
* **stdout/stderr `dcr run` не наследуются** — вывод дочернего процесса захватывался и выводился вручную, что приводило к сбоям интерактивных программ. Исправлено путем перехода на `Command::status()`.
|
||||
* **Условие гонки в CI релиза** — задания матрицы сборки могли загружать ресурсы в релиз, который еще не существовал. Исправлено добавлением специального задания `create-release`.
|
||||
|
||||
@@ -25,11 +25,11 @@ dcr test --init
|
||||
|
||||
Что делает `dcr test`:
|
||||
|
||||
1. Builds the project
|
||||
2. Collects `tests/*.c` files (`.c` only, not `.cpp`)
|
||||
3. Compiles and links each test file
|
||||
4. Runs each test binary
|
||||
5. Prints summary: TOTAL, PASS, SKIP, FAIL
|
||||
1. Собирает проект
|
||||
2. Собирает файлы `tests/*.c` (только `.c`, не `.cpp`)
|
||||
3. Компилирует и линкует каждый файл теста
|
||||
4. Запускает каждый бинарник тестов
|
||||
5. Вывод сводки: TOTAL, PASS, SKIP, FAIL
|
||||
6. Возвращает ненулевой код при наличии FAIL
|
||||
|
||||
## `dcr fmt`
|
||||
@@ -40,21 +40,21 @@ dcr test --init
|
||||
dcr fmt
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}` and `tests/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}`.
|
||||
Процессы: `src/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}` и `tests/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}`.
|
||||
|
||||
Использует `.clang-format` в корне проекта (если таковой имеется), иначе стиль clang-format по умолчанию.
|
||||
|
||||
## `dcr lint`
|
||||
|
||||
Runs `clang-tidy` on C/C++ source files for static analysis.
|
||||
Выполняет `clang-tidy` на C/C++ исходных файлах для статического анализа.
|
||||
|
||||
```bash
|
||||
dcr lint # show diagnostics
|
||||
dcr lint --fix # apply fixes automatically
|
||||
dcr lint --help # detailed help
|
||||
dcr lint # отобразить диагностику
|
||||
dcr lint --fix # автоматически применить исправления
|
||||
dcr lint --help # подробная справка
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc}` and `tests/**/*.{c,cpp,cxx,cc}`.
|
||||
Процессы: `src/**/*.{c,cpp,cxx,cc}` и `tests/**/*.{c,cpp,cxx,cc}`.
|
||||
|
||||
Without `--fix`, clang-tidy reports warnings and errors without modifying files.
|
||||
With `--fix`, clang-tidy applies automatic suggestions in place.
|
||||
Без параметра `--fix` clang-tidy выдает предупреждения и ошибки, не внося изменений в файлы.
|
||||
При параметре `--fix` clang-tidy автоматически вносит предложения по исправлениям на месте.
|
||||
|
||||
@@ -12,7 +12,7 @@ sidebar_label: Системные команды (setup, --help, ...)
|
||||
dcr setup
|
||||
```
|
||||
|
||||
If `~/.dcr/config.toml` is not found, DCR returns an error. Create it manually:
|
||||
Если файл `~/.dcr/config.toml` не найден, DCR возвращает ошибку. Создайте его вручную:
|
||||
|
||||
```toml
|
||||
[[registry]]
|
||||
@@ -22,31 +22,30 @@ url = "https://index.dcr.pm"
|
||||
|
||||
## `dcr --help`
|
||||
|
||||
Shows help for all commands.
|
||||
Отображает справку по всем командам.
|
||||
|
||||
```bash
|
||||
dcr --help
|
||||
dcr build --help # справка по конкретной команде
|
||||
```
|
||||
|
||||
## `dcr --version`
|
||||
|
||||
Shows version and target triple.
|
||||
Отображает версию и целевую платформу.
|
||||
|
||||
```bash
|
||||
dcr --version # dcr 0.7.0
|
||||
dcr --version # dcr 0.7.0 (x86_64-unknown-linux-gnu)
|
||||
```
|
||||
|
||||
## `dcr --update`
|
||||
|
||||
Самообновление. Скачивает последний релиз с GitHub Releases и заменяет текущий бинарник.
|
||||
Автоматическое обновление. Загружает последнюю версию бинарного файла из раздела «Релизы» на GitHub и заменяет текущую версию.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
Особенности:
|
||||
Возможности:
|
||||
|
||||
* Определяет платформу и архитектуру автоматически
|
||||
* Warns if installed via AUR (use package manager instead)
|
||||
* Выдает предупреждение при установке через AUR (вместо этого используйте пакетный менеджер)
|
||||
* Работает на Linux, macOS, Windows
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
sidebar_label: Contributing
|
||||
sidebar_label: Вклад
|
||||
---
|
||||
|
||||
# Contributing
|
||||
# Вклад
|
||||
|
||||
## Setup
|
||||
## Настройка
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dexoron/dcr
|
||||
@@ -12,12 +12,12 @@ cd dcr
|
||||
cargo build
|
||||
```
|
||||
|
||||
## Code style
|
||||
## Стиль написания кода
|
||||
|
||||
Весь код форматируется через `cargo fmt`:
|
||||
|
||||
```bash
|
||||
cargo fmt
|
||||
формат груза
|
||||
```
|
||||
|
||||
## Линтер
|
||||
@@ -29,10 +29,10 @@ cargo clippy --all-targets -- -D warnings
|
||||
## Тесты
|
||||
|
||||
```bash
|
||||
cargo test --all-targets
|
||||
тест cargo --all-targets
|
||||
```
|
||||
|
||||
## PR process
|
||||
## Процесс связей с общественностью
|
||||
|
||||
1. Форкните репозиторий
|
||||
2. Создайте ветку: `git checkout -b feature/description`
|
||||
|
||||
@@ -4,16 +4,16 @@ sidebar_label: Часто задаваемые вопросы
|
||||
|
||||
# Часто задаваемые вопросы
|
||||
|
||||
## Registry not found
|
||||
## Реестр не найден
|
||||
|
||||
```
|
||||
error: registry not found
|
||||
Ошибка: реестр не найден
|
||||
```
|
||||
|
||||
**Solution:** Make sure `~/.dcr/config.toml` exists:
|
||||
**Решение:** Убедитесь, что файл `~/.dcr/config.toml` существует:
|
||||
|
||||
```toml
|
||||
[[registry]]
|
||||
[[реестр]]
|
||||
name = "default"
|
||||
url = "https://index.dcr.pm"
|
||||
```
|
||||
@@ -24,27 +24,27 @@ url = "https://index.dcr.pm"
|
||||
echo $DCR_INDEX_PATH
|
||||
```
|
||||
|
||||
## Compiler not found
|
||||
## Компилятор не найден
|
||||
|
||||
```
|
||||
error: compiler not found
|
||||
Ошибка: компилятор не найден
|
||||
```
|
||||
|
||||
**Решение:** Убедитесь, что компилятор установлен и доступен в PATH.
|
||||
|
||||
```bash
|
||||
which gcc
|
||||
which clang
|
||||
какой gcc
|
||||
какой clang
|
||||
```
|
||||
|
||||
Или укажите явно через `[toolchain]` или `DCR_COMPILER`.
|
||||
|
||||
## openssl-sys build failed
|
||||
## Сбой сборки openssl-sys
|
||||
|
||||
При сборке DCR из исходников:
|
||||
|
||||
```
|
||||
error: failed to run custom build command for openssl-sys
|
||||
Ошибка: не удалось выполнить пользовательскую команду сборки для openssl-sys
|
||||
```
|
||||
|
||||
**Решение:** Установите OpenSSL development headers:
|
||||
@@ -68,7 +68,7 @@ DCR корректно обрабатывает SIGINT: прерывает те
|
||||
|
||||
[Library Recipe](/docs/recipes/library-project).
|
||||
|
||||
## How to cross-compile to Windows?
|
||||
## Как выполнить кросс-компиляцию для Windows?
|
||||
|
||||
См. [Cross-Compile Recipe](/docs/recipes/cross-to-windows).
|
||||
|
||||
|
||||
@@ -27,32 +27,27 @@ my-app/
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
description=""
|
||||
author=""
|
||||
license = "GPL-3.0-or-later"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
|
||||
[dependencies]
|
||||
```
|
||||
|
||||
## Build
|
||||
## Сборка
|
||||
|
||||
```bash
|
||||
dcr build
|
||||
```
|
||||
|
||||
Output — `target/\<triple>/debug/my-app` (Linux) or `target/debug/my-app.exe` (Windows).
|
||||
Результат — `target/\<triple>/debug/my-app` (Linux) или `target/debug/my-app.exe` (Windows).
|
||||
|
||||
Профиль:
|
||||
Профиль сборки:
|
||||
|
||||
```bash
|
||||
dcr build --release # релизная сборка
|
||||
dcr build --debug # дебажная (по умолчанию)
|
||||
dcr build --release # release сборка
|
||||
dcr build --debug # debug (по умолчанию)
|
||||
```
|
||||
|
||||
## Запустить
|
||||
@@ -63,11 +58,11 @@ dcr run
|
||||
|
||||
Собирает (если нужно) и запускает бинарник.
|
||||
|
||||
## First test
|
||||
## Первый тест
|
||||
|
||||
```bash
|
||||
dcr test --init # create test template
|
||||
dcr test # run tests
|
||||
dcr test --init # создать шаблон теста
|
||||
dcr test # запустить тесты
|
||||
```
|
||||
|
||||
## Форматирование
|
||||
|
||||
@@ -29,7 +29,7 @@ sudo dnf install dcr
|
||||
## Arch Linux (AUR)
|
||||
|
||||
```sh
|
||||
yay -S dcr
|
||||
ура -S dcr
|
||||
```
|
||||
|
||||
## macOS / Linux (Homebrew)
|
||||
@@ -37,8 +37,6 @@ yay -S dcr
|
||||
```sh
|
||||
brew tap dexoron/dexoron
|
||||
brew install dcr
|
||||
# or
|
||||
brew install dexoron/dexoron/dcr
|
||||
```
|
||||
|
||||
## Snap (Linux)
|
||||
@@ -51,7 +49,7 @@ sudo snap install dcrup
|
||||
|
||||
```sh
|
||||
nix run github:dexoron/dcr
|
||||
# or install to profile:
|
||||
# или установить в профиль:
|
||||
nix profile install github:dexoron/dcr
|
||||
```
|
||||
|
||||
@@ -61,13 +59,13 @@ nix profile install github:dexoron/dcr
|
||||
cargo install dcr
|
||||
```
|
||||
|
||||
## Linux / macOS (script)
|
||||
## Linux / macOS (скрипт)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install_bsd.sh | bash
|
||||
```
|
||||
|
||||
## BSD (script)
|
||||
## BSD (скрипт)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | bash
|
||||
@@ -79,7 +77,7 @@ curl -fsSL https://dcr.dexoron.su/install.sh | bash
|
||||
irm https://dcr.dexoron.su/install.ps1 | iex
|
||||
```
|
||||
|
||||
## From source
|
||||
## Из источника
|
||||
|
||||
```sh
|
||||
git clone https://github.com/dexoron/dcr.git
|
||||
@@ -87,22 +85,22 @@ cd dcr && cargo build --release
|
||||
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
||||
```
|
||||
|
||||
## Post-install
|
||||
## После установки
|
||||
|
||||
Verify the installation:
|
||||
Проверьте установку:
|
||||
|
||||
```bash
|
||||
dcr setup
|
||||
```
|
||||
|
||||
Man pages are available after installation:
|
||||
После установки становятся доступны man страницы:
|
||||
|
||||
```bash
|
||||
man dcr
|
||||
man dcr-build
|
||||
```
|
||||
|
||||
Команда создаёт `~/.dcr/` с дефолтным `config.toml` и скачивает публичный реестр.
|
||||
Чтобы использовать реестр, создайте файл `~/.dcr/config.toml`:
|
||||
|
||||
```toml
|
||||
[[registry]]
|
||||
|
||||
@@ -28,24 +28,24 @@ dcr gen clion
|
||||
Генерирует в `.idea/`:
|
||||
|
||||
| Файл | Назначение |
|
||||
| ----------------------------------------- | ----------------------------------------------- |
|
||||
| ----------------------------------------- | ------------------------------------------------ |
|
||||
| `externalTools.xml` | Build, Run, Clean, Test как внешние инструменты |
|
||||
| `customTargets.xml` | Кастомные цели сборки |
|
||||
| `misc.xml` | Настройки C/C++ проекта |
|
||||
| `runConfigurations/dcr_build_and_run.xml` | Per-binary run configurations |
|
||||
| `runConfigurations/dcr_build_and_run.xml` | Конфигурации запуска для каждого бинарного файла |
|
||||
|
||||
## compile_commands.json
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
dcr gen команды компиляции
|
||||
```
|
||||
|
||||
Генерирует `compile_commands.json` в корне проекта. Стандартный формат для:
|
||||
|
||||
## project-info
|
||||
## информация о проекте
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
dcr gen info-проекта
|
||||
```
|
||||
|
||||
Выводит JSON с метаданными проекта (см. [gen-commands](/docs/commands/gen-commands)).
|
||||
|
||||
@@ -14,33 +14,33 @@ DCR распространяется под лицензией [GPL-3.0-or-later
|
||||
|
||||
DCR статически связывает следующие C-библиотеки через вендорные Rust-зависимости:
|
||||
|
||||
| Библиотека | Лицензия | Bundled by |
|
||||
| ------------------------------------------ | ------------------ | ----------------------------- |
|
||||
| [libgit2](https://libgit2.org) | MIT OR Apache-2.0 | `git2` / `libgit2-sys` |
|
||||
| [libssh2](https://libssh2.org) | MIT OR Apache-2.0 | `libgit2-sys` |
|
||||
| [zlib](https://zlib.net) | MIT OR Apache-2.0 | `libgit2-sys` |
|
||||
| Библиотека | Лицензия | В комплекте с |
|
||||
| -------------------------------------------- | ------------------ | ----------------------------- |
|
||||
| [libgit2](https://libgit2.org) | MIT ИЛИ Apache-2.0 | `git2` / `libgit2-sys` |
|
||||
| [libssh2](https://libssh2.org) | MIT ИЛИ Apache-2.0 | `libgit2-sys` |
|
||||
| [zlib](https://zlib.net) | MIT ИЛИ Apache-2.0 | `libgit2-sys` |
|
||||
| [OpenSSL](https://openssl.org) | Apache-2.0 | `openssl-sys` / `openssl-src` |
|
||||
| [ring](https://github.com/briansmith/ring) | Apache-2.0 AND ISC | `rustls` |
|
||||
| [кольцо](https://github.com/briansmith/ring) | Apache-2.0 И ISC | `rustls` |
|
||||
|
||||
## Rust-зависимости
|
||||
|
||||
DCR написан на Rust. Ниже перечислены основные статически связываемые крейты:
|
||||
|
||||
| Крейт | Лицензия |
|
||||
| --------------------------------------------- | ------------------------ |
|
||||
| [`reqwest`](https://crates.io/crates/reqwest) | MIT OR Apache-2.0 |
|
||||
| [`rustls`](https://crates.io/crates/rustls) | Apache-2.0 OR ISC OR MIT |
|
||||
| [`serde`](https://crates.io/crates/serde) | MIT OR Apache-2.0 |
|
||||
| [`toml`](https://crates.io/crates/toml) | MIT OR Apache-2.0 |
|
||||
| [`sha2`](https://crates.io/crates/sha2) | MIT OR Apache-2.0 |
|
||||
| [`git2`](https://crates.io/crates/git2) | MIT OR Apache-2.0 |
|
||||
| --------------------------------------------- | -------------------------- |
|
||||
| [`reqwest`](https://crates.io/crates/reqwest) | MIT ИЛИ Apache-2.0 |
|
||||
| [`rustls`](https://crates.io/crates/rustls) | Apache-2.0 ИЛИ ISC ИЛИ MIT |
|
||||
| [`serde`](https://crates.io/crates/serde) | MIT ИЛИ Apache-2.0 |
|
||||
| [`toml`](https://crates.io/crates/toml) | MIT ИЛИ Apache-2.0 |
|
||||
| [`sha2`](https://crates.io/crates/sha2) | MIT ИЛИ Apache-2.0 |
|
||||
| [`git2`](https://crates.io/crates/git2) | MIT ИЛИ Apache-2.0 |
|
||||
| [`openssl`](https://crates.io/crates/openssl) | Apache-2.0 |
|
||||
| [`tokio`](https://crates.io/crates/tokio) | MIT |
|
||||
| [`hyper`](https://crates.io/crates/hyper) | MIT |
|
||||
| [`ctrlc`](https://crates.io/crates/ctrlc) | MIT OR Apache-2.0 |
|
||||
| [`ctrlc`](https://crates.io/crates/ctrlc) | MIT ИЛИ Apache-2.0 |
|
||||
|
||||
Полное дерево зависимостей (143 пакета) доступно в [`Cargo.lock`](https://github.com/dexoron/dcr/blob/main/Cargo.lock). Подавляющее большинство имеют двойную лицензию MIT OR Apache-2.0.
|
||||
|
||||
## Additional credits
|
||||
## Дополнительные благодарности
|
||||
|
||||
* Дизайн CLI и модель проектов DCR вдохновлены [Cargo](https://doc.rust-lang.org/cargo/).
|
||||
|
||||
@@ -25,29 +25,29 @@ cflags = ["-O3", "-flto"]
|
||||
|
||||
Поля из `[build.\<profile>]` **мержатся поверх** `[build]`
|
||||
|
||||
* **Scalar fields** (strings, numbers, bools) — replaced
|
||||
* **Скалярные поля** (строки, числа, логические значения) — заменены
|
||||
* Массивы (`cflags`, `ldflags`, ...) **заменяются полностью**, а не дополняются
|
||||
|
||||
Set `inherit = false` to disable array inheritance (only profile's own arrays are used).
|
||||
Установите `inherit = false`, чтобы отключить наследование массивов (будут использоваться только собственные массивы профиля).
|
||||
|
||||
## Кастомные профили
|
||||
|
||||
The default flags for each profile are composed from three config fields:
|
||||
Флаги по умолчанию для каждого профиля формируются из трёх полей конфигурации:
|
||||
|
||||
| Field | Default cflags | Профили сборки |
|
||||
| ----------- | ------------------ | -------------- |
|
||||
| Поле | Default cflags | Профили сборки |
|
||||
| ---------------- | ------------------ | -------------- |
|
||||
| `opt_level` | `-O0 -g` | `"3"` |
|
||||
| `debug` | `true` | `false` |
|
||||
| `warnings` | `["all", "extra"]` | `[]` |
|
||||
| `предупреждения` | `["all", "extra"]` | `[]` |
|
||||
|
||||
Which produce the equivalent compiler flags:
|
||||
Которые генерируют соответствующие флаги компилятора:
|
||||
|
||||
| Профиль | Effective flags |
|
||||
| --------- | ---------------------------------------------------------- |
|
||||
| Профиль | Действующие флаги |
|
||||
| ------- | ---------------------------------------------------------- |
|
||||
| `debug` | `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG` |
|
||||
| `release` | `-O3 -DNDEBUG` |
|
||||
| `релиз` | `-O3 -DNDEBUG` |
|
||||
|
||||
Additional build options can be toggled per-profile:
|
||||
Дополнительные параметры сборки можно включать или отключать для каждого профиля:
|
||||
|
||||
```toml
|
||||
[build.release]
|
||||
@@ -73,7 +73,7 @@ cflags = ["-DLINUX"]
|
||||
cflags = ["-DWIN32", "-O0", "-g"]
|
||||
```
|
||||
|
||||
Application order (highest priority first):
|
||||
Порядок применения (в порядке убывания приоритета):
|
||||
|
||||
1. `[build.\<target>.\<profile>]`
|
||||
2. `[build.\<profile>.\<target>]`
|
||||
|
||||
@@ -2,36 +2,36 @@
|
||||
sidebar_label: Система сборки
|
||||
---
|
||||
|
||||
# Build System
|
||||
# Система сборки
|
||||
|
||||
## Compiler Backends
|
||||
## Бэкенды компилятора
|
||||
|
||||
DCR поддерживает 4 бэкенда компиляции. Выбор происходит автоматически на основе расширения файла и target triple.
|
||||
|
||||
| Backend | Файлы | Когда используется |
|
||||
| --------- | --------------------------------------- | ------------------------------- |
|
||||
| Бэкенд | Файлы | Когда используется |
|
||||
| --------- | --------------------------------------- | ------------------------------------- |
|
||||
| `unix_cc` | `.c`, `.cpp`, `.cxx`, `.cc`, `.s`, `.S` | gcc/clang на Linux/macOS/BSD |
|
||||
| `msvc` | `.c`, `.cpp`, `.cxx`, `.cc` | Windows (cl, clang-cl) |
|
||||
| `gas` | `.s`, `.S` | ARM/ARM64 ассемблер |
|
||||
| `газ` | `.s`, `.S` | ARM/ARM64 ассемблер |
|
||||
| `nasm` | `.asm`, `.s` | x86/x86_64 ассемблер |
|
||||
| `masm` | `.asm` | MASM (ml/ml64) on Windows |
|
||||
| `fasm` | `.asm`, `.fasm` | Flat Assembler |
|
||||
| `llvm_ir` | `.ll` | LLVM IR via `llc -filetype=obj` |
|
||||
| `masm` | `.asm` | MASM (ml/ml64) в Windows |
|
||||
| `fasm` | `.asm`, `.fasm` | Сборщик плоских деталей |
|
||||
| `llvm_ir` | `.ll` | LLVM IR с помощью `llc -filetype=obj` |
|
||||
|
||||
## Qt Support
|
||||
## Поддержка Qt
|
||||
|
||||
DCR provides native Qt support for automatic meta-object handling (MOC, UIC, RCC).
|
||||
DCR обеспечивает встроенную поддержку Qt для автоматической обработки метаобъектов (MOC, UIC, RCC).
|
||||
|
||||
Enable it by setting `build.qt = true` in `dcr.toml`. DCR will automatically detect Qt-related files (`.ui`, `.qrc`, `.h` with `Q_OBJECT`) and process them.
|
||||
Чтобы включить эту функцию, установите значение `build.qt = true` в файле `dcr.toml`. DCR автоматически обнаружит файлы, связанные с Qt (`.ui`, `.qrc`, `.h` с `Q_OBJECT`), и обработает их.
|
||||
|
||||
```toml
|
||||
[build]
|
||||
qt = true
|
||||
```
|
||||
|
||||
*Note: Requires `qt6` modules (Core, Widgets, Gui, Svg) installed via `pkg-config`.*
|
||||
*Примечание: Требуется установка модулей `qt6` (Core, Widgets, Gui, Svg) с помощью `pkg-config`.*
|
||||
|
||||
Advanced customization is still possible via `build.steps` if special handling is needed:
|
||||
Если требуется специальная обработка, по-прежнему можно выполнить расширенную настройку с помощью файла `build.steps`:
|
||||
|
||||
```toml
|
||||
[build.steps]
|
||||
@@ -43,10 +43,10 @@ moc = "moc {in} -o {out}"
|
||||
* Компилятор определяется через `resolve_compiler()`: CC/CXX из [toolchain], DCR_COMPILER/env, PATH
|
||||
* Поддерживает генерацию `.d` файлов для header dependency tracking
|
||||
* Флаги: `-std=`, `-MMD -MF`, `-c -o`, `-I`, `-L`, `-l`
|
||||
* Conditional flags based on config:
|
||||
* `freestanding` or bare-metal target: `-ffreestanding` (compile), `-nostdlib -static` (link)
|
||||
* `lto`: `-flto` (compile + link)
|
||||
* `panic = "abort"`: `-fno-exceptions` (C++ only), `-fno-unwind-tables`, `-fno-asynchronous-unwind-tables`
|
||||
* Условные флаги, зависящие от настроек:
|
||||
* `freestanding` или целевая среда «bare-metal»: `-ffreestanding` (компиляция), `-nostdlib -static` (линковка)
|
||||
* `lto`: `-flto` (компиляция + линковка)
|
||||
* `panic = "abort"`: `-fno-exceptions` (только для C++), `-fno-unwind-tables`, `-fno-asynchronous-unwind-tables`
|
||||
|
||||
### MSVC
|
||||
|
||||
@@ -58,10 +58,10 @@ moc = "moc {in} -o {out}"
|
||||
* GAS: `-I`, `-c -o`, `--defsym`
|
||||
* NASM: `-I`, `-c -o`, `-D`, `-f` (формат: win64/elf64/macho64/macho32/elf32)
|
||||
* MASM: `/nologo /c /Fo\<obj> <source>`
|
||||
* FASM: `<source> \<output>` (output path is the object file)
|
||||
* FASM: `<source> \<output>` (путь вывода — объектный файл)
|
||||
* LLVM IR: `-filetype=obj <source> -o \<output>`
|
||||
|
||||
## Incremental Builds
|
||||
## Инкрементные сборки
|
||||
|
||||
Три уровня инкрементальности:
|
||||
|
||||
@@ -69,31 +69,31 @@ moc = "moc {in} -o {out}"
|
||||
2. **`.d` files** — отслеживание изменений в заголовочных файлах (включая транзитивные)
|
||||
3. **SHA256 fingerprint** — если флаги компиляции изменились, файл перекомпилируется (fingerprint хранится в `.dcr_fingerprint`)
|
||||
|
||||
## Parallel Compilation
|
||||
## Параллельная компиляция
|
||||
|
||||
* Используется `thread::scope` для создания пула потоков
|
||||
* Атомарная очередь задач (`AtomicU64`)
|
||||
* Мьютекс на запись в stdout (`OUTPUT_MUTEX`)
|
||||
* Thread count = `available_parallelism()`, capped by `build.codegen-units` if set
|
||||
* Количество потоков = `available_parallelism()`, ограниченное значением `build.codegen-units`, если оно задано
|
||||
|
||||
## Build Kinds
|
||||
## Типы сборок
|
||||
|
||||
| Kind | Тип | Path (Linux example) |
|
||||
| ----------- | ------------------------------------ | ----------------------------------------------------------------------------------------------- |
|
||||
| `bin` | Executable | `target/\<profile>/\<name>` (.exe) |
|
||||
| Тип | Тип | Путь (пример для Linux) |
|
||||
| ------------------ | ------------------------------------ | ----------------------------------------------------------------------------------------------- |
|
||||
| `bin` | Исполняемый файл | `target/\<profile>/\<name>` (.exe) |
|
||||
| `staticlib` | Статическая библиотека | `target/\<profile>/lib\<name>.a` (.lib) |
|
||||
| `sharedlib` | Динамическая библиотека | `target/\<profile>/lib\<name>.so` (.dll/.dylib) |
|
||||
| `efi` | UEFI приложение | `target/\<profile>/\<name>.efi` |
|
||||
| `elf` | ELF без стандартной библиотеки | `target/\<profile>/\<name>` |
|
||||
| `none` | Compile only, no link | — |
|
||||
| `custom` | Полный контроль filename + extension | `target/\<profile>/\<filename>.\<extension>` |
|
||||
| `эльф` | ELF без стандартной библиотеки | `target/\<profile>/\<name>` |
|
||||
| `нет` | Только компиляция, без линковки | — |
|
||||
| `пользовательский` | Полный контроль filename + extension | `target/\<profile>/\<filename>.\<extension>` |
|
||||
|
||||
## Build Steps
|
||||
## Этапы сборки
|
||||
|
||||
DCR поддерживает pre-build и post-build шаги через Qt codegen:
|
||||
|
||||
* `build.steps` — commands before compilation
|
||||
* `build.post_steps` — commands after compilation
|
||||
* `build.steps` — команды, выполняемые перед компиляцией
|
||||
* `build.post_steps` — команды, выполняемые после компиляции
|
||||
|
||||
Подстановки: `{stem}`, `{in}`, `{out}`.
|
||||
|
||||
@@ -106,7 +106,7 @@ moc = "moc {in} -o {out}"
|
||||
|
||||
## pkg-config
|
||||
|
||||
Automatic lookup (read from raw config):
|
||||
Автоматический поиск (чтение из исходного файла конфигурации):
|
||||
|
||||
```toml
|
||||
[build]
|
||||
@@ -115,17 +115,17 @@ pkg_config = ["sdl2", "gl"]
|
||||
|
||||
DCR вызывает `pkg-config --cflags sdl2 gl` и `pkg-config --libs sdl2 gl` и добавляет результат в флаги компиляции/линковки.
|
||||
|
||||
## Variable Substitution
|
||||
## Подстановка переменных
|
||||
|
||||
Supported variables:
|
||||
Поддерживаемые переменные:
|
||||
|
||||
| Variable | Описание |
|
||||
| ----------------------- | ------------------------------- |
|
||||
| Переменная | Описание |
|
||||
| ----------------------- | ----------------------------------------- |
|
||||
| `{version}` | Версия пакета |
|
||||
| `{version_major}` | Major version part |
|
||||
| `{version_minor}` | Minor version part |
|
||||
| `{version_major}` | Часть, обозначающая основную версию |
|
||||
| `{version_minor}` | Часть, обозначающая второстепенную версию |
|
||||
| `{version_patch}` | Переменная |
|
||||
| `{version_suffix}` | Suffix (e.g., `-rc1`) |
|
||||
| `{version_suffix_dash}` | Suffix with dash |
|
||||
| `{version_suffix}` | Суффикс (например, `-rc1`) |
|
||||
| `{version_suffix_dash}` | Суффикс с тире |
|
||||
| `{profile}` | Имя профиля (debug/release/...) |
|
||||
| `{name}` | Имя пакета |
|
||||
|
||||
@@ -4,12 +4,12 @@ sidebar_label: Кросс-компиляция
|
||||
|
||||
# Кросс-компиляция
|
||||
|
||||
## Short Names
|
||||
## Сокращённые названия
|
||||
|
||||
DCR поддерживает короткие имена платформ, которые автоматически раскрываются в полные triples:
|
||||
|
||||
| Short Name | Full Triple |
|
||||
| ---------- | -------------------------- |
|
||||
| Краткое название | Полный тройной |
|
||||
| ---------------- | -------------------------- |
|
||||
| `linux` | `x86_64-unknown-linux-gnu` |
|
||||
| `macos` | `x86_64-apple-darwin` |
|
||||
| `windows` | `x86_64-pc-windows-msvc` |
|
||||
@@ -18,7 +18,7 @@ DCR поддерживает короткие имена платформ, ко
|
||||
dcr build --target windows
|
||||
```
|
||||
|
||||
## Full Triples
|
||||
## Полные тройки
|
||||
|
||||
```bash
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
@@ -39,12 +39,12 @@ target = "aarch64-unknown-linux-gnu"
|
||||
|
||||
## Bare-Metal
|
||||
|
||||
For targets containing `none`, `-elf`, `eabi`, or `baremetal`, DCR automatically:
|
||||
Для целевых платформ, содержащих значения `none`, `-elf`, `eabi` или `baremetal`, DCR автоматически:
|
||||
|
||||
1. Для none/elf/eabi/bare-metal target-ов отключаются DCR default флаги (нет `-I` системных путей, нет `-l` libc).
|
||||
2. **Injects `-ffreestanding`** at compile time and `-nostdlib -static` at link time
|
||||
2. **Вставляет `-ffreestanding`** на этапе компиляции и `-nostdlib -static` на этапе линковки
|
||||
|
||||
You can also enable freestanding mode explicitly:
|
||||
Кроме того, можно явно включить автономный режим:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
@@ -55,15 +55,15 @@ freestanding = true
|
||||
dcr build --target aarch64-none-elf
|
||||
```
|
||||
|
||||
## Target Directory
|
||||
## Целевой каталог
|
||||
|
||||
On Linux with explicit target:
|
||||
В Linux с явным указанием цели:
|
||||
|
||||
```
|
||||
target/<triple>/<profile>/
|
||||
```
|
||||
|
||||
On macOS/Windows or without target:
|
||||
В macOS/Windows или без указания целевой платформы:
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
|
||||
@@ -36,15 +36,15 @@ sidebar_label: Обзор dcr.toml
|
||||
# настройки запуска
|
||||
```
|
||||
|
||||
## [package]
|
||||
## [пакет]
|
||||
|
||||
| Поле | Обязательное | Описание |
|
||||
| --------- | ------------ | --------------------------- |
|
||||
| `name` | да | Имя проекта |
|
||||
| `version` | да | Семантическая версия |
|
||||
| `type` | да | `app`, `lib`, `none` |
|
||||
| `license` | нет | SPDX-идентификатор лицензии |
|
||||
| `author` | нет | Автор |
|
||||
| ---------- | ------------ | --------------------------- |
|
||||
| `имя` | да | Имя проекта |
|
||||
| `версия` | да | Семантическая версия |
|
||||
| `тип` | да | `app`, `lib`, `none` |
|
||||
| `лицензия` | нет | SPDX-идентификатор лицензии |
|
||||
| `автор` | нет | Автор |
|
||||
|
||||
```toml
|
||||
[package]
|
||||
@@ -55,50 +55,50 @@ license = "MIT"
|
||||
author = "John Doe"
|
||||
```
|
||||
|
||||
## [build]
|
||||
## [сборка]
|
||||
|
||||
...
|
||||
|
||||
* `build.qt` — (bool) Enable automatic Qt meta-object handling (MOC, UIC, RCC). Requires `qt6` modules installed via `pkg-config`.
|
||||
* `build.qt` — (bool) Включить автоматическую обработку метаобъектов Qt (MOC, UIC, RCC). Требуется установка модулей `qt6` с помощью `pkg-config`.
|
||||
|
||||
| Поле | По умолчанию | Описание |
|
||||
| ---------------- | ------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `language` | `"c"` | `"c"`, `"cxx"`, `"cpp"` |
|
||||
| `standard` | `"c11"` | Стандарт C (`c11`, `c17`, `c23`) |
|
||||
| ------------------------ | --------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `язык` | `"c"` | `"c"`, `"cxx"`, `"cpp"` |
|
||||
| `стандартный` | `"c11"` | Стандарт C (`c11`, `c17`, `c23`) |
|
||||
| `cxx_standard` | `"c++20"` | Стандарт C++ (`c++17`, `c++20`, `c++23`) |
|
||||
| `compiler` | `cxxflags` | Предпочитаемый компилятор |
|
||||
| `kind` | `"bin"` | `bin`, `staticlib`, `sharedlib`, `efi`, `elf`, `none`, `custom` |
|
||||
| `компилятор` | `cxxflags` | Предпочитаемый компилятор |
|
||||
| `тип` | `"bin"` | `bin`, `staticlib`, `sharedlib`, `efi`, `elf`, `none`, `custom` |
|
||||
| `target` | хост | Target triple для кросс-компиляции |
|
||||
| `platform` | `"native"` | `native`, `efi`, `freestanding` |
|
||||
| `платформа` | `"нативный"` | `native`, `efi`, `freestanding` |
|
||||
| `cflags` | `[]` | Дополнительные флаги C++ |
|
||||
| `ldflags` | `[]` | Дополнительные флаги линковки |
|
||||
| `filename` | `""` | Кастомное имя выходного файла |
|
||||
| `extension` | `""` | Custom file extension |
|
||||
| `roots` | `["src"]` | Корневые директории с исходниками |
|
||||
| `имя файла` | `""` | Кастомное имя выходного файла |
|
||||
| `расширение` | `""` | Пользовательское расширение файла |
|
||||
| `корни` | `["src"]` | Корневые директории с исходниками |
|
||||
| `exclude` | `[]` | Паттерны исключений |
|
||||
| `include` | `[]` | Дополнительные include-директории |
|
||||
| `src_disable` | `false` | Disable auto source discovery |
|
||||
| `inherit` | `false` | Наследовать build от корня workspace |
|
||||
| `clean` | `[]` | Glob patterns for custom clean paths |
|
||||
| `out_dir` | `""` | Custom output directory |
|
||||
| `workspace_only` | `false` | Только для workspace, не собирать отдельно |
|
||||
| `freestanding` | `false` | Compile in freestanding mode (`-ffreestanding` + `-nostdlib -static`) |
|
||||
| `opt_level` | `"0"` (debug) / `"3"` (release) | Optimization level: `0`-`3`, `"s"`, `"z"` |
|
||||
| `ldscript` | `true` (debug) / `false` (release) | Emit debug symbols (`-g`) |
|
||||
| `lto` | `false` | Link-time optimization (`-flto` for both compiler and linker) |
|
||||
| `asflags` | `false` | Strip symbols from output (`-s` in ldflags) |
|
||||
| `true` | `["all", "extra"]` (debug) / `[]` (release) | Warning flags (e.g. `"all"`, `"extra"`, `"pedantic"`) |
|
||||
| `panic` | `""` | Panic strategy: `"abort"` disables exceptions and unwind tables |
|
||||
| `codegen-units` | `""` | Max parallel compilation jobs (`"0"` = auto) |
|
||||
| `qt` | `false` | Enable automatic Qt meta-object handling (MOC, UIC, RCC) |
|
||||
| `src_disable` | `false` | Отключить автоматический поиск источников |
|
||||
| `наследовать` | `false` | Наследовать build от корня workspace |
|
||||
| `clean` | `[]` | Шаблоны Glob для настраиваемых чистых путей |
|
||||
| `out_dir` | `""` | Пользовательский каталог для вывода данных |
|
||||
| `только рабочая область` | `false` | Только для workspace, не собирать отдельно |
|
||||
| `отдельно стоящий` | `false` | Компилировать в автономном режиме (`-ffreestanding` + `-nostdlib -static`) |
|
||||
| `opt_level` | `"0"` (отладочная версия) / `"3"` (релизная версия) | Уровень оптимизации: `0`–`3`, `"s"`, `"z"` |
|
||||
| `ldscript` | `true` (отладочный режим) / `false` (релизный режим) | Выводить отладочные символы (`-g`) |
|
||||
| `lto` | `false` | Оптимизация на этапе компоновки (`-flto` как для компилятора, так и для компоновщика) |
|
||||
| `asflags` | `false` | Удалить символы из вывода (опция `-s` в ldflags) |
|
||||
| `true` | `["all", "extra"]` (отладочная версия) / `[]` (релизная версия) | Флаги предупреждений (например, `"all"`, `"extra"`, `"pedantic"`) |
|
||||
| `panic` | `""` | Стратегия «Паника»: `"abort"` отключает исключения и таблицы развертки |
|
||||
| `codegen-units` | `""` | Максимальное количество параллельных заданий компиляции (`"0"` = автоматически) |
|
||||
| `qt` | `false` | Включить автоматическую обработку метаобъектов Qt (MOC, UIC, RCC) |
|
||||
|
||||
Settings from raw config (not in typed struct):
|
||||
Параметры из исходного файла конфигурации (не в виде типизированной структуры):
|
||||
|
||||
* Пакеты для pkg-config
|
||||
* Путь к linker script
|
||||
* `build.steps` / `build.post_steps` — codegen steps
|
||||
* `build.steps` / `build.post_steps` — этапы генерации кода
|
||||
|
||||
Example:
|
||||
Пример:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
@@ -112,7 +112,7 @@ cflags = ["-Wall", "-Wextra"]
|
||||
pkg_config = ["sdl2", "gl"]
|
||||
```
|
||||
|
||||
## [toolchain]
|
||||
## [набор инструментов]
|
||||
|
||||
```toml
|
||||
[toolchain]
|
||||
@@ -126,16 +126,16 @@ moc = "/usr/bin/moc" # Qt
|
||||
rcc = "/usr/bin/rcc" # Qt
|
||||
```
|
||||
|
||||
Raw config also supports `uic`, `moc`, `rcc` for Qt codegen.
|
||||
Raw config также поддерживает `uic`, `moc` и `rcc` для генерации кода Qt.
|
||||
|
||||
## [dependencies]
|
||||
## [зависимости]
|
||||
|
||||
См. [dependencies](/docs/reference/dependencies).
|
||||
|
||||
## [run]
|
||||
## [запустить]
|
||||
|
||||
```toml
|
||||
[run]
|
||||
[запустить]
|
||||
cmd = "./target/{profile}/{name}"
|
||||
```
|
||||
|
||||
@@ -143,11 +143,11 @@ cmd = "./target/{profile}/{name}"
|
||||
|
||||
* `{version}` — версия из [package]
|
||||
* `pkg_config`
|
||||
* `{profile}` — debug / release
|
||||
* `{profile}` — отладочная / релизная версия
|
||||
* `{name}` — имя из [package]
|
||||
|
||||
По умолчанию `cmd` вычисляется как `./target/{profile}/{name}`.
|
||||
|
||||
## [workspace]
|
||||
## [рабочая область]
|
||||
|
||||
См. [workspaces](/docs/reference/workspaces).
|
||||
|
||||
@@ -8,7 +8,7 @@ sidebar_label: Зависимости
|
||||
|
||||
В секции `[dependencies]` поддерживаются три формата:
|
||||
|
||||
### String (registry)
|
||||
### Строка (реестр)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
@@ -17,7 +17,7 @@ spdlog = "^1.12"
|
||||
catch2 = ">=3.0,<4.0"
|
||||
```
|
||||
|
||||
The version string is used as-is for registry lookup.
|
||||
Строка версии используется без изменений для поиска в реестре.
|
||||
|
||||
### Табличный (git)
|
||||
|
||||
@@ -35,7 +35,7 @@ fmt = { git = "https://github.com/fmtlib/fmt", tag = "10.1.1" }
|
||||
mylib = { path = "../mylib" }
|
||||
```
|
||||
|
||||
## Registry
|
||||
## Реестр
|
||||
|
||||
## RegistryDCR использует реестр пакетов для поиска зависимостей по имени.```toml
|
||||
# ~/.dcr/config.toml
|
||||
@@ -50,7 +50,7 @@ name = "default"
|
||||
url = "https://index.dcr.pm"
|
||||
```
|
||||
|
||||
Registry priority: order in `config.toml`. Переменная `DCR_INDEX_PATH` переопределяет путь к index.json.
|
||||
Приоритет реестра: порядок в файле `config.toml`. Переменная `DCR_INDEX_PATH` переопределяет путь к index.json.
|
||||
|
||||
## Git-зависимости
|
||||
|
||||
@@ -59,9 +59,9 @@ Registry priority: order in `config.toml`. Переменная `DCR_INDEX_PATH`
|
||||
* `branch` — переключиться на ветку
|
||||
* `tag` — переключиться на тег
|
||||
* `rev` — переключиться на конкретный коммит
|
||||
* `features` — feature flags (parsed, but does not affect build)
|
||||
* `features` — флаги функций (проанализированы, но не влияют на сборку)
|
||||
|
||||
Cache path: `~/.dcr/git/\<hash>/`.
|
||||
Путь к кэшу: `~/.dcr/git/\<hash>/`.
|
||||
|
||||
## Path-зависимости
|
||||
|
||||
@@ -77,12 +77,12 @@ mylib = { path = "../relative/path" }
|
||||
|
||||
Файл блокировки зависимостей. Содержит точные версии, хеши и источники.
|
||||
|
||||
Created during `dcr build` when registry dependencies are present. Автоматически обновляется при `dcr add`.
|
||||
Создаётся при выполнении команды `dcr build` при наличии зависимостей реестра. Автоматически обновляется при `dcr add`.
|
||||
|
||||
## Процесс резолва
|
||||
|
||||
1. Загружаются все зависимости (registry → git → path)
|
||||
2. For path deps: recursively read their `dcr.toml`
|
||||
3. For registry deps: search `index.json`
|
||||
4. For git deps: clone to cache
|
||||
2. Для зависимостей типа «path»: рекурсивно прочитать их файлы `dcr.toml`
|
||||
3. Для зависимостей реестра: выполните поиск в файле `index.json`
|
||||
4. Для зависимостей Git: клонировать в кэш
|
||||
5. Собираются include_dirs, lib_dirs, libs для передачи компилятору
|
||||
|
||||
@@ -6,17 +6,17 @@ sidebar_label: Переменные среды
|
||||
|
||||
## DCR_COMPILER
|
||||
|
||||
Переопределяет компилятор для всех языков. **Highest priority.**
|
||||
Переопределяет компилятор для всех языков. **Наивысший приоритет.**
|
||||
|
||||
```bash
|
||||
export DCR_COMPILER=clang
|
||||
dcr build
|
||||
```
|
||||
|
||||
Compiler resolution priority:
|
||||
Приоритет разрешения компилятора:
|
||||
|
||||
1. `DCR_COMPILER` (env)
|
||||
2. `DCR_CC` / `DCR_CXX` / `DCR_AS` (env)
|
||||
1. `DCR_COMPILER` (переменная среды)
|
||||
2. `DCR_CC` / `DCR_CXX` / `DCR_AS` (переменная среды)
|
||||
3. `[toolchain]` (dcr.toml)
|
||||
4. `build.compiler` (dcr.toml)
|
||||
5. `PATH`
|
||||
@@ -33,7 +33,7 @@ export DCR_AS=arm-linux-gnueabihf-as
|
||||
|
||||
## DCR_LD / DCR_AR
|
||||
|
||||
Override linker and archiver.
|
||||
Переопределить линкер и архиватор.
|
||||
|
||||
```bash
|
||||
export DCR_LD=ld.lld
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_label: Поддержка платформ
|
||||
|
||||
# Поддержка платформ
|
||||
|
||||
## Target Triples
|
||||
## Тройные цели
|
||||
|
||||
DCR нормализует target triple через `platform_triple::normalize_triple()`. Если задано имя платформы (short name), оно раскрывается в triple.
|
||||
|
||||
@@ -16,7 +16,7 @@ target/<arch>-unknown-linux-gnu/<profile>/
|
||||
|
||||
Поддержка архитектур: `x86_64`, `aarch64`.
|
||||
|
||||
Artifact type: ELF. Расширения: `.so` для sharedlib, `.a` для staticlib
|
||||
Тип артефакта: ELF. Расширения: `.so` для sharedlib, `.a` для staticlib
|
||||
|
||||
### macOS
|
||||
|
||||
@@ -36,7 +36,7 @@ target/<profile>/
|
||||
|
||||
Поддержка архитектур: `x86_64`, `aarch64`.
|
||||
|
||||
Extensions: `.exe` (bin), `.lib` (staticlib), `.dll` (sharedlib), `.efi` (UEFI).
|
||||
Расширения: `.exe` (бинарный файл), `.lib` (статическая библиотека), `.dll` (общая библиотека), `.efi` (UEFI).
|
||||
|
||||
### BSD
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ sidebar_label: Автоматическое обновление
|
||||
|
||||
## dcr --update
|
||||
|
||||
Автоматическое обновление до последней версии. Downloads a binary (not an archive) from GitHub Releases and replaces the current executable.
|
||||
Автоматическое обновление до последней версии. Загружает бинарный файл (не архив) из раздела «Релизы» на GitHub и заменяет им текущий исполняемый файл.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
@@ -15,16 +15,16 @@ dcr --update
|
||||
## Как это работает
|
||||
|
||||
1. DCR определяет текущую платформу и архитектуру
|
||||
2. Fetches the latest release from `api.github.com/repos/dexoron/dcr/releases/latest`
|
||||
3. Compares versions
|
||||
4. Downloads the matching asset (direct binary URL, not archive)
|
||||
2. Загружает последнюю версию с `api.github.com/repos/dexoron/dcr/releases/latest`
|
||||
3. Сравнивает версии
|
||||
4. Загружает соответствующий ресурс (прямой URL-адрес двоичного файла, а не архива)
|
||||
5. Заменяет текущий исполняемый файл
|
||||
|
||||
## Asset naming
|
||||
## Названия активов
|
||||
|
||||
Шаблон: `dcr-\<triple>.\<ext> `
|
||||
|
||||
| Платформа | Asset name |
|
||||
| Платформа | Название актива |
|
||||
| -------------- | ------------------------------------- |
|
||||
| Linux x86_64 | `dcr-x86_64-unknown-linux-gnu.tar.gz` |
|
||||
| macOS x86_64 | `dcr-x86_64-apple-darwin.tar.gz` |
|
||||
@@ -36,7 +36,7 @@ dcr --update
|
||||
Если DCR установлен через AUR, `--update` выводит предупреждение:
|
||||
|
||||
```
|
||||
Update via package manager: yay/paru -Syu {package_name} or sudo pacman -Syu {package_name}
|
||||
Обновление через менеджер пакетов: yay/paru -Syu {package_name} или sudo pacman -Syu {package_name}
|
||||
```
|
||||
|
||||
## Ошибки
|
||||
|
||||
@@ -4,15 +4,15 @@ sidebar_label: Запуск тестов
|
||||
|
||||
# Запуск тестов
|
||||
|
||||
## Execution
|
||||
## Выполнение
|
||||
|
||||
```bash
|
||||
dcr test
|
||||
Тест DCR
|
||||
```
|
||||
|
||||
Builds the project, then compiles and runs test files from `tests/`.
|
||||
Выполняет сборку проекта, а затем компилирует и запускает тестовые файлы из каталога `tests/`.
|
||||
|
||||
## Profiles
|
||||
## Профили
|
||||
|
||||
```bash
|
||||
dcr test # debug (по умолчанию)
|
||||
@@ -24,12 +24,12 @@ dcr test --debug # явно debug
|
||||
|
||||
```
|
||||
=====================
|
||||
Testsuite summary
|
||||
Сводка результатов набора тестов
|
||||
=====================
|
||||
TOTAL: 5
|
||||
PASS: 3
|
||||
SKIP: 1
|
||||
FAIL: 1
|
||||
ИСПОЛЬЗОВАНО: 5
|
||||
ПРОЙДЕНО: 3
|
||||
ПРОПУЩЕНО: 1
|
||||
НЕ ПРОЙДЕНО: 1
|
||||
=====================
|
||||
```
|
||||
|
||||
@@ -38,7 +38,7 @@ FAIL: 1
|
||||
* 0 — все тесты пройдены (FAIL = 0)
|
||||
* 1 — есть упавшие тесты
|
||||
|
||||
## What gets built
|
||||
## Что строится
|
||||
|
||||
* Все C/C++ файлы из `tests/`
|
||||
* Include path: `tests/` (для `dcr_test.h`)
|
||||
|
||||
@@ -25,12 +25,12 @@ EXPECT(ptr != NULL, "ptr should not be NULL");
|
||||
SKIP("not implemented on Windows yet");
|
||||
```
|
||||
|
||||
### `TEST(name)`
|
||||
### `TEST(имя)`
|
||||
|
||||
Определяет тест.
|
||||
|
||||
```c
|
||||
TEST(addition) {
|
||||
TEST(сложение) {
|
||||
EXPECT(1 + 1 == 2);
|
||||
EXPECT(2 + 2 == 4);
|
||||
}
|
||||
@@ -38,7 +38,7 @@ TEST(addition) {
|
||||
|
||||
### `TEST_CASE(name, ...)`
|
||||
|
||||
Registers a test case.
|
||||
Регистрирует тестовый случай.
|
||||
|
||||
```c
|
||||
TEST_CASE(math, a, b) {
|
||||
@@ -66,4 +66,4 @@ tests/
|
||||
└── ... # дополнительные .c файлы с тестами
|
||||
```
|
||||
|
||||
Only `.c` files are compiled (`.cpp` is not supported).
|
||||
Компилируются только файлы с расширением `.c` (файлы с расширением `.cpp` не поддерживаются).
|
||||
|
||||
Reference in New Issue
Block a user