mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 17:59:42 +00:00
Compare commits
153 Commits
v0.7.4
...
06a2387e5d
| Author | SHA1 | Date | |
|---|---|---|---|
| 06a2387e5d | |||
| 92e5b3ce8f | |||
| 887e3b919c | |||
| 74fda0b894 | |||
| 2bc30de0ab | |||
| 0a32df1d0d | |||
| df476cec1a | |||
| b2036ba46c | |||
| 154e6d27d0 | |||
| 6000a27708 | |||
| de0007d16c | |||
| 2ac38e6cce | |||
| 952b0488db | |||
| 085c14e5a9 | |||
| fe6191265c | |||
| 4bcf793a39 | |||
| 87585f3524 | |||
| bc322577f9 | |||
| 53e0ad953a | |||
| bc2c2a48f6 | |||
| df3a45dd7a | |||
| 6c7a7ad03e | |||
| 377b244db4 | |||
| d6d08fac57 | |||
| a566e33051 | |||
| 255663822b | |||
| f3952c1c0d | |||
| 13b5616069 | |||
| 6ed40d0aad | |||
| 7d07863c86 | |||
| 47592c952d | |||
| 9873a8d513 | |||
| c41b3e7970 | |||
| 37f1887011 | |||
| c03fd37c14 | |||
| 1f5b8cdcee | |||
| 2f2c4aa208 | |||
| 87bad94848 | |||
| 39bba3cea8 | |||
| d498e67782 | |||
| 82de72ce8d | |||
| ffaf1f1dd1 | |||
| c050ffb8c4 | |||
| e9908f359d | |||
| 024bbfcaa9 | |||
| 4b8d78dac7 | |||
| 50a2c59fed | |||
| 184c44902c | |||
| 44cb4f3665 | |||
| 98fc25c40d | |||
| fc968d07bd | |||
| ba20bf7d3d | |||
| 787e89f779 | |||
| a67729a673 | |||
| 25cc7b8f3b | |||
| bddbc3603a | |||
| 666794d33d | |||
| e35f5e0ad1 | |||
| 4ce4632a92 | |||
| aaa6c99795 | |||
| fe6ac220e6 | |||
| 6622353ff8 | |||
| b3f14d1e68 | |||
| 4cb8985bfb | |||
| 95bb204884 | |||
| bebda1fe8a | |||
| f0e587b12b | |||
| 476f13676a | |||
| fcf21b2b2e | |||
| cb519cc4fd | |||
| 32911212e8 | |||
| 3f506e79af | |||
| fc657b8a99 | |||
| 462c53d93f | |||
| c9ff114b25 | |||
| 746a26bae9 | |||
| b6b171b2a9 | |||
| a1ccaebfd3 | |||
| a15470e669 | |||
| 901ea9ebaa | |||
| 75cf0af9b4 | |||
| 54f5f78e2c | |||
| bb27b4e2e6 | |||
| 9d9422b45b | |||
| b37aa2a380 | |||
| af96ba2ac2 | |||
| 2d73d07923 | |||
| d193dc1314 | |||
| 8ddf4c3fb9 | |||
| f7c0a50e0e | |||
| f4748173f9 | |||
| 1ed2cd9a71 | |||
| d77fcf6b29 | |||
| 458cda2da2 | |||
| af9b67edec | |||
| 72654896c0 | |||
| 82a2b38132 | |||
| c936c03fbf | |||
| 0fecd4c2b7 | |||
| 1e6a1ae9c1 | |||
| 813354c5da | |||
| a02f302c48 | |||
| a1d2d41fb0 | |||
| c11c1a83df | |||
| 98db98d353 | |||
| 6c326c21d4 | |||
| 2e895619bf | |||
| 03146c2857 | |||
| 6c1e041037 | |||
| fc545c6af9 | |||
| 4e2688d66f | |||
| 1eca47feb5 | |||
| 12f4177a91 | |||
| 84eb7c0c52 | |||
| ce643077b3 | |||
| bc71ee7202 | |||
| 42312e10bb | |||
| 7e54cb7155 | |||
| 4c40e74dbb | |||
| 8aa350629c | |||
| 49d63a1ea1 | |||
| f87112faf0 | |||
| ab0ad58925 | |||
| f5b465446c | |||
| f4124ea268 | |||
| d10358bdab | |||
| fd5150f3db | |||
| 82e10cc75d | |||
| b7c9edb35e | |||
| 04fcedc428 | |||
| 548808a8d8 | |||
| dcb8e676f1 | |||
| 1b0ee1402a | |||
| 6c6fa8d5d4 | |||
| c2c3a7bd7a | |||
| 23149d8149 | |||
| 801a164da9 | |||
| e3ec2c198d | |||
| 312af43702 | |||
| 3ca1db4f7c | |||
| 0af619907a | |||
| e257afde70 | |||
| cd3ef3a7f5 | |||
| 966018c1e0 | |||
| 180f927e85 | |||
| 7ba9d296a1 | |||
| 93a894e66a | |||
| c7dd8fecaa | |||
| a3f8444c20 | |||
| 1f3fc62cb6 | |||
| f8d8c95912 | |||
| 9e07f70c78 | |||
| 0376eded3f |
14
.github/workflows/trigger-site-build.yml
vendored
Normal file
14
.github/workflows/trigger-site-build.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
name: Trigger site rebuild
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
paths:
|
||||
- 'docs/**'
|
||||
|
||||
jobs:
|
||||
trigger:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Trigger Cloudflare Pages build
|
||||
run: curl -sS -X POST "${{ secrets.CF_PAGES_DEPLOY_HOOK }}"
|
||||
3
crowdin.yml
Normal file
3
crowdin.yml
Normal file
@@ -0,0 +1,3 @@
|
||||
files:
|
||||
- source: /docs/**/*.mdx
|
||||
translation: /docs-crowdin-export/%locale%/%original_path%/%original_file_name%.%file_extension%
|
||||
63
docs-crowdin-export/de-DE/docs/README.mdx.mdx
Normal file
63
docs-crowdin-export/de-DE/docs/README.mdx.mdx
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_label: Introduction
|
||||
---
|
||||
|
||||
# DCR — C/C++ Build Tool & Package Manager
|
||||
|
||||
<details>
|
||||
<summary>Quick reference</summary>
|
||||
|
||||
```bash
|
||||
# Installation
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
|
||||
# Create a project
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
|
||||
# Build and run
|
||||
dcr build
|
||||
dcr run
|
||||
|
||||
# Run tests
|
||||
dcr test
|
||||
|
||||
# Add a dependency
|
||||
dcr add fmt
|
||||
|
||||
# Generate IDE files
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Contents
|
||||
|
||||
| Section | Description |
|
||||
| ----------------------------------------------------- | --------------------------------------------- |
|
||||
| [Getting Started](/docs/getting-started/installation) | Installation and first steps |
|
||||
| [Commands](/docs/commands/project-commands) | All CLI commands |
|
||||
| [Reference](/docs/reference/dcr-toml) | Configuration, build, dependencies, platforms |
|
||||
| [Testing](/docs/testing/test-framework) | Built-in test framework |
|
||||
| [Recipes](/docs/recipes/cross-to-windows) | Common scenarios |
|
||||
| [IDE Integration](/docs/ide-integration) | VS Code, CLion, compile_commands.json |
|
||||
| [Self Update](/docs/self-update) | Auto-update |
|
||||
| [FAQ](/docs/faq) | Frequently asked questions |
|
||||
| [Changelog](/docs/changelog) | Version history |
|
||||
| [License](/docs/license) | DCR and vendored library licenses |
|
||||
| [Contributing](/docs/contributing) | DCR development |
|
||||
|
||||
## Features
|
||||
|
||||
* **Incremental builds** — mtime + `.d` headers + SHA256 fingerprint
|
||||
* **Parallel compilation** — thread::scope, atomic task queue
|
||||
* **4 backends** — gcc/clang, MSVC/clang-cl, GAS (ARM), NASM (x86)
|
||||
* **7 project kinds** — bin, staticlib, sharedlib, efi, elf, none, custom
|
||||
* **Cross-compilation** — short names and full triples
|
||||
* **Profiles** — debug / release with field overrides
|
||||
* **Workspaces** — multi-package projects with topological sort
|
||||
* **Registry + Git + Path** — three dependency mechanisms
|
||||
* **IDE generation** — VS Code, CLion, compile_commands.json, JSON metadata
|
||||
* **pkg-config** — automatic system library discovery
|
||||
* **Per-command `--help`** — `dcr build --help`, `dcr new --help`, etc.
|
||||
* **Man pages** — `man dcr`, `man dcr-build`, `man dcr-new`
|
||||
91
docs-crowdin-export/de-DE/docs/changelog.mdx.mdx
Normal file
91
docs-crowdin-export/de-DE/docs/changelog.mdx.mdx
Normal file
@@ -0,0 +1,91 @@
|
||||
---
|
||||
sidebar_label: Changelog
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
## 0.7.1 (2026-06-02)
|
||||
|
||||
### Added
|
||||
|
||||
* **`--help` for all commands** — `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-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,
|
||||
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.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`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.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **`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.
|
||||
|
||||
## 0.7.0 (2026-06-01)
|
||||
|
||||
### Added
|
||||
|
||||
* **OpenBSD and NetBSD target support** — full platform routing with dynamic target triples using `std::env::consts::ARCH` and `std::env::consts::OS`. Affects `build`, `run`, `clean` commands and the platform module.
|
||||
* **`src/platform/bsd.rs`** — new BSD platform module (shared by FreeBSD, OpenBSD, NetBSD) providing `bin_path`, `lib_path`, `elf_path`, `efi_path`, `shared_lib_path`.
|
||||
* **`build.out_dir` config option** — custom output directory that overrides the default `target/\<triple>/\<profile>` path for final artifacts. Supported in `build`, `run`, and config validation.
|
||||
* **`dcr fmt` command** — new CLI command that formats all C/C++ source files (`*.c`, `*.cpp`, `*.h`, `*.hpp`) in `src/` and `tests/` using `clang-format`.
|
||||
* **Incremental linking** — `needs_link()` in `common.rs` checks if any object file is newer than the linked output, skipping unnecessary relinking. Implemented for all backends (`unix_cc`, `msvc`, `gas`, `nasm`).
|
||||
* **`build.kind = "none"` and `"custom"`** — two new project kinds for special build scenarios that don't produce standard artifacts.
|
||||
* **`install_bsd.sh`** — POSIX-compliant installation script for BSD systems (FreeBSD, OpenBSD, NetBSD) with binary download and source build modes.
|
||||
* **Linux ARM64 support in `install.sh`** — added `Linux:aarch64|Linux:arm64` target detection for pre-built binary downloads.
|
||||
* **BSD OS detection in `install.sh`** — detects FreeBSD, OpenBSD, NetBSD and determines target triple.
|
||||
* **`rust-toolchain.toml`** — explicit toolchain pinning to `stable` channel.
|
||||
* **Integration tests** — `build_with_target_config` (verifies `build.target = "linux"`) and `build_with_out_dir` (validates custom output directory).
|
||||
* **`get_build_string_with_profile` made `pub`** — so `run.rs` can determine custom output directory configuration.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`build.target` semantics changed** — now strictly contains a target triple (e.g., `x86_64-unknown-linux-gnu`) or short name (`linux`, `macos`, `windows`). No longer used as custom output directory — this functionality moved to `build.out_dir`.
|
||||
* **`build.standard` made optional** — changed from `String` to `Option\<String>`. Validation only enforces non-empty for non-ASM languages. Skipped in `dcr.toml` output if empty.
|
||||
* **`dcr run` with `out_dir`** — now determines target directory respecting `build.out_dir` via `get_build_string_with_profile()` from `build.rs`.
|
||||
* **`collect_sources()` returns empty vector** instead of error when no sources are found, allowing `kind = "none"` or `kind = "custom"` projects with no source files.
|
||||
* **CI/CD release workflow refactored** — `git2` made target-specific (no vendored-openssl on Windows), Zig-based cross-compilation for non-x86_64 Linux targets, Arch Linux package version cleanup (dashes → dots), `gmake` symlink for NetBSD.
|
||||
* **README compatibility table** — FreeBSD, OpenBSD, NetBSD build/run status upgraded from "community/best-effort" to "officially supported".
|
||||
* **Documentation updated** — `build-section.md` describes new `build.target` and `build.out_dir` fields. `target-directory.md` rewritten to clarify the distinction.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **stdout/stderr not inherited in `dcr run`** — child process output was captured and manually printed, breaking interactive programs. Fixed by switching to `Command::status()`.
|
||||
* **Race condition in release CI** — matrix build jobs could upload assets to a release that didn't exist yet. Fixed by adding a dedicated `create-release` job.
|
||||
* **Release GHA — stable toolchain override** — fixed Rust toolchain override issues in CI.
|
||||
* **Arch Linux package version sanitization** — version strings with dashes (e.g., `0.7.0-dev`) are invalid for `pkgver`. Fixed by replacing dashes with dots.
|
||||
* **GPG permissions after Docker** — Docker operations changed GPG directory ownership. Fixed by running `chown` after Docker commands.
|
||||
* **RPM artifact paths** — RPM artifacts were placed in `rpm/x86_64/` instead of `fedora/x86_64/`. Fixed in Dexoron Packages Index workflow.
|
||||
* **JSON parsing reliability in `install.sh`** — added `jq` as primary parser with `python3` fallback for dev channel release lookup.
|
||||
|
||||
### Removed
|
||||
|
||||
* **`format_roots()` helper function** — removed from `common.rs`. Was only used by the old error handling path in `collect_sources()`.
|
||||
* **Per-distribution artifact download steps** — three separate `actions/download-artifact` steps replaced with unified `gh release download --clobber`.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
sidebar_label: Build commands (build, run, clean)
|
||||
---
|
||||
|
||||
# Build Commands
|
||||
|
||||
## `dcr build`
|
||||
|
||||
Builds the project according to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr build # debug profile
|
||||
dcr build --release # release build
|
||||
dcr build --debug # explicit debug
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
dcr build --force # full rebuild
|
||||
dcr build --clean # clean + build
|
||||
dcr build --verbose # show compilation commands
|
||||
dcr build --workspace pkg-a # build specific workspace package
|
||||
```
|
||||
|
||||
Artifacts: `target/\<triple>/\<profile>/\<binary-name>` (Linux with explicit target).
|
||||
|
||||
## `dcr run`
|
||||
|
||||
Builds (if sources are newer than artifacts) and runs the binary.
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
dcr run --release
|
||||
```
|
||||
|
||||
## `dcr clean`
|
||||
|
||||
Removes `target/` directory (or `target/\<target>/\<profile>`).
|
||||
|
||||
```bash
|
||||
dcr clean
|
||||
dcr clean --release # target/release/ only
|
||||
dcr clean --target windows # target/x86_64-pc-windows-msvc/
|
||||
dcr clean --all # clean all workspace packages
|
||||
```
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_label: Dependency commands (add, tree)
|
||||
---
|
||||
|
||||
# Dependency Commands
|
||||
|
||||
## `dcr add \<name> [source]`
|
||||
|
||||
Adds a dependency to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr add fmt # registry lookup
|
||||
dcr add mylib ../path/to/lib # path as source
|
||||
dcr add mylib path:./lib # explicit path prefix
|
||||
dcr add mylib git:https://github.com/user/repo # explicit git prefix
|
||||
dcr add mylib github:user/repo # GitHub shorthand
|
||||
dcr add mylib gitlab:user/repo # GitLab shorthand
|
||||
```
|
||||
|
||||
Source prefixes:
|
||||
|
||||
* `path:` — local path
|
||||
* `git:` — generic git URL
|
||||
* `github:` — expands to `https://github.com/\<user>/\<repo>`
|
||||
* `gitlab:` — expands to `https://gitlab.com/\<user>/\<repo>`
|
||||
* `http://` / `https://` / `git@` — full URL
|
||||
|
||||
Flags:
|
||||
|
||||
* `--branch \<name>` — git branch
|
||||
* `--tag \<name>` — git tag
|
||||
* `--rev \<hash>` — git commit
|
||||
|
||||
If source is omitted — DCR searches connected registries.
|
||||
|
||||
## `dcr tree`
|
||||
|
||||
Displays the project dependency tree.
|
||||
|
||||
```bash
|
||||
dcr tree
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```
|
||||
my-app v0.1.0
|
||||
├── fmt (registry)
|
||||
│ └── spdlog (registry)
|
||||
└── catch2 (registry)
|
||||
```
|
||||
|
||||
For path dependencies, recursively shows their own dependencies (from their `dcr.toml`).
|
||||
73
docs-crowdin-export/de-DE/docs/commands/gen-commands.mdx.mdx
Normal file
73
docs-crowdin-export/de-DE/docs/commands/gen-commands.mdx.mdx
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
sidebar_label: Gen commands (vscode, clion, ...)
|
||||
---
|
||||
|
||||
# Gen Commands
|
||||
|
||||
## `dcr gen \<target>`
|
||||
|
||||
Generates IDE integration files.
|
||||
|
||||
### vscode
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.vscode/tasks.json` — `build` task (dcr build)
|
||||
* `.vscode/launch.json` — debug launch configuration
|
||||
* `.vscode/settings.json` — C/C++ settings (clangd paths, includes)
|
||||
* `.vscode/extensions.json` — recommended extensions (vscode-clangd, vscode-lldb)
|
||||
|
||||
### clion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.idea/externalTools.xml` — external tools (build, run, clean, test)
|
||||
* `.idea/customTargets.xml` — custom build targets
|
||||
* `.idea/misc.xml` — C/C++ project settings
|
||||
* `.idea/runConfigurations/\<name>.xml` — per-binary run configurations
|
||||
|
||||
### compile-commands
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` — standard format for clangd, cpptools, static analyzers.
|
||||
|
||||
### project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"name": "my-app",
|
||||
"version": "0.1.0",
|
||||
"root": "/path/to/project",
|
||||
"profile": "debug",
|
||||
"language": "c",
|
||||
"standard": "c17",
|
||||
"cxx_standard": null,
|
||||
"compiler": "/usr/bin/clang",
|
||||
"kind": "bin",
|
||||
"sources": ["src/main.c"],
|
||||
"include_dirs": ["src"],
|
||||
"lib_dirs": [],
|
||||
"libs": [],
|
||||
"cflags": ["-std=c17", "-O0", "-g"],
|
||||
"ldflags": []
|
||||
}
|
||||
]
|
||||
```
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
sidebar_label: Project commands (new, init)
|
||||
---
|
||||
|
||||
# Project Commands
|
||||
|
||||
## `dcr new \<name>`
|
||||
|
||||
Creates a new project with a standard structure and `dcr.toml`. The `name` argument is required.
|
||||
|
||||
Only ASCII letters, digits, underscores `_` and hyphens `-` are allowed in the project name.
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
dcr new my-app --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
Generates:
|
||||
|
||||
* `dcr.toml` with basic fields
|
||||
* `src/main.c` with a `main` template
|
||||
|
||||
## `dcr init`
|
||||
|
||||
Initializes a DCR project in the current (empty) directory.
|
||||
|
||||
```bash
|
||||
dcr init
|
||||
dcr init --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
The project name is taken from the current directory name. The directory name must follow the same naming rules as `dcr new`.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_label: Quality commands (test, fmt)
|
||||
---
|
||||
|
||||
# Quality Commands
|
||||
|
||||
## `dcr test`
|
||||
|
||||
Runs tests.
|
||||
|
||||
```bash
|
||||
dcr test # debug profile
|
||||
dcr test --release # release profile
|
||||
dcr test --debug # explicit debug
|
||||
dcr test --help # detailed help
|
||||
```
|
||||
|
||||
Before first use, initialize tests:
|
||||
|
||||
```bash
|
||||
dcr test --init
|
||||
```
|
||||
|
||||
This creates `tests/dcr_test.h` (framework) and `tests/test.c` (template).
|
||||
|
||||
What `dcr test` does:
|
||||
|
||||
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
|
||||
6. Returns non-zero exit code on any FAIL
|
||||
|
||||
## `dcr fmt`
|
||||
|
||||
Formats C/C++ source files using `clang-format`.
|
||||
|
||||
```bash
|
||||
dcr fmt
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}` and `tests/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}`.
|
||||
|
||||
Uses `.clang-format` at the project root (if present), otherwise default clang-format style.
|
||||
|
||||
## `dcr lint`
|
||||
|
||||
Runs `clang-tidy` on C/C++ source files for static analysis.
|
||||
|
||||
```bash
|
||||
dcr lint # show diagnostics
|
||||
dcr lint --fix # apply fixes automatically
|
||||
dcr lint --help # detailed help
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc}` and `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.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: System commands (setup, --help, ...)
|
||||
---
|
||||
|
||||
# System Commands
|
||||
|
||||
## `dcr setup`
|
||||
|
||||
Shows configured registries from `~/.dcr/config.toml`.
|
||||
|
||||
```bash
|
||||
dcr setup
|
||||
```
|
||||
|
||||
If `~/.dcr/config.toml` is not found, DCR returns an error. Create it manually:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
## `dcr --help`
|
||||
|
||||
Shows help for all commands.
|
||||
|
||||
```bash
|
||||
dcr --help
|
||||
```
|
||||
|
||||
## `dcr --version`
|
||||
|
||||
Shows version and target triple.
|
||||
|
||||
```bash
|
||||
dcr --version # dcr 0.7.0 (x86_64-unknown-linux-gnu)
|
||||
```
|
||||
|
||||
## `dcr --update`
|
||||
|
||||
Self-update. Downloads the latest release binary from GitHub Releases and replaces the current one.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
Features:
|
||||
|
||||
* Auto-detects platform and architecture
|
||||
* Warns if installed via AUR (use package manager instead)
|
||||
* Works on Linux, macOS, Windows
|
||||
51
docs-crowdin-export/de-DE/docs/contributing.mdx.mdx
Normal file
51
docs-crowdin-export/de-DE/docs/contributing.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: Contributing
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dexoron/dcr
|
||||
cd dcr
|
||||
cargo build
|
||||
```
|
||||
|
||||
## Code style
|
||||
|
||||
All code must be formatted with `cargo fmt`:
|
||||
|
||||
```bash
|
||||
cargo fmt
|
||||
```
|
||||
|
||||
## Linting
|
||||
|
||||
```bash
|
||||
cargo clippy --all-targets -- -D warnings
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
cargo test --all-targets
|
||||
```
|
||||
|
||||
## PR process
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a branch: `git checkout -b feature/description`
|
||||
3. Make changes
|
||||
4. Run `cargo fmt && cargo clippy && cargo test`
|
||||
5. Open a Pull Request
|
||||
|
||||
## CI
|
||||
|
||||
CI runs:
|
||||
|
||||
* `cargo fmt --check`
|
||||
* `cargo clippy --all-targets -- -D warnings`
|
||||
* `cargo test --all-targets`
|
||||
* Build on Linux, macOS, Windows
|
||||
* Integration tests
|
||||
81
docs-crowdin-export/de-DE/docs/faq.mdx.mdx
Normal file
81
docs-crowdin-export/de-DE/docs/faq.mdx.mdx
Normal file
@@ -0,0 +1,81 @@
|
||||
---
|
||||
sidebar_label: FAQ
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
## Registry not found
|
||||
|
||||
```
|
||||
error: registry not found
|
||||
```
|
||||
|
||||
**Solution:** Make sure `~/.dcr/config.toml` exists:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
And check `DCR_INDEX_PATH`:
|
||||
|
||||
```bash
|
||||
echo $DCR_INDEX_PATH
|
||||
```
|
||||
|
||||
## Compiler not found
|
||||
|
||||
```
|
||||
error: compiler not found
|
||||
```
|
||||
|
||||
**Solution:** Ensure a compiler is installed and available in PATH.
|
||||
|
||||
```bash
|
||||
which gcc
|
||||
which clang
|
||||
```
|
||||
|
||||
Or specify explicitly via `[toolchain]` in `dcr.toml`.
|
||||
|
||||
## openssl-sys build failed
|
||||
|
||||
When building DCR from source:
|
||||
|
||||
```
|
||||
error: failed to run custom build command for openssl-sys
|
||||
```
|
||||
|
||||
**Solution:** Install OpenSSL development headers:
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt install libssl-dev
|
||||
|
||||
# Fedora
|
||||
sudo dnf install openssl-devel
|
||||
|
||||
# macOS
|
||||
brew install openssl
|
||||
```
|
||||
|
||||
## Ctrl+C during build
|
||||
|
||||
DCR handles SIGINT: interrupts the current compilation and exits with non-zero code.
|
||||
|
||||
## How to create a library?
|
||||
|
||||
See [Library Recipe](/docs/recipes/library-project).
|
||||
|
||||
## How to cross-compile to Windows?
|
||||
|
||||
See [Cross-Compile Recipe](/docs/recipes/cross-to-windows).
|
||||
|
||||
## How to create a multi-package project?
|
||||
|
||||
See [Workspace Recipe](/docs/recipes/multi-package-workspace).
|
||||
|
||||
## Lock file
|
||||
|
||||
`dcr.lock` is created during builds (`dcr build`) when registry dependencies are present. To force an update — delete `dcr.lock` and run `dcr build`.
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
sidebar_label: First steps
|
||||
---
|
||||
|
||||
# First Steps
|
||||
|
||||
## Create a project
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
```
|
||||
|
||||
Structure:
|
||||
|
||||
```
|
||||
my-app/
|
||||
├── dcr.toml
|
||||
└── src/
|
||||
└── main.c
|
||||
```
|
||||
|
||||
`dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build
|
||||
```
|
||||
|
||||
Output — `target/\<triple>/debug/my-app` (Linux) or `target/debug/my-app.exe` (Windows).
|
||||
|
||||
Build profiles:
|
||||
|
||||
```bash
|
||||
dcr build --release # release build
|
||||
dcr build --debug # debug (default)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
```
|
||||
|
||||
Builds (if needed) and runs the binary.
|
||||
|
||||
## First test
|
||||
|
||||
```bash
|
||||
dcr test --init # create test template
|
||||
dcr test # run tests
|
||||
```
|
||||
|
||||
## Formatting
|
||||
|
||||
```bash
|
||||
dcr fmt # clang-format with .clang-format
|
||||
```
|
||||
@@ -0,0 +1,109 @@
|
||||
---
|
||||
sidebar_label: Installation
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
## Linux (Dexoron Packages)
|
||||
|
||||
Configure your package manager at https://pkg.dexoron.su and install:
|
||||
|
||||
**Arch Linux**
|
||||
|
||||
```sh
|
||||
sudo pacman -Sy dcr
|
||||
```
|
||||
|
||||
**Debian/Ubuntu**
|
||||
|
||||
```sh
|
||||
sudo apt update && sudo apt install dcr
|
||||
```
|
||||
|
||||
**Fedora/RHEL**
|
||||
|
||||
```sh
|
||||
sudo dnf install dcr
|
||||
```
|
||||
|
||||
## Arch Linux (AUR)
|
||||
|
||||
```sh
|
||||
yay -S dcr
|
||||
```
|
||||
|
||||
## macOS / Linux (Homebrew)
|
||||
|
||||
```sh
|
||||
brew tap dexoron/dexoron
|
||||
brew install dcr
|
||||
```
|
||||
|
||||
## Snap (Linux)
|
||||
|
||||
```sh
|
||||
sudo snap install dcrup
|
||||
```
|
||||
|
||||
## Nix (flake)
|
||||
|
||||
```sh
|
||||
nix run github:dexoron/dcr
|
||||
# or install to profile:
|
||||
nix profile install github:dexoron/dcr
|
||||
```
|
||||
|
||||
## Cargo (crates.io)
|
||||
|
||||
```sh
|
||||
cargo install dcr
|
||||
```
|
||||
|
||||
## Linux / macOS (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
```
|
||||
|
||||
## BSD (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install_bsd.sh | sh
|
||||
```
|
||||
|
||||
## Windows (PowerShell)
|
||||
|
||||
```powershell
|
||||
irm https://dcr.dexoron.su/install.ps1 | iex
|
||||
```
|
||||
|
||||
## From source
|
||||
|
||||
```sh
|
||||
git clone https://github.com/dexoron/dcr.git
|
||||
cd dcr && cargo build --release
|
||||
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
||||
```
|
||||
|
||||
## Post-install
|
||||
|
||||
Verify the installation:
|
||||
|
||||
```bash
|
||||
dcr --version
|
||||
```
|
||||
|
||||
Man pages are available after installation:
|
||||
|
||||
```bash
|
||||
man dcr
|
||||
man dcr-build
|
||||
```
|
||||
|
||||
To use the registry, create `~/.dcr/config.toml`:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
51
docs-crowdin-export/de-DE/docs/ide-integration.mdx.mdx
Normal file
51
docs-crowdin-export/de-DE/docs/ide-integration.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: IDE Integration
|
||||
---
|
||||
|
||||
# IDE Integration
|
||||
|
||||
## VS Code
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Generates in `.vscode/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ----------------- | -------------------------------------------- |
|
||||
| `tasks.json` | `build` task (dcr build) |
|
||||
| `launch.json` | Debug launch configuration |
|
||||
| `settings.json` | clangd/IntelliSense: include paths, standard |
|
||||
| `extensions.json` | Recommends vscode-clangd, vscode-lldb |
|
||||
|
||||
## CLion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Generates in `.idea/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ------------------------------------------------ | ----------------------------------------- |
|
||||
| `externalTools.xml` | Build, Run, Clean, Test as external tools |
|
||||
| `customTargets.xml` | Custom build targets |
|
||||
| `misc.xml` | C/C++ project settings |
|
||||
| `runConfigurations/\<name>.xml` | Per-binary run configurations |
|
||||
|
||||
## compile_commands.json
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` at project root. Standard format for clangd, C/C++ IntelliSense, static analyzers.
|
||||
|
||||
## project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata (see [gen-commands](/docs/commands/gen-commands)).
|
||||
33
docs-crowdin-export/de-DE/docs/license.mdx.mdx
Normal file
33
docs-crowdin-export/de-DE/docs/license.mdx.mdx
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
sidebar_label: License
|
||||
---
|
||||
|
||||
# License
|
||||
|
||||
## DCR
|
||||
|
||||
DCR itself is [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) licensed.
|
||||
|
||||
> **Note:** DCR is a build tool, not a library. The GPL applies only to DCR's own source code. Projects built with DCR are not subject to DCR's license — their licensing is determined solely by their own code and dependencies.
|
||||
|
||||
## Rust dependencies
|
||||
|
||||
DCR is written in Rust. The following notable Rust crates are statically linked:
|
||||
|
||||
| Crate | License |
|
||||
| ------------------------------------------------------- | ----------------- |
|
||||
| [`ureq`](https://crates.io/crates/ureq) | MIT OR Apache-2.0 |
|
||||
| [`serde`](https://crates.io/crates/serde) | MIT OR Apache-2.0 |
|
||||
| [`toml`](https://crates.io/crates/toml) | MIT OR Apache-2.0 |
|
||||
| [`toml_edit`](https://crates.io/crates/toml_edit) | MIT OR Apache-2.0 |
|
||||
| [`serde_json`](https://crates.io/crates/serde_json) | MIT OR Apache-2.0 |
|
||||
| [`sha2`](https://crates.io/crates/sha2) | MIT OR Apache-2.0 |
|
||||
| [`glob`](https://crates.io/crates/glob) | MIT OR Apache-2.0 |
|
||||
| [`self-replace`](https://crates.io/crates/self-replace) | MIT OR Apache-2.0 |
|
||||
| [`ctrlc`](https://crates.io/crates/ctrlc) | MIT OR Apache-2.0 |
|
||||
|
||||
Full dependency tree is available in [`Cargo.lock`](https://github.com/dexoron/dcr/blob/main/Cargo.lock). The overwhelming majority are dual-licensed under MIT OR Apache-2.0.
|
||||
|
||||
## Additional credits
|
||||
|
||||
* DCR's CLI design and project model are inspired by [Cargo](https://doc.rust-lang.org/cargo/).
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_label: Cross-compile to Windows
|
||||
---
|
||||
|
||||
# Cross-Compile to Windows from Linux
|
||||
|
||||
Building a Windows binary on Linux using mingw-w64.
|
||||
|
||||
## Install toolchain
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt install mingw-w64
|
||||
|
||||
# Fedora
|
||||
sudo dnf install mingw64-gcc mingw64-binutils
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
target = "x86_64-pc-windows-gnu" # explicit mingw, not msvc
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build --target x86_64-pc-windows-gnu --release
|
||||
```
|
||||
|
||||
Artifact: `target/x86_64-pc-windows-gnu/release/my-app.exe`.
|
||||
|
||||
## Custom toolchain
|
||||
|
||||
```toml
|
||||
[toolchain]
|
||||
cc = "x86_64-w64-mingw32-gcc"
|
||||
cxx = "x86_64-w64-mingw32-g++"
|
||||
```
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_label: Library project
|
||||
---
|
||||
|
||||
# Library Project
|
||||
|
||||
Creating a static library and using it in another project.
|
||||
|
||||
## Step 1: Create the library
|
||||
|
||||
```bash
|
||||
dcr new my-lib
|
||||
cd my-lib
|
||||
```
|
||||
|
||||
`dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-lib"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`src/my_lib.h`:
|
||||
|
||||
```c
|
||||
#ifndef MY_LIB_H
|
||||
#define MY_LIB_H
|
||||
int add(int a, int b);
|
||||
#endif
|
||||
```
|
||||
|
||||
`src/my_lib.c`:
|
||||
|
||||
```c
|
||||
#include "my_lib.h"
|
||||
int add(int a, int b) { return a + b; }
|
||||
```
|
||||
|
||||
## Step 2: Build
|
||||
|
||||
```bash
|
||||
dcr build --release
|
||||
```
|
||||
|
||||
Artifacts:
|
||||
|
||||
* `target/\<triple>/release/libmy-lib.a` (Linux)
|
||||
* `target/release/my-lib.lib` (Windows)
|
||||
* `target/include/` — header files
|
||||
|
||||
## Step 3: Use in another project
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
dcr add my-lib ../my-lib
|
||||
```
|
||||
|
||||
Automatically:
|
||||
|
||||
* Adds include path to `target/include/` of the library
|
||||
* Adds lib path to `target/\<triple>/release/`
|
||||
* Links `libmy-lib.a` / `my-lib.lib`
|
||||
@@ -0,0 +1,103 @@
|
||||
---
|
||||
sidebar_label: Multi-package workspace
|
||||
---
|
||||
|
||||
# Multi-Package Workspace
|
||||
|
||||
A project with three packages: two libraries and a binary.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
workspace/
|
||||
├── dcr.toml # root workspace
|
||||
├── lib-core/
|
||||
│ ├── dcr.toml
|
||||
│ └── src/core.c
|
||||
├── lib-utils/
|
||||
│ ├── dcr.toml
|
||||
│ └── src/utils.c
|
||||
└── app/
|
||||
├── dcr.toml
|
||||
└── src/main.c
|
||||
```
|
||||
|
||||
## Root dcr.toml
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-workspace"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
inherit = true
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
workspace_only = true
|
||||
|
||||
[workspace.lib-core]
|
||||
path = "lib-core"
|
||||
|
||||
[workspace.lib-utils]
|
||||
path = "lib-utils"
|
||||
deps = ["lib-core"]
|
||||
|
||||
[workspace.app]
|
||||
path = "app"
|
||||
deps = ["lib-core", "lib-utils"]
|
||||
main = true
|
||||
```
|
||||
|
||||
## Packages
|
||||
|
||||
`lib-core/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "lib-core"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`lib-utils/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "lib-utils"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`app/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "bin"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
cd workspace
|
||||
dcr build # builds everything in correct order
|
||||
dcr build --workspace app # only app (lib-core and lib-utils built as deps)
|
||||
dcr run # builds and runs main package
|
||||
```
|
||||
|
||||
Build order (topological sort):
|
||||
|
||||
1. `lib-core`
|
||||
2. `lib-utils` (depends on lib-core)
|
||||
3. `app` (depends on lib-core, lib-utils)
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_label: Build profiles
|
||||
---
|
||||
|
||||
# Build Profiles
|
||||
|
||||
Profiles allow overriding `[build]` fields for specific build modes.
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c17"
|
||||
cflags = ["-Wall"]
|
||||
|
||||
[build.debug]
|
||||
cflags = ["-O0", "-g"]
|
||||
|
||||
[build.release]
|
||||
cflags = ["-O3", "-DNDEBUG"]
|
||||
```
|
||||
|
||||
## Merge rules
|
||||
|
||||
Fields from `[build.\<profile>]` are merged on top of `[build]`:
|
||||
|
||||
* **Scalar fields** (strings, numbers, bools) — replaced
|
||||
* **Arrays** (`cflags`, `ldflags`, ...) — **appended** (extend the `[build]` array)
|
||||
|
||||
Set `inherit = false` to disable array inheritance (only profile's own arrays are used).
|
||||
|
||||
## Built-in profiles
|
||||
|
||||
The default flags for each profile are composed from three config fields:
|
||||
|
||||
| Field | debug default | release default |
|
||||
| ----------- | ------------------ | --------------- |
|
||||
| `opt_level` | `"0"` | `"3"` |
|
||||
| `debug` | `true` | `false` |
|
||||
| `warnings` | `["all", "extra"]` | `[]` |
|
||||
|
||||
Which produce the equivalent compiler flags:
|
||||
|
||||
| Profile | Effective flags |
|
||||
| --------- | ---------------------------------------------------------- |
|
||||
| `debug` | `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG` |
|
||||
| `release` | `-O3 -DNDEBUG` |
|
||||
|
||||
Additional build options can be toggled per-profile:
|
||||
|
||||
```toml
|
||||
[build.release]
|
||||
opt_level = "z"
|
||||
lto = true
|
||||
strip = true
|
||||
panic = "abort"
|
||||
codegen-units = "1"
|
||||
|
||||
[build.debug]
|
||||
opt_level = "1"
|
||||
debug = false
|
||||
warnings = ["all", "error"]
|
||||
```
|
||||
|
||||
## Target-specific profiles
|
||||
|
||||
```toml
|
||||
[build.linux]
|
||||
cflags = ["-DLINUX"]
|
||||
|
||||
[build.windows.debug]
|
||||
cflags = ["-DWIN32", "-O0", "-g"]
|
||||
```
|
||||
|
||||
Application order (highest priority first):
|
||||
|
||||
1. `[build.\<target>.\<profile>]`
|
||||
2. `[build.\<profile>.\<target>]`
|
||||
3. `[build.\<target>]`
|
||||
4. `[build.\<profile>]`
|
||||
5. `[build]`
|
||||
131
docs-crowdin-export/de-DE/docs/reference/build-system.mdx.mdx
Normal file
131
docs-crowdin-export/de-DE/docs/reference/build-system.mdx.mdx
Normal file
@@ -0,0 +1,131 @@
|
||||
---
|
||||
sidebar_label: Build system
|
||||
---
|
||||
|
||||
# Build System
|
||||
|
||||
## Compiler Backends
|
||||
|
||||
DCR supports 7 compilation backends. Selection is automatic based on file extension and `build.compiler` value.
|
||||
|
||||
| Backend | Files | When used |
|
||||
| --------- | --------------------------------- | ------------------------------------- |
|
||||
| `unix_cc` | `.c`, `.cpp`, `.cxx`, `.cc`, `.S` | gcc/clang on Linux/macOS/BSD |
|
||||
| `msvc` | `.c`, `.cpp`, `.cxx`, `.cc` | Windows (cl, clang-cl) |
|
||||
| `gas` | `.s` | ARM/ARM64 assembler (no preprocessor) |
|
||||
| `nasm` | `.asm`, `.s` | x86/x86_64 NASM assembler |
|
||||
| `masm` | `.asm` | MASM (ml/ml64) on Windows |
|
||||
| `fasm` | `.asm`, `.fasm` | Flat Assembler |
|
||||
| `llvm_ir` | `.ll` | LLVM IR via `llc -filetype=obj` |
|
||||
|
||||
## Qt Support
|
||||
|
||||
DCR provides native Qt support for automatic meta-object handling (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.
|
||||
|
||||
```toml
|
||||
[build]
|
||||
qt = true
|
||||
```
|
||||
|
||||
*Note: Requires `qt6` modules (Core, Widgets, Gui, Svg) installed via `pkg-config`.*
|
||||
|
||||
Advanced customization is still possible via `build.steps` if special handling is needed:
|
||||
|
||||
```toml
|
||||
[build.steps]
|
||||
moc = "moc {in} -o {out}"
|
||||
```
|
||||
|
||||
### Unix CC
|
||||
|
||||
* Compiler resolved via `resolve_compiler()`: `DCR_COMPILER` > `DCR_CC` > `[toolchain]` > `build.compiler` > `PATH`
|
||||
* Supports `.d` files for header dependency tracking
|
||||
* Flags: `-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`
|
||||
|
||||
### MSVC
|
||||
|
||||
* Supports cl.exe and clang-cl.exe
|
||||
* Flags: `/std:`, `/Fo:`, `/Fe:`, `/I`, `/link`
|
||||
|
||||
### GAS / NASM / MASM / FASM / LLVM-IR
|
||||
|
||||
* GAS: `-I`, `-c -o`, `--defsym`
|
||||
* NASM: `-I`, `-o`, `-D`, `-f` (format: win64/elf64/macho64/macho32/elf32)
|
||||
* MASM: `/nologo /c /Fo\<obj> <source>`
|
||||
* FASM: `<source> \<output>` (output path is the object file)
|
||||
* LLVM IR: `-filetype=obj <source> -o \<output>`
|
||||
|
||||
## Incremental Builds
|
||||
|
||||
Three levels of incrementality:
|
||||
|
||||
1. **mtime** — if output is newer than all inputs, skip
|
||||
2. **`.d` files** — header change tracking (including transitive)
|
||||
3. **SHA256 fingerprint** — recompile if compiler flags changed (stored in `.dcr_fingerprint`)
|
||||
|
||||
## Parallel Compilation
|
||||
|
||||
* `thread::scope` for thread pool
|
||||
* Atomic task queue (`AtomicU64`)
|
||||
* Mutex on stdout (`OUTPUT_MUTEX`)
|
||||
* Thread count = `available_parallelism()`, capped by `build.codegen-units` if set
|
||||
|
||||
## Build Kinds
|
||||
|
||||
| Kind | Type | Path (Linux example) |
|
||||
| ----------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `bin` | Executable | `target/\<triple>/\<profile>/\<name>` (.exe on Windows) |
|
||||
| `staticlib` | Static library | `target/\<triple>/\<profile>/lib\<name>.a` (.lib) |
|
||||
| `sharedlib` | Dynamic library | `target/\<triple>/\<profile>/lib\<name>.so` (.dll/.dylib) |
|
||||
| `efi` | UEFI application | `target/\<triple>/\<profile>/\<name>.efi` |
|
||||
| `elf` | ELF without stdlib | `target/\<triple>/\<profile>/\<name>` |
|
||||
| `none` | Compile only, no link | — |
|
||||
| `custom` | Full filename+extension control | `target/\<triple>/\<profile>/\<filename>.\<extension>` |
|
||||
|
||||
## Build Steps
|
||||
|
||||
DCR supports pre-build and post-build steps:
|
||||
|
||||
* `build.steps` — commands before compilation
|
||||
* `build.post_steps` — commands after compilation
|
||||
|
||||
Substitutions: `{stem}`, `{in}`, `{out}`, `{profile}`, `{version}`, `{name}`.
|
||||
|
||||
Example Qt codegen via build steps:
|
||||
|
||||
```toml
|
||||
[build.steps]
|
||||
moc = "moc {in} -o {out}"
|
||||
```
|
||||
|
||||
## pkg-config
|
||||
|
||||
Automatic lookup (read from raw config):
|
||||
|
||||
```toml
|
||||
[build]
|
||||
pkg_config = ["sdl2", "gl"]
|
||||
```
|
||||
|
||||
DCR runs `pkg-config --cflags sdl2 gl` and `pkg-config --libs sdl2 gl` and adds results to compiler/linker flags.
|
||||
|
||||
## Variable Substitution
|
||||
|
||||
Supported variables:
|
||||
|
||||
| Variable | Description |
|
||||
| ----------------------- | ---------------------------- |
|
||||
| `{version}` | Package version |
|
||||
| `{version_major}` | Major version part |
|
||||
| `{version_minor}` | Minor version part |
|
||||
| `{version_patch}` | Patch version |
|
||||
| `{version_suffix}` | Suffix (e.g., `-rc1`) |
|
||||
| `{version_suffix_dash}` | Suffix with dash |
|
||||
| `{profile}` | Profile name (debug/release) |
|
||||
| `{name}` | Package name |
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_label: Cross-compilation
|
||||
---
|
||||
|
||||
# Cross-Compilation
|
||||
|
||||
## Short Names
|
||||
|
||||
DCR supports short platform names:
|
||||
|
||||
| Short Name | Full Triple |
|
||||
| ---------- | -------------------------- |
|
||||
| `linux` | `x86_64-unknown-linux-gnu` |
|
||||
| `macos` | `x86_64-apple-darwin` |
|
||||
| `windows` | `x86_64-pc-windows-msvc` |
|
||||
|
||||
```bash
|
||||
dcr build --target windows
|
||||
```
|
||||
|
||||
## Full Triples
|
||||
|
||||
```bash
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
dcr build --target x86_64-pc-windows-gnu # mingw
|
||||
dcr build --target armv7-unknown-linux-gnueabihf
|
||||
```
|
||||
|
||||
## clang --target
|
||||
|
||||
When using clang, DCR injects `--target=\<triple>` into CFLAGS.
|
||||
|
||||
```toml
|
||||
[build]
|
||||
compiler = "clang"
|
||||
target = "aarch64-unknown-linux-gnu"
|
||||
# Auto: cflags += ["--target=aarch64-unknown-linux-gnu"]
|
||||
```
|
||||
|
||||
## Bare-Metal / Freestanding
|
||||
|
||||
For targets containing `none`, `-elf`, `eabi`, or `baremetal`, DCR automatically:
|
||||
|
||||
1. **Disables default flags** — no system include paths, no `-l` libc
|
||||
2. **Injects `-ffreestanding`** at compile time and `-nostdlib -static` at link time
|
||||
|
||||
You can also enable freestanding mode explicitly:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
freestanding = true
|
||||
```
|
||||
|
||||
```bash
|
||||
dcr build --target aarch64-none-elf
|
||||
```
|
||||
|
||||
## Target Directory
|
||||
|
||||
On Linux with explicit target:
|
||||
|
||||
```
|
||||
target/<triple>/<profile>/
|
||||
```
|
||||
|
||||
On macOS/Windows or without target:
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
176
docs-crowdin-export/de-DE/docs/reference/dcr-toml.mdx.mdx
Normal file
176
docs-crowdin-export/de-DE/docs/reference/dcr-toml.mdx.mdx
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
sidebar_label: dcr.toml overview
|
||||
---
|
||||
|
||||
# dcr.toml
|
||||
|
||||
Main project configuration file. Located at the project root.
|
||||
|
||||
## Structure
|
||||
|
||||
```toml
|
||||
[package]
|
||||
# required fields
|
||||
|
||||
[build]
|
||||
# build settings
|
||||
|
||||
[build.debug] # optional: debug override
|
||||
[build.release] # optional: release override
|
||||
|
||||
[build.linux] # optional: Linux override
|
||||
[build.windows] # optional: Windows override
|
||||
[build.windows.debug] # target + profile combination
|
||||
|
||||
[toolchain]
|
||||
# compiler/linker paths
|
||||
|
||||
[dependencies]
|
||||
# project dependencies
|
||||
|
||||
[workspace]
|
||||
# multi-package configuration
|
||||
|
||||
[run]
|
||||
# run settings
|
||||
```
|
||||
|
||||
## [package]
|
||||
|
||||
| Field | Required | Description |
|
||||
| --------- | -------- | ------------------------------------------- |
|
||||
| `name` | yes | Project name |
|
||||
| `version` | yes | Semantic version |
|
||||
| `type` | no | `app`, `lib`, `none` (defaults to `"none"`) |
|
||||
| `license` | no | SPDX license identifier |
|
||||
| `author` | no | Author |
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "app"
|
||||
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`.
|
||||
|
||||
| Field | Default | Description |
|
||||
| ---------------- | ------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `language` | `"c"` | `"c"`, `"c++"`, `"cpp"`, `"cxx"`, `"asm"` (optional, defaults to `"c"`) |
|
||||
| `standard` | `"c11"` | C standard (`c11`, `c17`, `c23`) |
|
||||
| `cxx_standard` | — | C++ standard (`c++17`, `c++20`, `c++23`) |
|
||||
| `compiler` | `"clang"` | Preferred compiler (optional, defaults to `"clang"`) |
|
||||
| `kind` | `"bin"` | `bin`, `staticlib`, `sharedlib`, `efi`, `elf`, `none`, `custom` |
|
||||
| `target` | host | Target triple for cross-compilation |
|
||||
| `platform` | `"native"` | `native`, `efi` |
|
||||
| `cflags` | `[]` | Additional C/C++/ASM flags |
|
||||
| `ldflags` | `[]` | Additional linker flags |
|
||||
| `filename` | `""` | Custom output file name |
|
||||
| `extension` | `""` | Custom file extension |
|
||||
| `roots` | `["src"]` | Source root directories |
|
||||
| `exclude` | `[]` | Exclude patterns |
|
||||
| `include` | `[]` | Additional include directories |
|
||||
| `src_disable` | `false` | Disable auto source discovery |
|
||||
| `inherit` | `false` | Inherit build from workspace root |
|
||||
| `clean` | `[]` | Glob patterns for custom clean paths |
|
||||
| `out_dir` | `""` | Custom output directory |
|
||||
| `workspace_only` | `false` | Workspace-only, not built standalone (no `language`/`compiler` required) |
|
||||
| `freestanding` | `false` | Compile in freestanding mode (`-ffreestanding` + `-nostdlib -static`) |
|
||||
| `opt_level` | — | Optimization level: `0`-`3`, `"s"`, `"z"` (derived from profile if omitted) |
|
||||
| `debug` | profile-based | Emit debug symbols (`-g`): `true` in debug, `false` in release |
|
||||
| `lto` | `false` | Link-time optimization (`-flto` for both compiler and linker) |
|
||||
| `strip` | `false` | Strip symbols from output (`-s` in ldflags) |
|
||||
| `warnings` | `[]` | Warning flags (e.g. `"all"`, `"extra"`, `"pedantic"`); engine adds `-Wall -Wextra` in debug if empty |
|
||||
| `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) |
|
||||
|
||||
Settings from raw config (not in typed struct):
|
||||
|
||||
* `pkg_config` — list of pkg-config packages
|
||||
* `ldscript` — linker script path
|
||||
* `build.steps` / `build.post_steps` — codegen steps
|
||||
|
||||
## Per-language overrides: `[build.c]`, `[build.cxx]`, `[build.asm]`
|
||||
|
||||
Each language can have its own table that overrides the flat `[build]` settings:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
compiler = "clang"
|
||||
standard = "c11"
|
||||
|
||||
[build.c]
|
||||
standard = "c23"
|
||||
compiler = "gcc"
|
||||
|
||||
[build.cxx]
|
||||
standard = "c++23"
|
||||
compiler = "g++"
|
||||
|
||||
[build.asm]
|
||||
compiler = "nasm"
|
||||
flags = ["-felf64"]
|
||||
```
|
||||
|
||||
The flat `[build]` acts as fallback; per-language tables take precedence for their language.
|
||||
|
||||
Example:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
language = "c++"
|
||||
standard = "c23"
|
||||
cxx_standard = "c++23"
|
||||
compiler = "clang"
|
||||
kind = "sharedlib"
|
||||
cflags = ["-Wall", "-Wextra"]
|
||||
opt_level = "z"
|
||||
lto = true
|
||||
strip = true
|
||||
panic = "abort"
|
||||
codegen-units = "2"
|
||||
```
|
||||
|
||||
## [toolchain]
|
||||
|
||||
```toml
|
||||
[toolchain]
|
||||
cc = "/usr/bin/clang"
|
||||
cxx = "/usr/bin/clang++"
|
||||
as = "/usr/bin/as"
|
||||
ar = "/usr/bin/ar"
|
||||
ld = "/usr/bin/ld.lld"
|
||||
```
|
||||
|
||||
Raw config also supports `uic`, `moc`, `rcc` for Qt codegen.
|
||||
|
||||
## [dependencies]
|
||||
|
||||
See [dependencies](/docs/reference/dependencies).
|
||||
|
||||
## [run]
|
||||
|
||||
```toml
|
||||
[run]
|
||||
cmd = "./target/{profile}/{name}"
|
||||
```
|
||||
|
||||
Substitutions:
|
||||
|
||||
* `{version}` — package version
|
||||
* `{version_major}`, `{version_minor}`, `{version_patch}`, `{version_suffix}`, `{version_suffix_dash}` — version parts
|
||||
* `{profile}` — debug / release
|
||||
* `{name}` — package name
|
||||
|
||||
Default `cmd` = `./target/{profile}/{name}` (macOS/Windows) or `./target/\<triple>/\<profile>/\<name>` (Linux).
|
||||
|
||||
## [workspace]
|
||||
|
||||
See [workspaces](/docs/reference/workspaces).
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_label: Dependencies
|
||||
---
|
||||
|
||||
# Dependencies
|
||||
|
||||
## Formats
|
||||
|
||||
The `[dependencies]` section supports three formats:
|
||||
|
||||
### String (registry)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
fmt = "10.1.1"
|
||||
spdlog = "1.12"
|
||||
catch2 = "3.4.0"
|
||||
```
|
||||
|
||||
The version string is used as-is for registry lookup.
|
||||
|
||||
### Table (git)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
fmt = { git = "https://github.com/fmtlib/fmt", tag = "10.1.1" }
|
||||
```
|
||||
|
||||
Fields: `git`, `branch`, `tag`, `rev`.
|
||||
|
||||
### Table (path)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
mylib = { path = "../mylib" }
|
||||
```
|
||||
|
||||
## Registry
|
||||
|
||||
DCR uses a package registry for dependency lookup by name.
|
||||
|
||||
```toml
|
||||
# ~/.dcr/config.toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
Registry priority: order in `config.toml`. The `DCR_INDEX_PATH` variable overrides the path to `index.json`.
|
||||
|
||||
## Git dependencies
|
||||
|
||||
Git dependencies are parsed and recorded in `dcr.lock`. DCR supports specifying branch/tag/rev for git sources:
|
||||
|
||||
* `branch` — switch to a branch
|
||||
* `tag` — switch to a tag
|
||||
* `rev` — switch to a specific commit
|
||||
* `features` — feature flags (parsed, but does not affect build)
|
||||
|
||||
## Path dependencies
|
||||
|
||||
Local paths. DCR automatically discovers include and lib directories from the neighbor's `dcr.toml`.
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
mylib = { path = "/abs/path/to/lib" }
|
||||
mylib = { path = "../relative/path" }
|
||||
```
|
||||
|
||||
## dcr.lock
|
||||
|
||||
Dependency lock file. Contains package names and sources.
|
||||
|
||||
Created during `dcr build` when registry dependencies are present. Not updated during `dcr add` — only on the next `dcr build`.
|
||||
|
||||
## Resolution process
|
||||
|
||||
1. Load all dependencies (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
|
||||
5. Collect `include_dirs`, `lib_dirs`, `libs` for the compiler
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_label: Environment variables
|
||||
---
|
||||
|
||||
# Environment Variables
|
||||
|
||||
## DCR_COMPILER
|
||||
|
||||
Overrides the compiler for all languages. **Highest priority.**
|
||||
|
||||
```bash
|
||||
export DCR_COMPILER=clang
|
||||
dcr build
|
||||
```
|
||||
|
||||
Compiler resolution priority:
|
||||
|
||||
1. `DCR_COMPILER` (env)
|
||||
2. `DCR_CC` / `DCR_CXX` / `DCR_AS` (env)
|
||||
3. `[toolchain]` (dcr.toml)
|
||||
4. `build.compiler` (dcr.toml)
|
||||
5. `PATH`
|
||||
|
||||
## DCR_CC / DCR_CXX / DCR_AS
|
||||
|
||||
Per-language override (lower priority than `DCR_COMPILER`, higher than `[toolchain]`).
|
||||
|
||||
```bash
|
||||
export DCR_CC=gcc-14
|
||||
export DCR_CXX=g++-14
|
||||
export DCR_AS=arm-linux-gnueabihf-as
|
||||
```
|
||||
|
||||
## DCR_LD / DCR_AR
|
||||
|
||||
Override linker and archiver.
|
||||
|
||||
```bash
|
||||
export DCR_LD=ld.lld
|
||||
export DCR_AR=llvm-ar
|
||||
```
|
||||
|
||||
## DCR_DEBUG
|
||||
|
||||
Enables debug mode — prints all compilation commands to stderr before execution.
|
||||
|
||||
```bash
|
||||
export DCR_DEBUG=1
|
||||
dcr build
|
||||
```
|
||||
|
||||
## DCR_INDEX_PATH
|
||||
|
||||
Overrides the path to the registry `index.json`.
|
||||
|
||||
```bash
|
||||
export DCR_INDEX_PATH=/custom/path/index.json
|
||||
```
|
||||
|
||||
Default: `~/.dcr/index.json`.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: Platform support
|
||||
---
|
||||
|
||||
# Platform Support
|
||||
|
||||
## Target Triples
|
||||
|
||||
DCR normalizes target triples. Short platform names are expanded to full triples.
|
||||
|
||||
### Linux
|
||||
|
||||
```
|
||||
target/<arch>-unknown-linux-gnu/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64` (host-detected).
|
||||
|
||||
Artifact type: ELF. Extensions: `.so` (sharedlib), `.a` (staticlib).
|
||||
|
||||
### macOS
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64` (host-detected).
|
||||
|
||||
Extensions: `.dylib` (sharedlib), `.a` (staticlib).
|
||||
|
||||
### Windows
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64`.
|
||||
|
||||
Extensions: `.exe` (bin), `.lib` (staticlib), `.dll` (sharedlib), `.efi` (UEFI).
|
||||
|
||||
### BSD
|
||||
|
||||
```
|
||||
target/<arch>-unknown-<os>/<profile>/
|
||||
```
|
||||
|
||||
Supported systems: `freebsd`, `openbsd`, `netbsd`, `dragonfly`.
|
||||
|
||||
## Host Detection
|
||||
|
||||
DCR uses `std::env::consts::ARCH` and `std::env::consts::OS` for host platform detection. Used as fallback when `target` is not specified.
|
||||
85
docs-crowdin-export/de-DE/docs/reference/workspaces.mdx.mdx
Normal file
85
docs-crowdin-export/de-DE/docs/reference/workspaces.mdx.mdx
Normal file
@@ -0,0 +1,85 @@
|
||||
---
|
||||
sidebar_label: Workspaces
|
||||
---
|
||||
|
||||
# Workspaces
|
||||
|
||||
Workspaces allow managing multiple packages in a single repository.
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[workspace.lib-core]
|
||||
path = "lib-core"
|
||||
|
||||
[workspace.lib-utils]
|
||||
path = "lib-utils"
|
||||
deps = ["lib-core"]
|
||||
|
||||
[workspace.app]
|
||||
path = "app"
|
||||
deps = ["lib-core", "lib-utils"]
|
||||
main = true
|
||||
```
|
||||
|
||||
### Member fields
|
||||
|
||||
| Field | Description |
|
||||
| ------ | ------------------------------------------------ |
|
||||
| `path` | Path to the package (relative to workspace root) |
|
||||
| `deps` | Dependencies on other members |
|
||||
| `main` | Mark as the main package |
|
||||
|
||||
## Topological sort
|
||||
|
||||
DCR automatically sorts packages by dependencies: package A is built before B if B depends on A.
|
||||
|
||||
Cyclic dependencies are detected and cause an error.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build # build all packages in dependency order
|
||||
dcr build --workspace app # build only app (dependencies built automatically)
|
||||
```
|
||||
|
||||
When building a workspace, member outputs (libraries) are automatically added to include/lib paths of dependent packages.
|
||||
|
||||
## Clean
|
||||
|
||||
```bash
|
||||
dcr clean # clean only root target/
|
||||
dcr clean --all # clean target/ of all packages
|
||||
```
|
||||
|
||||
## Inheritance
|
||||
|
||||
If a member has `inherit = true` in its `[build]` section, fields from the root `[build]` are merged into the member:
|
||||
|
||||
```toml
|
||||
# root dcr.toml
|
||||
[build]
|
||||
inherit = true
|
||||
language = "c"
|
||||
standard = "c17"
|
||||
|
||||
# member inherits language and standard
|
||||
```
|
||||
|
||||
## Workspace-only root (no build of its own)
|
||||
|
||||
A workspace root can set `workspace_only = true` — it won't be built itself, and doesn't need `language` or `compiler`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-workspace"
|
||||
version = "0.1.0"
|
||||
|
||||
[build]
|
||||
workspace_only = true
|
||||
kind = "bin"
|
||||
|
||||
[workspace]
|
||||
lib-core = { path = "lib-core" }
|
||||
app = { path = "app", deps = ["lib-core"] }
|
||||
```
|
||||
46
docs-crowdin-export/de-DE/docs/self-update.mdx.mdx
Normal file
46
docs-crowdin-export/de-DE/docs/self-update.mdx.mdx
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_label: Self Update
|
||||
---
|
||||
|
||||
# Self Update
|
||||
|
||||
## dcr --update
|
||||
|
||||
Automatic update to the latest version. Downloads a binary (not an archive) from GitHub Releases and replaces the current executable.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
## How it works
|
||||
|
||||
1. DCR detects the current platform and architecture
|
||||
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)
|
||||
5. Replaces the current executable via `self_replace`
|
||||
|
||||
## Asset naming
|
||||
|
||||
Pattern: `dcr-\<triple>` or `dcr-\<triple>.exe`
|
||||
|
||||
| Platform | Asset name |
|
||||
| -------------- | -------------------------------- |
|
||||
| Linux x86_64 | `dcr-x86_64-unknown-linux-gnu` |
|
||||
| macOS x86_64 | `dcr-x86_64-apple-darwin` |
|
||||
| macOS ARM64 | `dcr-aarch64-apple-darwin` |
|
||||
| Windows x86_64 | `dcr-x86_64-pc-windows-msvc.exe` |
|
||||
|
||||
## AUR
|
||||
|
||||
If DCR was installed via AUR, `--update` shows a warning:
|
||||
|
||||
```
|
||||
Update via package manager: yay/paru -Syu {package_name} or sudo pacman -Syu {package_name}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
* Cannot detect platform — error
|
||||
* Cannot fetch release — error with URL
|
||||
* No write permission — error (use `sudo` or manual install)
|
||||
45
docs-crowdin-export/de-DE/docs/testing/running-tests.mdx.mdx
Normal file
45
docs-crowdin-export/de-DE/docs/testing/running-tests.mdx.mdx
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_label: Running tests
|
||||
---
|
||||
|
||||
# Running Tests
|
||||
|
||||
## Execution
|
||||
|
||||
```bash
|
||||
dcr test
|
||||
```
|
||||
|
||||
Builds the project, then compiles and runs test files from `tests/`.
|
||||
|
||||
## Profiles
|
||||
|
||||
```bash
|
||||
dcr test # debug (default)
|
||||
dcr test --release # release
|
||||
dcr test --debug # explicit debug
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
```
|
||||
=====================
|
||||
Testsuite summary
|
||||
=====================
|
||||
TOTAL: 5
|
||||
PASS: 3
|
||||
SKIP: 1
|
||||
FAIL: 1
|
||||
=====================
|
||||
```
|
||||
|
||||
## Exit code
|
||||
|
||||
* 0 — all tests passed (FAIL = 0)
|
||||
* 1 — test failures or build error
|
||||
|
||||
## What gets built
|
||||
|
||||
* All `.c` files from `tests/` (`.cpp` not supported)
|
||||
* Include path: `tests/` (for `dcr_test.h`)
|
||||
* Linked with project if `package.type = "lib"` or `kind = "staticlib"`/`"sharedlib"`
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_label: Test framework (EXPECT, TEST, ...)
|
||||
---
|
||||
|
||||
# Test Framework
|
||||
|
||||
DCR has a built-in minimal test framework for C.
|
||||
|
||||
## Macros
|
||||
|
||||
### `EXPECT(expr)`
|
||||
|
||||
Asserts that an expression is true.
|
||||
|
||||
```c
|
||||
EXPECT(1 + 1 == 2);
|
||||
EXPECT(ptr != NULL);
|
||||
```
|
||||
|
||||
### `SKIP(reason)`
|
||||
|
||||
Skips a test with a message.
|
||||
|
||||
```c
|
||||
SKIP("not implemented on Windows");
|
||||
```
|
||||
|
||||
### `TEST(name)`
|
||||
|
||||
Defines a test.
|
||||
|
||||
```c
|
||||
TEST(addition) {
|
||||
EXPECT(1 + 1 == 2);
|
||||
EXPECT(2 + 2 == 4);
|
||||
}
|
||||
```
|
||||
|
||||
### `TEST_CASE(name)`
|
||||
|
||||
Registers a test case.
|
||||
|
||||
```c
|
||||
TEST_CASE(math) {
|
||||
EXPECT(1 + 1 == 2);
|
||||
}
|
||||
```
|
||||
|
||||
## Initialization
|
||||
|
||||
```bash
|
||||
dcr test --init
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `tests/dcr_test.h` — framework header (do not edit)
|
||||
* `tests/test.c` — template with example test
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
tests/
|
||||
├── dcr_test.h # framework (do not edit)
|
||||
├── test.c # main tests
|
||||
└── ... # additional .c test files
|
||||
```
|
||||
|
||||
Only `.c` files are compiled (`.cpp` is not supported).
|
||||
63
docs-crowdin-export/pl-PL/docs/README.mdx.mdx
Normal file
63
docs-crowdin-export/pl-PL/docs/README.mdx.mdx
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_label: Introduction
|
||||
---
|
||||
|
||||
# DCR — C/C++ Build Tool & Package Manager
|
||||
|
||||
<details>
|
||||
<summary>Quick reference</summary>
|
||||
|
||||
```bash
|
||||
# Installation
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
|
||||
# Create a project
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
|
||||
# Build and run
|
||||
dcr build
|
||||
dcr run
|
||||
|
||||
# Run tests
|
||||
dcr test
|
||||
|
||||
# Add a dependency
|
||||
dcr add fmt
|
||||
|
||||
# Generate IDE files
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Contents
|
||||
|
||||
| Section | Description |
|
||||
| ----------------------------------------------------- | --------------------------------------------- |
|
||||
| [Getting Started](/docs/getting-started/installation) | Installation and first steps |
|
||||
| [Commands](/docs/commands/project-commands) | All CLI commands |
|
||||
| [Reference](/docs/reference/dcr-toml) | Configuration, build, dependencies, platforms |
|
||||
| [Testing](/docs/testing/test-framework) | Built-in test framework |
|
||||
| [Recipes](/docs/recipes/cross-to-windows) | Common scenarios |
|
||||
| [IDE Integration](/docs/ide-integration) | VS Code, CLion, compile_commands.json |
|
||||
| [Self Update](/docs/self-update) | Auto-update |
|
||||
| [FAQ](/docs/faq) | Frequently asked questions |
|
||||
| [Changelog](/docs/changelog) | Version history |
|
||||
| [License](/docs/license) | DCR and vendored library licenses |
|
||||
| [Contributing](/docs/contributing) | DCR development |
|
||||
|
||||
## Features
|
||||
|
||||
* **Incremental builds** — mtime + `.d` headers + SHA256 fingerprint
|
||||
* **Parallel compilation** — thread::scope, atomic task queue
|
||||
* **4 backends** — gcc/clang, MSVC/clang-cl, GAS (ARM), NASM (x86)
|
||||
* **7 project kinds** — bin, staticlib, sharedlib, efi, elf, none, custom
|
||||
* **Cross-compilation** — short names and full triples
|
||||
* **Profiles** — debug / release with field overrides
|
||||
* **Workspaces** — multi-package projects with topological sort
|
||||
* **Registry + Git + Path** — three dependency mechanisms
|
||||
* **IDE generation** — VS Code, CLion, compile_commands.json, JSON metadata
|
||||
* **pkg-config** — automatic system library discovery
|
||||
* **Per-command `--help`** — `dcr build --help`, `dcr new --help`, etc.
|
||||
* **Man pages** — `man dcr`, `man dcr-build`, `man dcr-new`
|
||||
91
docs-crowdin-export/pl-PL/docs/changelog.mdx.mdx
Normal file
91
docs-crowdin-export/pl-PL/docs/changelog.mdx.mdx
Normal file
@@ -0,0 +1,91 @@
|
||||
---
|
||||
sidebar_label: Changelog
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
## 0.7.1 (2026-06-02)
|
||||
|
||||
### Added
|
||||
|
||||
* **`--help` for all commands** — `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-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,
|
||||
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.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`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.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **`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.
|
||||
|
||||
## 0.7.0 (2026-06-01)
|
||||
|
||||
### Added
|
||||
|
||||
* **OpenBSD and NetBSD target support** — full platform routing with dynamic target triples using `std::env::consts::ARCH` and `std::env::consts::OS`. Affects `build`, `run`, `clean` commands and the platform module.
|
||||
* **`src/platform/bsd.rs`** — new BSD platform module (shared by FreeBSD, OpenBSD, NetBSD) providing `bin_path`, `lib_path`, `elf_path`, `efi_path`, `shared_lib_path`.
|
||||
* **`build.out_dir` config option** — custom output directory that overrides the default `target/\<triple>/\<profile>` path for final artifacts. Supported in `build`, `run`, and config validation.
|
||||
* **`dcr fmt` command** — new CLI command that formats all C/C++ source files (`*.c`, `*.cpp`, `*.h`, `*.hpp`) in `src/` and `tests/` using `clang-format`.
|
||||
* **Incremental linking** — `needs_link()` in `common.rs` checks if any object file is newer than the linked output, skipping unnecessary relinking. Implemented for all backends (`unix_cc`, `msvc`, `gas`, `nasm`).
|
||||
* **`build.kind = "none"` and `"custom"`** — two new project kinds for special build scenarios that don't produce standard artifacts.
|
||||
* **`install_bsd.sh`** — POSIX-compliant installation script for BSD systems (FreeBSD, OpenBSD, NetBSD) with binary download and source build modes.
|
||||
* **Linux ARM64 support in `install.sh`** — added `Linux:aarch64|Linux:arm64` target detection for pre-built binary downloads.
|
||||
* **BSD OS detection in `install.sh`** — detects FreeBSD, OpenBSD, NetBSD and determines target triple.
|
||||
* **`rust-toolchain.toml`** — explicit toolchain pinning to `stable` channel.
|
||||
* **Integration tests** — `build_with_target_config` (verifies `build.target = "linux"`) and `build_with_out_dir` (validates custom output directory).
|
||||
* **`get_build_string_with_profile` made `pub`** — so `run.rs` can determine custom output directory configuration.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`build.target` semantics changed** — now strictly contains a target triple (e.g., `x86_64-unknown-linux-gnu`) or short name (`linux`, `macos`, `windows`). No longer used as custom output directory — this functionality moved to `build.out_dir`.
|
||||
* **`build.standard` made optional** — changed from `String` to `Option\<String>`. Validation only enforces non-empty for non-ASM languages. Skipped in `dcr.toml` output if empty.
|
||||
* **`dcr run` with `out_dir`** — now determines target directory respecting `build.out_dir` via `get_build_string_with_profile()` from `build.rs`.
|
||||
* **`collect_sources()` returns empty vector** instead of error when no sources are found, allowing `kind = "none"` or `kind = "custom"` projects with no source files.
|
||||
* **CI/CD release workflow refactored** — `git2` made target-specific (no vendored-openssl on Windows), Zig-based cross-compilation for non-x86_64 Linux targets, Arch Linux package version cleanup (dashes → dots), `gmake` symlink for NetBSD.
|
||||
* **README compatibility table** — FreeBSD, OpenBSD, NetBSD build/run status upgraded from "community/best-effort" to "officially supported".
|
||||
* **Documentation updated** — `build-section.md` describes new `build.target` and `build.out_dir` fields. `target-directory.md` rewritten to clarify the distinction.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **stdout/stderr not inherited in `dcr run`** — child process output was captured and manually printed, breaking interactive programs. Fixed by switching to `Command::status()`.
|
||||
* **Race condition in release CI** — matrix build jobs could upload assets to a release that didn't exist yet. Fixed by adding a dedicated `create-release` job.
|
||||
* **Release GHA — stable toolchain override** — fixed Rust toolchain override issues in CI.
|
||||
* **Arch Linux package version sanitization** — version strings with dashes (e.g., `0.7.0-dev`) are invalid for `pkgver`. Fixed by replacing dashes with dots.
|
||||
* **GPG permissions after Docker** — Docker operations changed GPG directory ownership. Fixed by running `chown` after Docker commands.
|
||||
* **RPM artifact paths** — RPM artifacts were placed in `rpm/x86_64/` instead of `fedora/x86_64/`. Fixed in Dexoron Packages Index workflow.
|
||||
* **JSON parsing reliability in `install.sh`** — added `jq` as primary parser with `python3` fallback for dev channel release lookup.
|
||||
|
||||
### Removed
|
||||
|
||||
* **`format_roots()` helper function** — removed from `common.rs`. Was only used by the old error handling path in `collect_sources()`.
|
||||
* **Per-distribution artifact download steps** — three separate `actions/download-artifact` steps replaced with unified `gh release download --clobber`.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
sidebar_label: Build commands (build, run, clean)
|
||||
---
|
||||
|
||||
# Build Commands
|
||||
|
||||
## `dcr build`
|
||||
|
||||
Builds the project according to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr build # debug profile
|
||||
dcr build --release # release build
|
||||
dcr build --debug # explicit debug
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
dcr build --force # full rebuild
|
||||
dcr build --clean # clean + build
|
||||
dcr build --verbose # show compilation commands
|
||||
dcr build --workspace pkg-a # build specific workspace package
|
||||
```
|
||||
|
||||
Artifacts: `target/\<triple>/\<profile>/\<binary-name>` (Linux with explicit target).
|
||||
|
||||
## `dcr run`
|
||||
|
||||
Builds (if sources are newer than artifacts) and runs the binary.
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
dcr run --release
|
||||
```
|
||||
|
||||
## `dcr clean`
|
||||
|
||||
Removes `target/` directory (or `target/\<target>/\<profile>`).
|
||||
|
||||
```bash
|
||||
dcr clean
|
||||
dcr clean --release # target/release/ only
|
||||
dcr clean --target windows # target/x86_64-pc-windows-msvc/
|
||||
dcr clean --all # clean all workspace packages
|
||||
```
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_label: Dependency commands (add, tree)
|
||||
---
|
||||
|
||||
# Dependency Commands
|
||||
|
||||
## `dcr add \<name> [source]`
|
||||
|
||||
Adds a dependency to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr add fmt # registry lookup
|
||||
dcr add mylib ../path/to/lib # path as source
|
||||
dcr add mylib path:./lib # explicit path prefix
|
||||
dcr add mylib git:https://github.com/user/repo # explicit git prefix
|
||||
dcr add mylib github:user/repo # GitHub shorthand
|
||||
dcr add mylib gitlab:user/repo # GitLab shorthand
|
||||
```
|
||||
|
||||
Source prefixes:
|
||||
|
||||
* `path:` — local path
|
||||
* `git:` — generic git URL
|
||||
* `github:` — expands to `https://github.com/\<user>/\<repo>`
|
||||
* `gitlab:` — expands to `https://gitlab.com/\<user>/\<repo>`
|
||||
* `http://` / `https://` / `git@` — full URL
|
||||
|
||||
Flags:
|
||||
|
||||
* `--branch \<name>` — git branch
|
||||
* `--tag \<name>` — git tag
|
||||
* `--rev \<hash>` — git commit
|
||||
|
||||
If source is omitted — DCR searches connected registries.
|
||||
|
||||
## `dcr tree`
|
||||
|
||||
Displays the project dependency tree.
|
||||
|
||||
```bash
|
||||
dcr tree
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```
|
||||
my-app v0.1.0
|
||||
├── fmt (registry)
|
||||
│ └── spdlog (registry)
|
||||
└── catch2 (registry)
|
||||
```
|
||||
|
||||
For path dependencies, recursively shows their own dependencies (from their `dcr.toml`).
|
||||
73
docs-crowdin-export/pl-PL/docs/commands/gen-commands.mdx.mdx
Normal file
73
docs-crowdin-export/pl-PL/docs/commands/gen-commands.mdx.mdx
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
sidebar_label: Gen commands (vscode, clion, ...)
|
||||
---
|
||||
|
||||
# Gen Commands
|
||||
|
||||
## `dcr gen \<target>`
|
||||
|
||||
Generates IDE integration files.
|
||||
|
||||
### vscode
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.vscode/tasks.json` — `build` task (dcr build)
|
||||
* `.vscode/launch.json` — debug launch configuration
|
||||
* `.vscode/settings.json` — C/C++ settings (clangd paths, includes)
|
||||
* `.vscode/extensions.json` — recommended extensions (vscode-clangd, vscode-lldb)
|
||||
|
||||
### clion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.idea/externalTools.xml` — external tools (build, run, clean, test)
|
||||
* `.idea/customTargets.xml` — custom build targets
|
||||
* `.idea/misc.xml` — C/C++ project settings
|
||||
* `.idea/runConfigurations/\<name>.xml` — per-binary run configurations
|
||||
|
||||
### compile-commands
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` — standard format for clangd, cpptools, static analyzers.
|
||||
|
||||
### project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"name": "my-app",
|
||||
"version": "0.1.0",
|
||||
"root": "/path/to/project",
|
||||
"profile": "debug",
|
||||
"language": "c",
|
||||
"standard": "c17",
|
||||
"cxx_standard": null,
|
||||
"compiler": "/usr/bin/clang",
|
||||
"kind": "bin",
|
||||
"sources": ["src/main.c"],
|
||||
"include_dirs": ["src"],
|
||||
"lib_dirs": [],
|
||||
"libs": [],
|
||||
"cflags": ["-std=c17", "-O0", "-g"],
|
||||
"ldflags": []
|
||||
}
|
||||
]
|
||||
```
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
sidebar_label: Project commands (new, init)
|
||||
---
|
||||
|
||||
# Project Commands
|
||||
|
||||
## `dcr new \<name>`
|
||||
|
||||
Creates a new project with a standard structure and `dcr.toml`. The `name` argument is required.
|
||||
|
||||
Only ASCII letters, digits, underscores `_` and hyphens `-` are allowed in the project name.
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
dcr new my-app --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
Generates:
|
||||
|
||||
* `dcr.toml` with basic fields
|
||||
* `src/main.c` with a `main` template
|
||||
|
||||
## `dcr init`
|
||||
|
||||
Initializes a DCR project in the current (empty) directory.
|
||||
|
||||
```bash
|
||||
dcr init
|
||||
dcr init --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
The project name is taken from the current directory name. The directory name must follow the same naming rules as `dcr new`.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_label: Quality commands (test, fmt)
|
||||
---
|
||||
|
||||
# Quality Commands
|
||||
|
||||
## `dcr test`
|
||||
|
||||
Runs tests.
|
||||
|
||||
```bash
|
||||
dcr test # debug profile
|
||||
dcr test --release # release profile
|
||||
dcr test --debug # explicit debug
|
||||
dcr test --help # detailed help
|
||||
```
|
||||
|
||||
Before first use, initialize tests:
|
||||
|
||||
```bash
|
||||
dcr test --init
|
||||
```
|
||||
|
||||
This creates `tests/dcr_test.h` (framework) and `tests/test.c` (template).
|
||||
|
||||
What `dcr test` does:
|
||||
|
||||
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
|
||||
6. Returns non-zero exit code on any FAIL
|
||||
|
||||
## `dcr fmt`
|
||||
|
||||
Formats C/C++ source files using `clang-format`.
|
||||
|
||||
```bash
|
||||
dcr fmt
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}` and `tests/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}`.
|
||||
|
||||
Uses `.clang-format` at the project root (if present), otherwise default clang-format style.
|
||||
|
||||
## `dcr lint`
|
||||
|
||||
Runs `clang-tidy` on C/C++ source files for static analysis.
|
||||
|
||||
```bash
|
||||
dcr lint # show diagnostics
|
||||
dcr lint --fix # apply fixes automatically
|
||||
dcr lint --help # detailed help
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc}` and `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.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: System commands (setup, --help, ...)
|
||||
---
|
||||
|
||||
# System Commands
|
||||
|
||||
## `dcr setup`
|
||||
|
||||
Shows configured registries from `~/.dcr/config.toml`.
|
||||
|
||||
```bash
|
||||
dcr setup
|
||||
```
|
||||
|
||||
If `~/.dcr/config.toml` is not found, DCR returns an error. Create it manually:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
## `dcr --help`
|
||||
|
||||
Shows help for all commands.
|
||||
|
||||
```bash
|
||||
dcr --help
|
||||
```
|
||||
|
||||
## `dcr --version`
|
||||
|
||||
Shows version and target triple.
|
||||
|
||||
```bash
|
||||
dcr --version # dcr 0.7.0 (x86_64-unknown-linux-gnu)
|
||||
```
|
||||
|
||||
## `dcr --update`
|
||||
|
||||
Self-update. Downloads the latest release binary from GitHub Releases and replaces the current one.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
Features:
|
||||
|
||||
* Auto-detects platform and architecture
|
||||
* Warns if installed via AUR (use package manager instead)
|
||||
* Works on Linux, macOS, Windows
|
||||
51
docs-crowdin-export/pl-PL/docs/contributing.mdx.mdx
Normal file
51
docs-crowdin-export/pl-PL/docs/contributing.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: Contributing
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dexoron/dcr
|
||||
cd dcr
|
||||
cargo build
|
||||
```
|
||||
|
||||
## Code style
|
||||
|
||||
All code must be formatted with `cargo fmt`:
|
||||
|
||||
```bash
|
||||
cargo fmt
|
||||
```
|
||||
|
||||
## Linting
|
||||
|
||||
```bash
|
||||
cargo clippy --all-targets -- -D warnings
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
cargo test --all-targets
|
||||
```
|
||||
|
||||
## PR process
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a branch: `git checkout -b feature/description`
|
||||
3. Make changes
|
||||
4. Run `cargo fmt && cargo clippy && cargo test`
|
||||
5. Open a Pull Request
|
||||
|
||||
## CI
|
||||
|
||||
CI runs:
|
||||
|
||||
* `cargo fmt --check`
|
||||
* `cargo clippy --all-targets -- -D warnings`
|
||||
* `cargo test --all-targets`
|
||||
* Build on Linux, macOS, Windows
|
||||
* Integration tests
|
||||
81
docs-crowdin-export/pl-PL/docs/faq.mdx.mdx
Normal file
81
docs-crowdin-export/pl-PL/docs/faq.mdx.mdx
Normal file
@@ -0,0 +1,81 @@
|
||||
---
|
||||
sidebar_label: FAQ
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
## Registry not found
|
||||
|
||||
```
|
||||
error: registry not found
|
||||
```
|
||||
|
||||
**Solution:** Make sure `~/.dcr/config.toml` exists:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
And check `DCR_INDEX_PATH`:
|
||||
|
||||
```bash
|
||||
echo $DCR_INDEX_PATH
|
||||
```
|
||||
|
||||
## Compiler not found
|
||||
|
||||
```
|
||||
error: compiler not found
|
||||
```
|
||||
|
||||
**Solution:** Ensure a compiler is installed and available in PATH.
|
||||
|
||||
```bash
|
||||
which gcc
|
||||
which clang
|
||||
```
|
||||
|
||||
Or specify explicitly via `[toolchain]` in `dcr.toml`.
|
||||
|
||||
## openssl-sys build failed
|
||||
|
||||
When building DCR from source:
|
||||
|
||||
```
|
||||
error: failed to run custom build command for openssl-sys
|
||||
```
|
||||
|
||||
**Solution:** Install OpenSSL development headers:
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt install libssl-dev
|
||||
|
||||
# Fedora
|
||||
sudo dnf install openssl-devel
|
||||
|
||||
# macOS
|
||||
brew install openssl
|
||||
```
|
||||
|
||||
## Ctrl+C during build
|
||||
|
||||
DCR handles SIGINT: interrupts the current compilation and exits with non-zero code.
|
||||
|
||||
## How to create a library?
|
||||
|
||||
See [Library Recipe](/docs/recipes/library-project).
|
||||
|
||||
## How to cross-compile to Windows?
|
||||
|
||||
See [Cross-Compile Recipe](/docs/recipes/cross-to-windows).
|
||||
|
||||
## How to create a multi-package project?
|
||||
|
||||
See [Workspace Recipe](/docs/recipes/multi-package-workspace).
|
||||
|
||||
## Lock file
|
||||
|
||||
`dcr.lock` is created during builds (`dcr build`) when registry dependencies are present. To force an update — delete `dcr.lock` and run `dcr build`.
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
sidebar_label: First steps
|
||||
---
|
||||
|
||||
# First Steps
|
||||
|
||||
## Create a project
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
```
|
||||
|
||||
Structure:
|
||||
|
||||
```
|
||||
my-app/
|
||||
├── dcr.toml
|
||||
└── src/
|
||||
└── main.c
|
||||
```
|
||||
|
||||
`dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build
|
||||
```
|
||||
|
||||
Output — `target/\<triple>/debug/my-app` (Linux) or `target/debug/my-app.exe` (Windows).
|
||||
|
||||
Build profiles:
|
||||
|
||||
```bash
|
||||
dcr build --release # release build
|
||||
dcr build --debug # debug (default)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
```
|
||||
|
||||
Builds (if needed) and runs the binary.
|
||||
|
||||
## First test
|
||||
|
||||
```bash
|
||||
dcr test --init # create test template
|
||||
dcr test # run tests
|
||||
```
|
||||
|
||||
## Formatting
|
||||
|
||||
```bash
|
||||
dcr fmt # clang-format with .clang-format
|
||||
```
|
||||
@@ -0,0 +1,109 @@
|
||||
---
|
||||
sidebar_label: Installation
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
## Linux (Dexoron Packages)
|
||||
|
||||
Configure your package manager at https://pkg.dexoron.su and install:
|
||||
|
||||
**Arch Linux**
|
||||
|
||||
```sh
|
||||
sudo pacman -Sy dcr
|
||||
```
|
||||
|
||||
**Debian/Ubuntu**
|
||||
|
||||
```sh
|
||||
sudo apt update && sudo apt install dcr
|
||||
```
|
||||
|
||||
**Fedora/RHEL**
|
||||
|
||||
```sh
|
||||
sudo dnf install dcr
|
||||
```
|
||||
|
||||
## Arch Linux (AUR)
|
||||
|
||||
```sh
|
||||
yay -S dcr
|
||||
```
|
||||
|
||||
## macOS / Linux (Homebrew)
|
||||
|
||||
```sh
|
||||
brew tap dexoron/dexoron
|
||||
brew install dcr
|
||||
```
|
||||
|
||||
## Snap (Linux)
|
||||
|
||||
```sh
|
||||
sudo snap install dcrup
|
||||
```
|
||||
|
||||
## Nix (flake)
|
||||
|
||||
```sh
|
||||
nix run github:dexoron/dcr
|
||||
# or install to profile:
|
||||
nix profile install github:dexoron/dcr
|
||||
```
|
||||
|
||||
## Cargo (crates.io)
|
||||
|
||||
```sh
|
||||
cargo install dcr
|
||||
```
|
||||
|
||||
## Linux / macOS (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
```
|
||||
|
||||
## BSD (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install_bsd.sh | sh
|
||||
```
|
||||
|
||||
## Windows (PowerShell)
|
||||
|
||||
```powershell
|
||||
irm https://dcr.dexoron.su/install.ps1 | iex
|
||||
```
|
||||
|
||||
## From source
|
||||
|
||||
```sh
|
||||
git clone https://github.com/dexoron/dcr.git
|
||||
cd dcr && cargo build --release
|
||||
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
||||
```
|
||||
|
||||
## Post-install
|
||||
|
||||
Verify the installation:
|
||||
|
||||
```bash
|
||||
dcr --version
|
||||
```
|
||||
|
||||
Man pages are available after installation:
|
||||
|
||||
```bash
|
||||
man dcr
|
||||
man dcr-build
|
||||
```
|
||||
|
||||
To use the registry, create `~/.dcr/config.toml`:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
51
docs-crowdin-export/pl-PL/docs/ide-integration.mdx.mdx
Normal file
51
docs-crowdin-export/pl-PL/docs/ide-integration.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: IDE Integration
|
||||
---
|
||||
|
||||
# IDE Integration
|
||||
|
||||
## VS Code
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Generates in `.vscode/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ----------------- | -------------------------------------------- |
|
||||
| `tasks.json` | `build` task (dcr build) |
|
||||
| `launch.json` | Debug launch configuration |
|
||||
| `settings.json` | clangd/IntelliSense: include paths, standard |
|
||||
| `extensions.json` | Recommends vscode-clangd, vscode-lldb |
|
||||
|
||||
## CLion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Generates in `.idea/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ------------------------------------------------ | ----------------------------------------- |
|
||||
| `externalTools.xml` | Build, Run, Clean, Test as external tools |
|
||||
| `customTargets.xml` | Custom build targets |
|
||||
| `misc.xml` | C/C++ project settings |
|
||||
| `runConfigurations/\<name>.xml` | Per-binary run configurations |
|
||||
|
||||
## compile_commands.json
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` at project root. Standard format for clangd, C/C++ IntelliSense, static analyzers.
|
||||
|
||||
## project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata (see [gen-commands](/docs/commands/gen-commands)).
|
||||
33
docs-crowdin-export/pl-PL/docs/license.mdx.mdx
Normal file
33
docs-crowdin-export/pl-PL/docs/license.mdx.mdx
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
sidebar_label: License
|
||||
---
|
||||
|
||||
# License
|
||||
|
||||
## DCR
|
||||
|
||||
DCR itself is [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) licensed.
|
||||
|
||||
> **Note:** DCR is a build tool, not a library. The GPL applies only to DCR's own source code. Projects built with DCR are not subject to DCR's license — their licensing is determined solely by their own code and dependencies.
|
||||
|
||||
## Rust dependencies
|
||||
|
||||
DCR is written in Rust. The following notable Rust crates are statically linked:
|
||||
|
||||
| Crate | License |
|
||||
| ------------------------------------------------------- | ----------------- |
|
||||
| [`ureq`](https://crates.io/crates/ureq) | MIT OR Apache-2.0 |
|
||||
| [`serde`](https://crates.io/crates/serde) | MIT OR Apache-2.0 |
|
||||
| [`toml`](https://crates.io/crates/toml) | MIT OR Apache-2.0 |
|
||||
| [`toml_edit`](https://crates.io/crates/toml_edit) | MIT OR Apache-2.0 |
|
||||
| [`serde_json`](https://crates.io/crates/serde_json) | MIT OR Apache-2.0 |
|
||||
| [`sha2`](https://crates.io/crates/sha2) | MIT OR Apache-2.0 |
|
||||
| [`glob`](https://crates.io/crates/glob) | MIT OR Apache-2.0 |
|
||||
| [`self-replace`](https://crates.io/crates/self-replace) | MIT OR Apache-2.0 |
|
||||
| [`ctrlc`](https://crates.io/crates/ctrlc) | MIT OR Apache-2.0 |
|
||||
|
||||
Full dependency tree is available in [`Cargo.lock`](https://github.com/dexoron/dcr/blob/main/Cargo.lock). The overwhelming majority are dual-licensed under MIT OR Apache-2.0.
|
||||
|
||||
## Additional credits
|
||||
|
||||
* DCR's CLI design and project model are inspired by [Cargo](https://doc.rust-lang.org/cargo/).
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_label: Cross-compile to Windows
|
||||
---
|
||||
|
||||
# Cross-Compile to Windows from Linux
|
||||
|
||||
Building a Windows binary on Linux using mingw-w64.
|
||||
|
||||
## Install toolchain
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt install mingw-w64
|
||||
|
||||
# Fedora
|
||||
sudo dnf install mingw64-gcc mingw64-binutils
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
target = "x86_64-pc-windows-gnu" # explicit mingw, not msvc
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build --target x86_64-pc-windows-gnu --release
|
||||
```
|
||||
|
||||
Artifact: `target/x86_64-pc-windows-gnu/release/my-app.exe`.
|
||||
|
||||
## Custom toolchain
|
||||
|
||||
```toml
|
||||
[toolchain]
|
||||
cc = "x86_64-w64-mingw32-gcc"
|
||||
cxx = "x86_64-w64-mingw32-g++"
|
||||
```
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_label: Library project
|
||||
---
|
||||
|
||||
# Library Project
|
||||
|
||||
Creating a static library and using it in another project.
|
||||
|
||||
## Step 1: Create the library
|
||||
|
||||
```bash
|
||||
dcr new my-lib
|
||||
cd my-lib
|
||||
```
|
||||
|
||||
`dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-lib"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`src/my_lib.h`:
|
||||
|
||||
```c
|
||||
#ifndef MY_LIB_H
|
||||
#define MY_LIB_H
|
||||
int add(int a, int b);
|
||||
#endif
|
||||
```
|
||||
|
||||
`src/my_lib.c`:
|
||||
|
||||
```c
|
||||
#include "my_lib.h"
|
||||
int add(int a, int b) { return a + b; }
|
||||
```
|
||||
|
||||
## Step 2: Build
|
||||
|
||||
```bash
|
||||
dcr build --release
|
||||
```
|
||||
|
||||
Artifacts:
|
||||
|
||||
* `target/\<triple>/release/libmy-lib.a` (Linux)
|
||||
* `target/release/my-lib.lib` (Windows)
|
||||
* `target/include/` — header files
|
||||
|
||||
## Step 3: Use in another project
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
dcr add my-lib ../my-lib
|
||||
```
|
||||
|
||||
Automatically:
|
||||
|
||||
* Adds include path to `target/include/` of the library
|
||||
* Adds lib path to `target/\<triple>/release/`
|
||||
* Links `libmy-lib.a` / `my-lib.lib`
|
||||
@@ -0,0 +1,103 @@
|
||||
---
|
||||
sidebar_label: Multi-package workspace
|
||||
---
|
||||
|
||||
# Multi-Package Workspace
|
||||
|
||||
A project with three packages: two libraries and a binary.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
workspace/
|
||||
├── dcr.toml # root workspace
|
||||
├── lib-core/
|
||||
│ ├── dcr.toml
|
||||
│ └── src/core.c
|
||||
├── lib-utils/
|
||||
│ ├── dcr.toml
|
||||
│ └── src/utils.c
|
||||
└── app/
|
||||
├── dcr.toml
|
||||
└── src/main.c
|
||||
```
|
||||
|
||||
## Root dcr.toml
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-workspace"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
inherit = true
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
workspace_only = true
|
||||
|
||||
[workspace.lib-core]
|
||||
path = "lib-core"
|
||||
|
||||
[workspace.lib-utils]
|
||||
path = "lib-utils"
|
||||
deps = ["lib-core"]
|
||||
|
||||
[workspace.app]
|
||||
path = "app"
|
||||
deps = ["lib-core", "lib-utils"]
|
||||
main = true
|
||||
```
|
||||
|
||||
## Packages
|
||||
|
||||
`lib-core/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "lib-core"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`lib-utils/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "lib-utils"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`app/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "bin"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
cd workspace
|
||||
dcr build # builds everything in correct order
|
||||
dcr build --workspace app # only app (lib-core and lib-utils built as deps)
|
||||
dcr run # builds and runs main package
|
||||
```
|
||||
|
||||
Build order (topological sort):
|
||||
|
||||
1. `lib-core`
|
||||
2. `lib-utils` (depends on lib-core)
|
||||
3. `app` (depends on lib-core, lib-utils)
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_label: Build profiles
|
||||
---
|
||||
|
||||
# Build Profiles
|
||||
|
||||
Profiles allow overriding `[build]` fields for specific build modes.
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c17"
|
||||
cflags = ["-Wall"]
|
||||
|
||||
[build.debug]
|
||||
cflags = ["-O0", "-g"]
|
||||
|
||||
[build.release]
|
||||
cflags = ["-O3", "-DNDEBUG"]
|
||||
```
|
||||
|
||||
## Merge rules
|
||||
|
||||
Fields from `[build.\<profile>]` are merged on top of `[build]`:
|
||||
|
||||
* **Scalar fields** (strings, numbers, bools) — replaced
|
||||
* **Arrays** (`cflags`, `ldflags`, ...) — **appended** (extend the `[build]` array)
|
||||
|
||||
Set `inherit = false` to disable array inheritance (only profile's own arrays are used).
|
||||
|
||||
## Built-in profiles
|
||||
|
||||
The default flags for each profile are composed from three config fields:
|
||||
|
||||
| Field | debug default | release default |
|
||||
| ----------- | ------------------ | --------------- |
|
||||
| `opt_level` | `"0"` | `"3"` |
|
||||
| `debug` | `true` | `false` |
|
||||
| `warnings` | `["all", "extra"]` | `[]` |
|
||||
|
||||
Which produce the equivalent compiler flags:
|
||||
|
||||
| Profile | Effective flags |
|
||||
| --------- | ---------------------------------------------------------- |
|
||||
| `debug` | `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG` |
|
||||
| `release` | `-O3 -DNDEBUG` |
|
||||
|
||||
Additional build options can be toggled per-profile:
|
||||
|
||||
```toml
|
||||
[build.release]
|
||||
opt_level = "z"
|
||||
lto = true
|
||||
strip = true
|
||||
panic = "abort"
|
||||
codegen-units = "1"
|
||||
|
||||
[build.debug]
|
||||
opt_level = "1"
|
||||
debug = false
|
||||
warnings = ["all", "error"]
|
||||
```
|
||||
|
||||
## Target-specific profiles
|
||||
|
||||
```toml
|
||||
[build.linux]
|
||||
cflags = ["-DLINUX"]
|
||||
|
||||
[build.windows.debug]
|
||||
cflags = ["-DWIN32", "-O0", "-g"]
|
||||
```
|
||||
|
||||
Application order (highest priority first):
|
||||
|
||||
1. `[build.\<target>.\<profile>]`
|
||||
2. `[build.\<profile>.\<target>]`
|
||||
3. `[build.\<target>]`
|
||||
4. `[build.\<profile>]`
|
||||
5. `[build]`
|
||||
131
docs-crowdin-export/pl-PL/docs/reference/build-system.mdx.mdx
Normal file
131
docs-crowdin-export/pl-PL/docs/reference/build-system.mdx.mdx
Normal file
@@ -0,0 +1,131 @@
|
||||
---
|
||||
sidebar_label: Build system
|
||||
---
|
||||
|
||||
# Build System
|
||||
|
||||
## Compiler Backends
|
||||
|
||||
DCR supports 7 compilation backends. Selection is automatic based on file extension and `build.compiler` value.
|
||||
|
||||
| Backend | Files | When used |
|
||||
| --------- | --------------------------------- | ------------------------------------- |
|
||||
| `unix_cc` | `.c`, `.cpp`, `.cxx`, `.cc`, `.S` | gcc/clang on Linux/macOS/BSD |
|
||||
| `msvc` | `.c`, `.cpp`, `.cxx`, `.cc` | Windows (cl, clang-cl) |
|
||||
| `gas` | `.s` | ARM/ARM64 assembler (no preprocessor) |
|
||||
| `nasm` | `.asm`, `.s` | x86/x86_64 NASM assembler |
|
||||
| `masm` | `.asm` | MASM (ml/ml64) on Windows |
|
||||
| `fasm` | `.asm`, `.fasm` | Flat Assembler |
|
||||
| `llvm_ir` | `.ll` | LLVM IR via `llc -filetype=obj` |
|
||||
|
||||
## Qt Support
|
||||
|
||||
DCR provides native Qt support for automatic meta-object handling (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.
|
||||
|
||||
```toml
|
||||
[build]
|
||||
qt = true
|
||||
```
|
||||
|
||||
*Note: Requires `qt6` modules (Core, Widgets, Gui, Svg) installed via `pkg-config`.*
|
||||
|
||||
Advanced customization is still possible via `build.steps` if special handling is needed:
|
||||
|
||||
```toml
|
||||
[build.steps]
|
||||
moc = "moc {in} -o {out}"
|
||||
```
|
||||
|
||||
### Unix CC
|
||||
|
||||
* Compiler resolved via `resolve_compiler()`: `DCR_COMPILER` > `DCR_CC` > `[toolchain]` > `build.compiler` > `PATH`
|
||||
* Supports `.d` files for header dependency tracking
|
||||
* Flags: `-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`
|
||||
|
||||
### MSVC
|
||||
|
||||
* Supports cl.exe and clang-cl.exe
|
||||
* Flags: `/std:`, `/Fo:`, `/Fe:`, `/I`, `/link`
|
||||
|
||||
### GAS / NASM / MASM / FASM / LLVM-IR
|
||||
|
||||
* GAS: `-I`, `-c -o`, `--defsym`
|
||||
* NASM: `-I`, `-o`, `-D`, `-f` (format: win64/elf64/macho64/macho32/elf32)
|
||||
* MASM: `/nologo /c /Fo\<obj> <source>`
|
||||
* FASM: `<source> \<output>` (output path is the object file)
|
||||
* LLVM IR: `-filetype=obj <source> -o \<output>`
|
||||
|
||||
## Incremental Builds
|
||||
|
||||
Three levels of incrementality:
|
||||
|
||||
1. **mtime** — if output is newer than all inputs, skip
|
||||
2. **`.d` files** — header change tracking (including transitive)
|
||||
3. **SHA256 fingerprint** — recompile if compiler flags changed (stored in `.dcr_fingerprint`)
|
||||
|
||||
## Parallel Compilation
|
||||
|
||||
* `thread::scope` for thread pool
|
||||
* Atomic task queue (`AtomicU64`)
|
||||
* Mutex on stdout (`OUTPUT_MUTEX`)
|
||||
* Thread count = `available_parallelism()`, capped by `build.codegen-units` if set
|
||||
|
||||
## Build Kinds
|
||||
|
||||
| Kind | Type | Path (Linux example) |
|
||||
| ----------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `bin` | Executable | `target/\<triple>/\<profile>/\<name>` (.exe on Windows) |
|
||||
| `staticlib` | Static library | `target/\<triple>/\<profile>/lib\<name>.a` (.lib) |
|
||||
| `sharedlib` | Dynamic library | `target/\<triple>/\<profile>/lib\<name>.so` (.dll/.dylib) |
|
||||
| `efi` | UEFI application | `target/\<triple>/\<profile>/\<name>.efi` |
|
||||
| `elf` | ELF without stdlib | `target/\<triple>/\<profile>/\<name>` |
|
||||
| `none` | Compile only, no link | — |
|
||||
| `custom` | Full filename+extension control | `target/\<triple>/\<profile>/\<filename>.\<extension>` |
|
||||
|
||||
## Build Steps
|
||||
|
||||
DCR supports pre-build and post-build steps:
|
||||
|
||||
* `build.steps` — commands before compilation
|
||||
* `build.post_steps` — commands after compilation
|
||||
|
||||
Substitutions: `{stem}`, `{in}`, `{out}`, `{profile}`, `{version}`, `{name}`.
|
||||
|
||||
Example Qt codegen via build steps:
|
||||
|
||||
```toml
|
||||
[build.steps]
|
||||
moc = "moc {in} -o {out}"
|
||||
```
|
||||
|
||||
## pkg-config
|
||||
|
||||
Automatic lookup (read from raw config):
|
||||
|
||||
```toml
|
||||
[build]
|
||||
pkg_config = ["sdl2", "gl"]
|
||||
```
|
||||
|
||||
DCR runs `pkg-config --cflags sdl2 gl` and `pkg-config --libs sdl2 gl` and adds results to compiler/linker flags.
|
||||
|
||||
## Variable Substitution
|
||||
|
||||
Supported variables:
|
||||
|
||||
| Variable | Description |
|
||||
| ----------------------- | ---------------------------- |
|
||||
| `{version}` | Package version |
|
||||
| `{version_major}` | Major version part |
|
||||
| `{version_minor}` | Minor version part |
|
||||
| `{version_patch}` | Patch version |
|
||||
| `{version_suffix}` | Suffix (e.g., `-rc1`) |
|
||||
| `{version_suffix_dash}` | Suffix with dash |
|
||||
| `{profile}` | Profile name (debug/release) |
|
||||
| `{name}` | Package name |
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_label: Cross-compilation
|
||||
---
|
||||
|
||||
# Cross-Compilation
|
||||
|
||||
## Short Names
|
||||
|
||||
DCR supports short platform names:
|
||||
|
||||
| Short Name | Full Triple |
|
||||
| ---------- | -------------------------- |
|
||||
| `linux` | `x86_64-unknown-linux-gnu` |
|
||||
| `macos` | `x86_64-apple-darwin` |
|
||||
| `windows` | `x86_64-pc-windows-msvc` |
|
||||
|
||||
```bash
|
||||
dcr build --target windows
|
||||
```
|
||||
|
||||
## Full Triples
|
||||
|
||||
```bash
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
dcr build --target x86_64-pc-windows-gnu # mingw
|
||||
dcr build --target armv7-unknown-linux-gnueabihf
|
||||
```
|
||||
|
||||
## clang --target
|
||||
|
||||
When using clang, DCR injects `--target=\<triple>` into CFLAGS.
|
||||
|
||||
```toml
|
||||
[build]
|
||||
compiler = "clang"
|
||||
target = "aarch64-unknown-linux-gnu"
|
||||
# Auto: cflags += ["--target=aarch64-unknown-linux-gnu"]
|
||||
```
|
||||
|
||||
## Bare-Metal / Freestanding
|
||||
|
||||
For targets containing `none`, `-elf`, `eabi`, or `baremetal`, DCR automatically:
|
||||
|
||||
1. **Disables default flags** — no system include paths, no `-l` libc
|
||||
2. **Injects `-ffreestanding`** at compile time and `-nostdlib -static` at link time
|
||||
|
||||
You can also enable freestanding mode explicitly:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
freestanding = true
|
||||
```
|
||||
|
||||
```bash
|
||||
dcr build --target aarch64-none-elf
|
||||
```
|
||||
|
||||
## Target Directory
|
||||
|
||||
On Linux with explicit target:
|
||||
|
||||
```
|
||||
target/<triple>/<profile>/
|
||||
```
|
||||
|
||||
On macOS/Windows or without target:
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
176
docs-crowdin-export/pl-PL/docs/reference/dcr-toml.mdx.mdx
Normal file
176
docs-crowdin-export/pl-PL/docs/reference/dcr-toml.mdx.mdx
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
sidebar_label: dcr.toml overview
|
||||
---
|
||||
|
||||
# dcr.toml
|
||||
|
||||
Main project configuration file. Located at the project root.
|
||||
|
||||
## Structure
|
||||
|
||||
```toml
|
||||
[package]
|
||||
# required fields
|
||||
|
||||
[build]
|
||||
# build settings
|
||||
|
||||
[build.debug] # optional: debug override
|
||||
[build.release] # optional: release override
|
||||
|
||||
[build.linux] # optional: Linux override
|
||||
[build.windows] # optional: Windows override
|
||||
[build.windows.debug] # target + profile combination
|
||||
|
||||
[toolchain]
|
||||
# compiler/linker paths
|
||||
|
||||
[dependencies]
|
||||
# project dependencies
|
||||
|
||||
[workspace]
|
||||
# multi-package configuration
|
||||
|
||||
[run]
|
||||
# run settings
|
||||
```
|
||||
|
||||
## [package]
|
||||
|
||||
| Field | Required | Description |
|
||||
| --------- | -------- | ------------------------------------------- |
|
||||
| `name` | yes | Project name |
|
||||
| `version` | yes | Semantic version |
|
||||
| `type` | no | `app`, `lib`, `none` (defaults to `"none"`) |
|
||||
| `license` | no | SPDX license identifier |
|
||||
| `author` | no | Author |
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "app"
|
||||
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`.
|
||||
|
||||
| Field | Default | Description |
|
||||
| ---------------- | ------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `language` | `"c"` | `"c"`, `"c++"`, `"cpp"`, `"cxx"`, `"asm"` (optional, defaults to `"c"`) |
|
||||
| `standard` | `"c11"` | C standard (`c11`, `c17`, `c23`) |
|
||||
| `cxx_standard` | — | C++ standard (`c++17`, `c++20`, `c++23`) |
|
||||
| `compiler` | `"clang"` | Preferred compiler (optional, defaults to `"clang"`) |
|
||||
| `kind` | `"bin"` | `bin`, `staticlib`, `sharedlib`, `efi`, `elf`, `none`, `custom` |
|
||||
| `target` | host | Target triple for cross-compilation |
|
||||
| `platform` | `"native"` | `native`, `efi` |
|
||||
| `cflags` | `[]` | Additional C/C++/ASM flags |
|
||||
| `ldflags` | `[]` | Additional linker flags |
|
||||
| `filename` | `""` | Custom output file name |
|
||||
| `extension` | `""` | Custom file extension |
|
||||
| `roots` | `["src"]` | Source root directories |
|
||||
| `exclude` | `[]` | Exclude patterns |
|
||||
| `include` | `[]` | Additional include directories |
|
||||
| `src_disable` | `false` | Disable auto source discovery |
|
||||
| `inherit` | `false` | Inherit build from workspace root |
|
||||
| `clean` | `[]` | Glob patterns for custom clean paths |
|
||||
| `out_dir` | `""` | Custom output directory |
|
||||
| `workspace_only` | `false` | Workspace-only, not built standalone (no `language`/`compiler` required) |
|
||||
| `freestanding` | `false` | Compile in freestanding mode (`-ffreestanding` + `-nostdlib -static`) |
|
||||
| `opt_level` | — | Optimization level: `0`-`3`, `"s"`, `"z"` (derived from profile if omitted) |
|
||||
| `debug` | profile-based | Emit debug symbols (`-g`): `true` in debug, `false` in release |
|
||||
| `lto` | `false` | Link-time optimization (`-flto` for both compiler and linker) |
|
||||
| `strip` | `false` | Strip symbols from output (`-s` in ldflags) |
|
||||
| `warnings` | `[]` | Warning flags (e.g. `"all"`, `"extra"`, `"pedantic"`); engine adds `-Wall -Wextra` in debug if empty |
|
||||
| `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) |
|
||||
|
||||
Settings from raw config (not in typed struct):
|
||||
|
||||
* `pkg_config` — list of pkg-config packages
|
||||
* `ldscript` — linker script path
|
||||
* `build.steps` / `build.post_steps` — codegen steps
|
||||
|
||||
## Per-language overrides: `[build.c]`, `[build.cxx]`, `[build.asm]`
|
||||
|
||||
Each language can have its own table that overrides the flat `[build]` settings:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
compiler = "clang"
|
||||
standard = "c11"
|
||||
|
||||
[build.c]
|
||||
standard = "c23"
|
||||
compiler = "gcc"
|
||||
|
||||
[build.cxx]
|
||||
standard = "c++23"
|
||||
compiler = "g++"
|
||||
|
||||
[build.asm]
|
||||
compiler = "nasm"
|
||||
flags = ["-felf64"]
|
||||
```
|
||||
|
||||
The flat `[build]` acts as fallback; per-language tables take precedence for their language.
|
||||
|
||||
Example:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
language = "c++"
|
||||
standard = "c23"
|
||||
cxx_standard = "c++23"
|
||||
compiler = "clang"
|
||||
kind = "sharedlib"
|
||||
cflags = ["-Wall", "-Wextra"]
|
||||
opt_level = "z"
|
||||
lto = true
|
||||
strip = true
|
||||
panic = "abort"
|
||||
codegen-units = "2"
|
||||
```
|
||||
|
||||
## [toolchain]
|
||||
|
||||
```toml
|
||||
[toolchain]
|
||||
cc = "/usr/bin/clang"
|
||||
cxx = "/usr/bin/clang++"
|
||||
as = "/usr/bin/as"
|
||||
ar = "/usr/bin/ar"
|
||||
ld = "/usr/bin/ld.lld"
|
||||
```
|
||||
|
||||
Raw config also supports `uic`, `moc`, `rcc` for Qt codegen.
|
||||
|
||||
## [dependencies]
|
||||
|
||||
See [dependencies](/docs/reference/dependencies).
|
||||
|
||||
## [run]
|
||||
|
||||
```toml
|
||||
[run]
|
||||
cmd = "./target/{profile}/{name}"
|
||||
```
|
||||
|
||||
Substitutions:
|
||||
|
||||
* `{version}` — package version
|
||||
* `{version_major}`, `{version_minor}`, `{version_patch}`, `{version_suffix}`, `{version_suffix_dash}` — version parts
|
||||
* `{profile}` — debug / release
|
||||
* `{name}` — package name
|
||||
|
||||
Default `cmd` = `./target/{profile}/{name}` (macOS/Windows) or `./target/\<triple>/\<profile>/\<name>` (Linux).
|
||||
|
||||
## [workspace]
|
||||
|
||||
See [workspaces](/docs/reference/workspaces).
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_label: Dependencies
|
||||
---
|
||||
|
||||
# Dependencies
|
||||
|
||||
## Formats
|
||||
|
||||
The `[dependencies]` section supports three formats:
|
||||
|
||||
### String (registry)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
fmt = "10.1.1"
|
||||
spdlog = "1.12"
|
||||
catch2 = "3.4.0"
|
||||
```
|
||||
|
||||
The version string is used as-is for registry lookup.
|
||||
|
||||
### Table (git)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
fmt = { git = "https://github.com/fmtlib/fmt", tag = "10.1.1" }
|
||||
```
|
||||
|
||||
Fields: `git`, `branch`, `tag`, `rev`.
|
||||
|
||||
### Table (path)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
mylib = { path = "../mylib" }
|
||||
```
|
||||
|
||||
## Registry
|
||||
|
||||
DCR uses a package registry for dependency lookup by name.
|
||||
|
||||
```toml
|
||||
# ~/.dcr/config.toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
Registry priority: order in `config.toml`. The `DCR_INDEX_PATH` variable overrides the path to `index.json`.
|
||||
|
||||
## Git dependencies
|
||||
|
||||
Git dependencies are parsed and recorded in `dcr.lock`. DCR supports specifying branch/tag/rev for git sources:
|
||||
|
||||
* `branch` — switch to a branch
|
||||
* `tag` — switch to a tag
|
||||
* `rev` — switch to a specific commit
|
||||
* `features` — feature flags (parsed, but does not affect build)
|
||||
|
||||
## Path dependencies
|
||||
|
||||
Local paths. DCR automatically discovers include and lib directories from the neighbor's `dcr.toml`.
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
mylib = { path = "/abs/path/to/lib" }
|
||||
mylib = { path = "../relative/path" }
|
||||
```
|
||||
|
||||
## dcr.lock
|
||||
|
||||
Dependency lock file. Contains package names and sources.
|
||||
|
||||
Created during `dcr build` when registry dependencies are present. Not updated during `dcr add` — only on the next `dcr build`.
|
||||
|
||||
## Resolution process
|
||||
|
||||
1. Load all dependencies (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
|
||||
5. Collect `include_dirs`, `lib_dirs`, `libs` for the compiler
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_label: Environment variables
|
||||
---
|
||||
|
||||
# Environment Variables
|
||||
|
||||
## DCR_COMPILER
|
||||
|
||||
Overrides the compiler for all languages. **Highest priority.**
|
||||
|
||||
```bash
|
||||
export DCR_COMPILER=clang
|
||||
dcr build
|
||||
```
|
||||
|
||||
Compiler resolution priority:
|
||||
|
||||
1. `DCR_COMPILER` (env)
|
||||
2. `DCR_CC` / `DCR_CXX` / `DCR_AS` (env)
|
||||
3. `[toolchain]` (dcr.toml)
|
||||
4. `build.compiler` (dcr.toml)
|
||||
5. `PATH`
|
||||
|
||||
## DCR_CC / DCR_CXX / DCR_AS
|
||||
|
||||
Per-language override (lower priority than `DCR_COMPILER`, higher than `[toolchain]`).
|
||||
|
||||
```bash
|
||||
export DCR_CC=gcc-14
|
||||
export DCR_CXX=g++-14
|
||||
export DCR_AS=arm-linux-gnueabihf-as
|
||||
```
|
||||
|
||||
## DCR_LD / DCR_AR
|
||||
|
||||
Override linker and archiver.
|
||||
|
||||
```bash
|
||||
export DCR_LD=ld.lld
|
||||
export DCR_AR=llvm-ar
|
||||
```
|
||||
|
||||
## DCR_DEBUG
|
||||
|
||||
Enables debug mode — prints all compilation commands to stderr before execution.
|
||||
|
||||
```bash
|
||||
export DCR_DEBUG=1
|
||||
dcr build
|
||||
```
|
||||
|
||||
## DCR_INDEX_PATH
|
||||
|
||||
Overrides the path to the registry `index.json`.
|
||||
|
||||
```bash
|
||||
export DCR_INDEX_PATH=/custom/path/index.json
|
||||
```
|
||||
|
||||
Default: `~/.dcr/index.json`.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: Platform support
|
||||
---
|
||||
|
||||
# Platform Support
|
||||
|
||||
## Target Triples
|
||||
|
||||
DCR normalizes target triples. Short platform names are expanded to full triples.
|
||||
|
||||
### Linux
|
||||
|
||||
```
|
||||
target/<arch>-unknown-linux-gnu/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64` (host-detected).
|
||||
|
||||
Artifact type: ELF. Extensions: `.so` (sharedlib), `.a` (staticlib).
|
||||
|
||||
### macOS
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64` (host-detected).
|
||||
|
||||
Extensions: `.dylib` (sharedlib), `.a` (staticlib).
|
||||
|
||||
### Windows
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64`.
|
||||
|
||||
Extensions: `.exe` (bin), `.lib` (staticlib), `.dll` (sharedlib), `.efi` (UEFI).
|
||||
|
||||
### BSD
|
||||
|
||||
```
|
||||
target/<arch>-unknown-<os>/<profile>/
|
||||
```
|
||||
|
||||
Supported systems: `freebsd`, `openbsd`, `netbsd`, `dragonfly`.
|
||||
|
||||
## Host Detection
|
||||
|
||||
DCR uses `std::env::consts::ARCH` and `std::env::consts::OS` for host platform detection. Used as fallback when `target` is not specified.
|
||||
85
docs-crowdin-export/pl-PL/docs/reference/workspaces.mdx.mdx
Normal file
85
docs-crowdin-export/pl-PL/docs/reference/workspaces.mdx.mdx
Normal file
@@ -0,0 +1,85 @@
|
||||
---
|
||||
sidebar_label: Workspaces
|
||||
---
|
||||
|
||||
# Workspaces
|
||||
|
||||
Workspaces allow managing multiple packages in a single repository.
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[workspace.lib-core]
|
||||
path = "lib-core"
|
||||
|
||||
[workspace.lib-utils]
|
||||
path = "lib-utils"
|
||||
deps = ["lib-core"]
|
||||
|
||||
[workspace.app]
|
||||
path = "app"
|
||||
deps = ["lib-core", "lib-utils"]
|
||||
main = true
|
||||
```
|
||||
|
||||
### Member fields
|
||||
|
||||
| Field | Description |
|
||||
| ------ | ------------------------------------------------ |
|
||||
| `path` | Path to the package (relative to workspace root) |
|
||||
| `deps` | Dependencies on other members |
|
||||
| `main` | Mark as the main package |
|
||||
|
||||
## Topological sort
|
||||
|
||||
DCR automatically sorts packages by dependencies: package A is built before B if B depends on A.
|
||||
|
||||
Cyclic dependencies are detected and cause an error.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build # build all packages in dependency order
|
||||
dcr build --workspace app # build only app (dependencies built automatically)
|
||||
```
|
||||
|
||||
When building a workspace, member outputs (libraries) are automatically added to include/lib paths of dependent packages.
|
||||
|
||||
## Clean
|
||||
|
||||
```bash
|
||||
dcr clean # clean only root target/
|
||||
dcr clean --all # clean target/ of all packages
|
||||
```
|
||||
|
||||
## Inheritance
|
||||
|
||||
If a member has `inherit = true` in its `[build]` section, fields from the root `[build]` are merged into the member:
|
||||
|
||||
```toml
|
||||
# root dcr.toml
|
||||
[build]
|
||||
inherit = true
|
||||
language = "c"
|
||||
standard = "c17"
|
||||
|
||||
# member inherits language and standard
|
||||
```
|
||||
|
||||
## Workspace-only root (no build of its own)
|
||||
|
||||
A workspace root can set `workspace_only = true` — it won't be built itself, and doesn't need `language` or `compiler`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-workspace"
|
||||
version = "0.1.0"
|
||||
|
||||
[build]
|
||||
workspace_only = true
|
||||
kind = "bin"
|
||||
|
||||
[workspace]
|
||||
lib-core = { path = "lib-core" }
|
||||
app = { path = "app", deps = ["lib-core"] }
|
||||
```
|
||||
46
docs-crowdin-export/pl-PL/docs/self-update.mdx.mdx
Normal file
46
docs-crowdin-export/pl-PL/docs/self-update.mdx.mdx
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_label: Self Update
|
||||
---
|
||||
|
||||
# Self Update
|
||||
|
||||
## dcr --update
|
||||
|
||||
Automatic update to the latest version. Downloads a binary (not an archive) from GitHub Releases and replaces the current executable.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
## How it works
|
||||
|
||||
1. DCR detects the current platform and architecture
|
||||
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)
|
||||
5. Replaces the current executable via `self_replace`
|
||||
|
||||
## Asset naming
|
||||
|
||||
Pattern: `dcr-\<triple>` or `dcr-\<triple>.exe`
|
||||
|
||||
| Platform | Asset name |
|
||||
| -------------- | -------------------------------- |
|
||||
| Linux x86_64 | `dcr-x86_64-unknown-linux-gnu` |
|
||||
| macOS x86_64 | `dcr-x86_64-apple-darwin` |
|
||||
| macOS ARM64 | `dcr-aarch64-apple-darwin` |
|
||||
| Windows x86_64 | `dcr-x86_64-pc-windows-msvc.exe` |
|
||||
|
||||
## AUR
|
||||
|
||||
If DCR was installed via AUR, `--update` shows a warning:
|
||||
|
||||
```
|
||||
Update via package manager: yay/paru -Syu {package_name} or sudo pacman -Syu {package_name}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
* Cannot detect platform — error
|
||||
* Cannot fetch release — error with URL
|
||||
* No write permission — error (use `sudo` or manual install)
|
||||
45
docs-crowdin-export/pl-PL/docs/testing/running-tests.mdx.mdx
Normal file
45
docs-crowdin-export/pl-PL/docs/testing/running-tests.mdx.mdx
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_label: Running tests
|
||||
---
|
||||
|
||||
# Running Tests
|
||||
|
||||
## Execution
|
||||
|
||||
```bash
|
||||
dcr test
|
||||
```
|
||||
|
||||
Builds the project, then compiles and runs test files from `tests/`.
|
||||
|
||||
## Profiles
|
||||
|
||||
```bash
|
||||
dcr test # debug (default)
|
||||
dcr test --release # release
|
||||
dcr test --debug # explicit debug
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
```
|
||||
=====================
|
||||
Testsuite summary
|
||||
=====================
|
||||
TOTAL: 5
|
||||
PASS: 3
|
||||
SKIP: 1
|
||||
FAIL: 1
|
||||
=====================
|
||||
```
|
||||
|
||||
## Exit code
|
||||
|
||||
* 0 — all tests passed (FAIL = 0)
|
||||
* 1 — test failures or build error
|
||||
|
||||
## What gets built
|
||||
|
||||
* All `.c` files from `tests/` (`.cpp` not supported)
|
||||
* Include path: `tests/` (for `dcr_test.h`)
|
||||
* Linked with project if `package.type = "lib"` or `kind = "staticlib"`/`"sharedlib"`
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_label: Test framework (EXPECT, TEST, ...)
|
||||
---
|
||||
|
||||
# Test Framework
|
||||
|
||||
DCR has a built-in minimal test framework for C.
|
||||
|
||||
## Macros
|
||||
|
||||
### `EXPECT(expr)`
|
||||
|
||||
Asserts that an expression is true.
|
||||
|
||||
```c
|
||||
EXPECT(1 + 1 == 2);
|
||||
EXPECT(ptr != NULL);
|
||||
```
|
||||
|
||||
### `SKIP(reason)`
|
||||
|
||||
Skips a test with a message.
|
||||
|
||||
```c
|
||||
SKIP("not implemented on Windows");
|
||||
```
|
||||
|
||||
### `TEST(name)`
|
||||
|
||||
Defines a test.
|
||||
|
||||
```c
|
||||
TEST(addition) {
|
||||
EXPECT(1 + 1 == 2);
|
||||
EXPECT(2 + 2 == 4);
|
||||
}
|
||||
```
|
||||
|
||||
### `TEST_CASE(name)`
|
||||
|
||||
Registers a test case.
|
||||
|
||||
```c
|
||||
TEST_CASE(math) {
|
||||
EXPECT(1 + 1 == 2);
|
||||
}
|
||||
```
|
||||
|
||||
## Initialization
|
||||
|
||||
```bash
|
||||
dcr test --init
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `tests/dcr_test.h` — framework header (do not edit)
|
||||
* `tests/test.c` — template with example test
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
tests/
|
||||
├── dcr_test.h # framework (do not edit)
|
||||
├── test.c # main tests
|
||||
└── ... # additional .c test files
|
||||
```
|
||||
|
||||
Only `.c` files are compiled (`.cpp` is not supported).
|
||||
63
docs-crowdin-export/ru-RU/docs/README.mdx.mdx
Normal file
63
docs-crowdin-export/ru-RU/docs/README.mdx.mdx
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_label: Introduction
|
||||
---
|
||||
|
||||
# DCR — C/C++ Build Tool & Package Manager
|
||||
|
||||
<details>
|
||||
<summary>Quick reference</summary>
|
||||
|
||||
```bash
|
||||
# Installation
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
|
||||
# Create a project
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
|
||||
# Build and run
|
||||
dcr build
|
||||
dcr run
|
||||
|
||||
# Run tests
|
||||
dcr test
|
||||
|
||||
# Add a dependency
|
||||
dcr add fmt
|
||||
|
||||
# Generate IDE files
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Contents
|
||||
|
||||
| Section | Description |
|
||||
| ----------------------------------------------------- | --------------------------------------------- |
|
||||
| [Getting Started](/docs/getting-started/installation) | Installation and first steps |
|
||||
| [Commands](/docs/commands/project-commands) | All CLI commands |
|
||||
| [Reference](/docs/reference/dcr-toml) | Configuration, build, dependencies, platforms |
|
||||
| [Testing](/docs/testing/test-framework) | Built-in test framework |
|
||||
| [Recipes](/docs/recipes/cross-to-windows) | Common scenarios |
|
||||
| [IDE Integration](/docs/ide-integration) | VS Code, CLion, compile_commands.json |
|
||||
| [Self Update](/docs/self-update) | Auto-update |
|
||||
| [FAQ](/docs/faq) | Frequently asked questions |
|
||||
| [Changelog](/docs/changelog) | Version history |
|
||||
| [License](/docs/license) | DCR and vendored library licenses |
|
||||
| [Contributing](/docs/contributing) | DCR development |
|
||||
|
||||
## Features
|
||||
|
||||
* **Incremental builds** — mtime + `.d` headers + SHA256 fingerprint
|
||||
* **Parallel compilation** — thread::scope, atomic task queue
|
||||
* **4 backends** — gcc/clang, MSVC/clang-cl, GAS (ARM), NASM (x86)
|
||||
* **7 project kinds** — bin, staticlib, sharedlib, efi, elf, none, custom
|
||||
* **Cross-compilation** — short names and full triples
|
||||
* **Profiles** — debug / release with field overrides
|
||||
* **Workspaces** — multi-package projects with topological sort
|
||||
* **Registry + Git + Path** — three dependency mechanisms
|
||||
* **IDE generation** — VS Code, CLion, compile_commands.json, JSON metadata
|
||||
* **pkg-config** — automatic system library discovery
|
||||
* **Per-command `--help`** — `dcr build --help`, `dcr new --help`, etc.
|
||||
* **Man pages** — `man dcr`, `man dcr-build`, `man dcr-new`
|
||||
91
docs-crowdin-export/ru-RU/docs/changelog.mdx.mdx
Normal file
91
docs-crowdin-export/ru-RU/docs/changelog.mdx.mdx
Normal file
@@ -0,0 +1,91 @@
|
||||
---
|
||||
sidebar_label: Changelog
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
## 0.7.1 (2026-06-02)
|
||||
|
||||
### Added
|
||||
|
||||
* **`--help` for all commands** — `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-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,
|
||||
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.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`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.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **`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.
|
||||
|
||||
## 0.7.0 (2026-06-01)
|
||||
|
||||
### Added
|
||||
|
||||
* **OpenBSD and NetBSD target support** — full platform routing with dynamic target triples using `std::env::consts::ARCH` and `std::env::consts::OS`. Affects `build`, `run`, `clean` commands and the platform module.
|
||||
* **`src/platform/bsd.rs`** — new BSD platform module (shared by FreeBSD, OpenBSD, NetBSD) providing `bin_path`, `lib_path`, `elf_path`, `efi_path`, `shared_lib_path`.
|
||||
* **`build.out_dir` config option** — custom output directory that overrides the default `target/\<triple>/\<profile>` path for final artifacts. Supported in `build`, `run`, and config validation.
|
||||
* **`dcr fmt` command** — new CLI command that formats all C/C++ source files (`*.c`, `*.cpp`, `*.h`, `*.hpp`) in `src/` and `tests/` using `clang-format`.
|
||||
* **Incremental linking** — `needs_link()` in `common.rs` checks if any object file is newer than the linked output, skipping unnecessary relinking. Implemented for all backends (`unix_cc`, `msvc`, `gas`, `nasm`).
|
||||
* **`build.kind = "none"` and `"custom"`** — two new project kinds for special build scenarios that don't produce standard artifacts.
|
||||
* **`install_bsd.sh`** — POSIX-compliant installation script for BSD systems (FreeBSD, OpenBSD, NetBSD) with binary download and source build modes.
|
||||
* **Linux ARM64 support in `install.sh`** — added `Linux:aarch64|Linux:arm64` target detection for pre-built binary downloads.
|
||||
* **BSD OS detection in `install.sh`** — detects FreeBSD, OpenBSD, NetBSD and determines target triple.
|
||||
* **`rust-toolchain.toml`** — explicit toolchain pinning to `stable` channel.
|
||||
* **Integration tests** — `build_with_target_config` (verifies `build.target = "linux"`) and `build_with_out_dir` (validates custom output directory).
|
||||
* **`get_build_string_with_profile` made `pub`** — so `run.rs` can determine custom output directory configuration.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`build.target` semantics changed** — now strictly contains a target triple (e.g., `x86_64-unknown-linux-gnu`) or short name (`linux`, `macos`, `windows`). No longer used as custom output directory — this functionality moved to `build.out_dir`.
|
||||
* **`build.standard` made optional** — changed from `String` to `Option\<String>`. Validation only enforces non-empty for non-ASM languages. Skipped in `dcr.toml` output if empty.
|
||||
* **`dcr run` with `out_dir`** — now determines target directory respecting `build.out_dir` via `get_build_string_with_profile()` from `build.rs`.
|
||||
* **`collect_sources()` returns empty vector** instead of error when no sources are found, allowing `kind = "none"` or `kind = "custom"` projects with no source files.
|
||||
* **CI/CD release workflow refactored** — `git2` made target-specific (no vendored-openssl on Windows), Zig-based cross-compilation for non-x86_64 Linux targets, Arch Linux package version cleanup (dashes → dots), `gmake` symlink for NetBSD.
|
||||
* **README compatibility table** — FreeBSD, OpenBSD, NetBSD build/run status upgraded from "community/best-effort" to "officially supported".
|
||||
* **Documentation updated** — `build-section.md` describes new `build.target` and `build.out_dir` fields. `target-directory.md` rewritten to clarify the distinction.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **stdout/stderr not inherited in `dcr run`** — child process output was captured and manually printed, breaking interactive programs. Fixed by switching to `Command::status()`.
|
||||
* **Race condition in release CI** — matrix build jobs could upload assets to a release that didn't exist yet. Fixed by adding a dedicated `create-release` job.
|
||||
* **Release GHA — stable toolchain override** — fixed Rust toolchain override issues in CI.
|
||||
* **Arch Linux package version sanitization** — version strings with dashes (e.g., `0.7.0-dev`) are invalid for `pkgver`. Fixed by replacing dashes with dots.
|
||||
* **GPG permissions after Docker** — Docker operations changed GPG directory ownership. Fixed by running `chown` after Docker commands.
|
||||
* **RPM artifact paths** — RPM artifacts were placed in `rpm/x86_64/` instead of `fedora/x86_64/`. Fixed in Dexoron Packages Index workflow.
|
||||
* **JSON parsing reliability in `install.sh`** — added `jq` as primary parser with `python3` fallback for dev channel release lookup.
|
||||
|
||||
### Removed
|
||||
|
||||
* **`format_roots()` helper function** — removed from `common.rs`. Was only used by the old error handling path in `collect_sources()`.
|
||||
* **Per-distribution artifact download steps** — three separate `actions/download-artifact` steps replaced with unified `gh release download --clobber`.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
sidebar_label: Build commands (build, run, clean)
|
||||
---
|
||||
|
||||
# Build Commands
|
||||
|
||||
## `dcr build`
|
||||
|
||||
Builds the project according to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr build # debug profile
|
||||
dcr build --release # release build
|
||||
dcr build --debug # explicit debug
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
dcr build --force # full rebuild
|
||||
dcr build --clean # clean + build
|
||||
dcr build --verbose # show compilation commands
|
||||
dcr build --workspace pkg-a # build specific workspace package
|
||||
```
|
||||
|
||||
Artifacts: `target/\<triple>/\<profile>/\<binary-name>` (Linux with explicit target).
|
||||
|
||||
## `dcr run`
|
||||
|
||||
Builds (if sources are newer than artifacts) and runs the binary.
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
dcr run --release
|
||||
```
|
||||
|
||||
## `dcr clean`
|
||||
|
||||
Removes `target/` directory (or `target/\<target>/\<profile>`).
|
||||
|
||||
```bash
|
||||
dcr clean
|
||||
dcr clean --release # target/release/ only
|
||||
dcr clean --target windows # target/x86_64-pc-windows-msvc/
|
||||
dcr clean --all # clean all workspace packages
|
||||
```
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_label: Dependency commands (add, tree)
|
||||
---
|
||||
|
||||
# Dependency Commands
|
||||
|
||||
## `dcr add \<name> [source]`
|
||||
|
||||
Adds a dependency to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr add fmt # registry lookup
|
||||
dcr add mylib ../path/to/lib # path as source
|
||||
dcr add mylib path:./lib # explicit path prefix
|
||||
dcr add mylib git:https://github.com/user/repo # explicit git prefix
|
||||
dcr add mylib github:user/repo # GitHub shorthand
|
||||
dcr add mylib gitlab:user/repo # GitLab shorthand
|
||||
```
|
||||
|
||||
Source prefixes:
|
||||
|
||||
* `path:` — local path
|
||||
* `git:` — generic git URL
|
||||
* `github:` — expands to `https://github.com/\<user>/\<repo>`
|
||||
* `gitlab:` — expands to `https://gitlab.com/\<user>/\<repo>`
|
||||
* `http://` / `https://` / `git@` — full URL
|
||||
|
||||
Flags:
|
||||
|
||||
* `--branch \<name>` — git branch
|
||||
* `--tag \<name>` — git tag
|
||||
* `--rev \<hash>` — git commit
|
||||
|
||||
If source is omitted — DCR searches connected registries.
|
||||
|
||||
## `dcr tree`
|
||||
|
||||
Displays the project dependency tree.
|
||||
|
||||
```bash
|
||||
dcr tree
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```
|
||||
my-app v0.1.0
|
||||
├── fmt (registry)
|
||||
│ └── spdlog (registry)
|
||||
└── catch2 (registry)
|
||||
```
|
||||
|
||||
For path dependencies, recursively shows their own dependencies (from their `dcr.toml`).
|
||||
73
docs-crowdin-export/ru-RU/docs/commands/gen-commands.mdx.mdx
Normal file
73
docs-crowdin-export/ru-RU/docs/commands/gen-commands.mdx.mdx
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
sidebar_label: Gen commands (vscode, clion, ...)
|
||||
---
|
||||
|
||||
# Gen Commands
|
||||
|
||||
## `dcr gen \<target>`
|
||||
|
||||
Generates IDE integration files.
|
||||
|
||||
### vscode
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.vscode/tasks.json` — `build` task (dcr build)
|
||||
* `.vscode/launch.json` — debug launch configuration
|
||||
* `.vscode/settings.json` — C/C++ settings (clangd paths, includes)
|
||||
* `.vscode/extensions.json` — recommended extensions (vscode-clangd, vscode-lldb)
|
||||
|
||||
### clion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.idea/externalTools.xml` — external tools (build, run, clean, test)
|
||||
* `.idea/customTargets.xml` — custom build targets
|
||||
* `.idea/misc.xml` — C/C++ project settings
|
||||
* `.idea/runConfigurations/\<name>.xml` — per-binary run configurations
|
||||
|
||||
### compile-commands
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` — standard format for clangd, cpptools, static analyzers.
|
||||
|
||||
### project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"name": "my-app",
|
||||
"version": "0.1.0",
|
||||
"root": "/path/to/project",
|
||||
"profile": "debug",
|
||||
"language": "c",
|
||||
"standard": "c17",
|
||||
"cxx_standard": null,
|
||||
"compiler": "/usr/bin/clang",
|
||||
"kind": "bin",
|
||||
"sources": ["src/main.c"],
|
||||
"include_dirs": ["src"],
|
||||
"lib_dirs": [],
|
||||
"libs": [],
|
||||
"cflags": ["-std=c17", "-O0", "-g"],
|
||||
"ldflags": []
|
||||
}
|
||||
]
|
||||
```
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
sidebar_label: Project commands (new, init)
|
||||
---
|
||||
|
||||
# Project Commands
|
||||
|
||||
## `dcr new \<name>`
|
||||
|
||||
Creates a new project with a standard structure and `dcr.toml`. The `name` argument is required.
|
||||
|
||||
Only ASCII letters, digits, underscores `_` and hyphens `-` are allowed in the project name.
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
dcr new my-app --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
Generates:
|
||||
|
||||
* `dcr.toml` with basic fields
|
||||
* `src/main.c` with a `main` template
|
||||
|
||||
## `dcr init`
|
||||
|
||||
Initializes a DCR project in the current (empty) directory.
|
||||
|
||||
```bash
|
||||
dcr init
|
||||
dcr init --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
The project name is taken from the current directory name. The directory name must follow the same naming rules as `dcr new`.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_label: Quality commands (test, fmt)
|
||||
---
|
||||
|
||||
# Quality Commands
|
||||
|
||||
## `dcr test`
|
||||
|
||||
Runs tests.
|
||||
|
||||
```bash
|
||||
dcr test # debug profile
|
||||
dcr test --release # release profile
|
||||
dcr test --debug # explicit debug
|
||||
dcr test --help # detailed help
|
||||
```
|
||||
|
||||
Before first use, initialize tests:
|
||||
|
||||
```bash
|
||||
dcr test --init
|
||||
```
|
||||
|
||||
This creates `tests/dcr_test.h` (framework) and `tests/test.c` (template).
|
||||
|
||||
What `dcr test` does:
|
||||
|
||||
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
|
||||
6. Returns non-zero exit code on any FAIL
|
||||
|
||||
## `dcr fmt`
|
||||
|
||||
Formats C/C++ source files using `clang-format`.
|
||||
|
||||
```bash
|
||||
dcr fmt
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}` and `tests/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}`.
|
||||
|
||||
Uses `.clang-format` at the project root (if present), otherwise default clang-format style.
|
||||
|
||||
## `dcr lint`
|
||||
|
||||
Runs `clang-tidy` on C/C++ source files for static analysis.
|
||||
|
||||
```bash
|
||||
dcr lint # show diagnostics
|
||||
dcr lint --fix # apply fixes automatically
|
||||
dcr lint --help # detailed help
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc}` and `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.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: System commands (setup, --help, ...)
|
||||
---
|
||||
|
||||
# System Commands
|
||||
|
||||
## `dcr setup`
|
||||
|
||||
Shows configured registries from `~/.dcr/config.toml`.
|
||||
|
||||
```bash
|
||||
dcr setup
|
||||
```
|
||||
|
||||
If `~/.dcr/config.toml` is not found, DCR returns an error. Create it manually:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
## `dcr --help`
|
||||
|
||||
Shows help for all commands.
|
||||
|
||||
```bash
|
||||
dcr --help
|
||||
```
|
||||
|
||||
## `dcr --version`
|
||||
|
||||
Shows version and target triple.
|
||||
|
||||
```bash
|
||||
dcr --version # dcr 0.7.0 (x86_64-unknown-linux-gnu)
|
||||
```
|
||||
|
||||
## `dcr --update`
|
||||
|
||||
Self-update. Downloads the latest release binary from GitHub Releases and replaces the current one.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
Features:
|
||||
|
||||
* Auto-detects platform and architecture
|
||||
* Warns if installed via AUR (use package manager instead)
|
||||
* Works on Linux, macOS, Windows
|
||||
51
docs-crowdin-export/ru-RU/docs/contributing.mdx.mdx
Normal file
51
docs-crowdin-export/ru-RU/docs/contributing.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: Contributing
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dexoron/dcr
|
||||
cd dcr
|
||||
cargo build
|
||||
```
|
||||
|
||||
## Code style
|
||||
|
||||
All code must be formatted with `cargo fmt`:
|
||||
|
||||
```bash
|
||||
cargo fmt
|
||||
```
|
||||
|
||||
## Linting
|
||||
|
||||
```bash
|
||||
cargo clippy --all-targets -- -D warnings
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
cargo test --all-targets
|
||||
```
|
||||
|
||||
## PR process
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a branch: `git checkout -b feature/description`
|
||||
3. Make changes
|
||||
4. Run `cargo fmt && cargo clippy && cargo test`
|
||||
5. Open a Pull Request
|
||||
|
||||
## CI
|
||||
|
||||
CI runs:
|
||||
|
||||
* `cargo fmt --check`
|
||||
* `cargo clippy --all-targets -- -D warnings`
|
||||
* `cargo test --all-targets`
|
||||
* Build on Linux, macOS, Windows
|
||||
* Integration tests
|
||||
81
docs-crowdin-export/ru-RU/docs/faq.mdx.mdx
Normal file
81
docs-crowdin-export/ru-RU/docs/faq.mdx.mdx
Normal file
@@ -0,0 +1,81 @@
|
||||
---
|
||||
sidebar_label: FAQ
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
## Registry not found
|
||||
|
||||
```
|
||||
error: registry not found
|
||||
```
|
||||
|
||||
**Solution:** Make sure `~/.dcr/config.toml` exists:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
And check `DCR_INDEX_PATH`:
|
||||
|
||||
```bash
|
||||
echo $DCR_INDEX_PATH
|
||||
```
|
||||
|
||||
## Compiler not found
|
||||
|
||||
```
|
||||
error: compiler not found
|
||||
```
|
||||
|
||||
**Solution:** Ensure a compiler is installed and available in PATH.
|
||||
|
||||
```bash
|
||||
which gcc
|
||||
which clang
|
||||
```
|
||||
|
||||
Or specify explicitly via `[toolchain]` in `dcr.toml`.
|
||||
|
||||
## openssl-sys build failed
|
||||
|
||||
When building DCR from source:
|
||||
|
||||
```
|
||||
error: failed to run custom build command for openssl-sys
|
||||
```
|
||||
|
||||
**Solution:** Install OpenSSL development headers:
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt install libssl-dev
|
||||
|
||||
# Fedora
|
||||
sudo dnf install openssl-devel
|
||||
|
||||
# macOS
|
||||
brew install openssl
|
||||
```
|
||||
|
||||
## Ctrl+C during build
|
||||
|
||||
DCR handles SIGINT: interrupts the current compilation and exits with non-zero code.
|
||||
|
||||
## How to create a library?
|
||||
|
||||
See [Library Recipe](/docs/recipes/library-project).
|
||||
|
||||
## How to cross-compile to Windows?
|
||||
|
||||
See [Cross-Compile Recipe](/docs/recipes/cross-to-windows).
|
||||
|
||||
## How to create a multi-package project?
|
||||
|
||||
See [Workspace Recipe](/docs/recipes/multi-package-workspace).
|
||||
|
||||
## Lock file
|
||||
|
||||
`dcr.lock` is created during builds (`dcr build`) when registry dependencies are present. To force an update — delete `dcr.lock` and run `dcr build`.
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
sidebar_label: First steps
|
||||
---
|
||||
|
||||
# First Steps
|
||||
|
||||
## Create a project
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
```
|
||||
|
||||
Structure:
|
||||
|
||||
```
|
||||
my-app/
|
||||
├── dcr.toml
|
||||
└── src/
|
||||
└── main.c
|
||||
```
|
||||
|
||||
`dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build
|
||||
```
|
||||
|
||||
Output — `target/\<triple>/debug/my-app` (Linux) or `target/debug/my-app.exe` (Windows).
|
||||
|
||||
Build profiles:
|
||||
|
||||
```bash
|
||||
dcr build --release # release build
|
||||
dcr build --debug # debug (default)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
```
|
||||
|
||||
Builds (if needed) and runs the binary.
|
||||
|
||||
## First test
|
||||
|
||||
```bash
|
||||
dcr test --init # create test template
|
||||
dcr test # run tests
|
||||
```
|
||||
|
||||
## Formatting
|
||||
|
||||
```bash
|
||||
dcr fmt # clang-format with .clang-format
|
||||
```
|
||||
@@ -0,0 +1,109 @@
|
||||
---
|
||||
sidebar_label: Installation
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
## Linux (Dexoron Packages)
|
||||
|
||||
Configure your package manager at https://pkg.dexoron.su and install:
|
||||
|
||||
**Arch Linux**
|
||||
|
||||
```sh
|
||||
sudo pacman -Sy dcr
|
||||
```
|
||||
|
||||
**Debian/Ubuntu**
|
||||
|
||||
```sh
|
||||
sudo apt update && sudo apt install dcr
|
||||
```
|
||||
|
||||
**Fedora/RHEL**
|
||||
|
||||
```sh
|
||||
sudo dnf install dcr
|
||||
```
|
||||
|
||||
## Arch Linux (AUR)
|
||||
|
||||
```sh
|
||||
yay -S dcr
|
||||
```
|
||||
|
||||
## macOS / Linux (Homebrew)
|
||||
|
||||
```sh
|
||||
brew tap dexoron/dexoron
|
||||
brew install dcr
|
||||
```
|
||||
|
||||
## Snap (Linux)
|
||||
|
||||
```sh
|
||||
sudo snap install dcrup
|
||||
```
|
||||
|
||||
## Nix (flake)
|
||||
|
||||
```sh
|
||||
nix run github:dexoron/dcr
|
||||
# or install to profile:
|
||||
nix profile install github:dexoron/dcr
|
||||
```
|
||||
|
||||
## Cargo (crates.io)
|
||||
|
||||
```sh
|
||||
cargo install dcr
|
||||
```
|
||||
|
||||
## Linux / macOS (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
```
|
||||
|
||||
## BSD (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install_bsd.sh | sh
|
||||
```
|
||||
|
||||
## Windows (PowerShell)
|
||||
|
||||
```powershell
|
||||
irm https://dcr.dexoron.su/install.ps1 | iex
|
||||
```
|
||||
|
||||
## From source
|
||||
|
||||
```sh
|
||||
git clone https://github.com/dexoron/dcr.git
|
||||
cd dcr && cargo build --release
|
||||
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
||||
```
|
||||
|
||||
## Post-install
|
||||
|
||||
Verify the installation:
|
||||
|
||||
```bash
|
||||
dcr --version
|
||||
```
|
||||
|
||||
Man pages are available after installation:
|
||||
|
||||
```bash
|
||||
man dcr
|
||||
man dcr-build
|
||||
```
|
||||
|
||||
To use the registry, create `~/.dcr/config.toml`:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
51
docs-crowdin-export/ru-RU/docs/ide-integration.mdx.mdx
Normal file
51
docs-crowdin-export/ru-RU/docs/ide-integration.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: IDE Integration
|
||||
---
|
||||
|
||||
# IDE Integration
|
||||
|
||||
## VS Code
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Generates in `.vscode/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ----------------- | -------------------------------------------- |
|
||||
| `tasks.json` | `build` task (dcr build) |
|
||||
| `launch.json` | Debug launch configuration |
|
||||
| `settings.json` | clangd/IntelliSense: include paths, standard |
|
||||
| `extensions.json` | Recommends vscode-clangd, vscode-lldb |
|
||||
|
||||
## CLion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Generates in `.idea/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ------------------------------------------------ | ----------------------------------------- |
|
||||
| `externalTools.xml` | Build, Run, Clean, Test as external tools |
|
||||
| `customTargets.xml` | Custom build targets |
|
||||
| `misc.xml` | C/C++ project settings |
|
||||
| `runConfigurations/\<name>.xml` | Per-binary run configurations |
|
||||
|
||||
## compile_commands.json
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` at project root. Standard format for clangd, C/C++ IntelliSense, static analyzers.
|
||||
|
||||
## project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata (see [gen-commands](/docs/commands/gen-commands)).
|
||||
33
docs-crowdin-export/ru-RU/docs/license.mdx.mdx
Normal file
33
docs-crowdin-export/ru-RU/docs/license.mdx.mdx
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
sidebar_label: License
|
||||
---
|
||||
|
||||
# License
|
||||
|
||||
## DCR
|
||||
|
||||
DCR itself is [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) licensed.
|
||||
|
||||
> **Note:** DCR is a build tool, not a library. The GPL applies only to DCR's own source code. Projects built with DCR are not subject to DCR's license — their licensing is determined solely by their own code and dependencies.
|
||||
|
||||
## Rust dependencies
|
||||
|
||||
DCR is written in Rust. The following notable Rust crates are statically linked:
|
||||
|
||||
| Crate | License |
|
||||
| ------------------------------------------------------- | ----------------- |
|
||||
| [`ureq`](https://crates.io/crates/ureq) | MIT OR Apache-2.0 |
|
||||
| [`serde`](https://crates.io/crates/serde) | MIT OR Apache-2.0 |
|
||||
| [`toml`](https://crates.io/crates/toml) | MIT OR Apache-2.0 |
|
||||
| [`toml_edit`](https://crates.io/crates/toml_edit) | MIT OR Apache-2.0 |
|
||||
| [`serde_json`](https://crates.io/crates/serde_json) | MIT OR Apache-2.0 |
|
||||
| [`sha2`](https://crates.io/crates/sha2) | MIT OR Apache-2.0 |
|
||||
| [`glob`](https://crates.io/crates/glob) | MIT OR Apache-2.0 |
|
||||
| [`self-replace`](https://crates.io/crates/self-replace) | MIT OR Apache-2.0 |
|
||||
| [`ctrlc`](https://crates.io/crates/ctrlc) | MIT OR Apache-2.0 |
|
||||
|
||||
Full dependency tree is available in [`Cargo.lock`](https://github.com/dexoron/dcr/blob/main/Cargo.lock). The overwhelming majority are dual-licensed under MIT OR Apache-2.0.
|
||||
|
||||
## Additional credits
|
||||
|
||||
* DCR's CLI design and project model are inspired by [Cargo](https://doc.rust-lang.org/cargo/).
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_label: Cross-compile to Windows
|
||||
---
|
||||
|
||||
# Cross-Compile to Windows from Linux
|
||||
|
||||
Building a Windows binary on Linux using mingw-w64.
|
||||
|
||||
## Install toolchain
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt install mingw-w64
|
||||
|
||||
# Fedora
|
||||
sudo dnf install mingw64-gcc mingw64-binutils
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
target = "x86_64-pc-windows-gnu" # explicit mingw, not msvc
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build --target x86_64-pc-windows-gnu --release
|
||||
```
|
||||
|
||||
Artifact: `target/x86_64-pc-windows-gnu/release/my-app.exe`.
|
||||
|
||||
## Custom toolchain
|
||||
|
||||
```toml
|
||||
[toolchain]
|
||||
cc = "x86_64-w64-mingw32-gcc"
|
||||
cxx = "x86_64-w64-mingw32-g++"
|
||||
```
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_label: Library project
|
||||
---
|
||||
|
||||
# Library Project
|
||||
|
||||
Creating a static library and using it in another project.
|
||||
|
||||
## Step 1: Create the library
|
||||
|
||||
```bash
|
||||
dcr new my-lib
|
||||
cd my-lib
|
||||
```
|
||||
|
||||
`dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-lib"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`src/my_lib.h`:
|
||||
|
||||
```c
|
||||
#ifndef MY_LIB_H
|
||||
#define MY_LIB_H
|
||||
int add(int a, int b);
|
||||
#endif
|
||||
```
|
||||
|
||||
`src/my_lib.c`:
|
||||
|
||||
```c
|
||||
#include "my_lib.h"
|
||||
int add(int a, int b) { return a + b; }
|
||||
```
|
||||
|
||||
## Step 2: Build
|
||||
|
||||
```bash
|
||||
dcr build --release
|
||||
```
|
||||
|
||||
Artifacts:
|
||||
|
||||
* `target/\<triple>/release/libmy-lib.a` (Linux)
|
||||
* `target/release/my-lib.lib` (Windows)
|
||||
* `target/include/` — header files
|
||||
|
||||
## Step 3: Use in another project
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
dcr add my-lib ../my-lib
|
||||
```
|
||||
|
||||
Automatically:
|
||||
|
||||
* Adds include path to `target/include/` of the library
|
||||
* Adds lib path to `target/\<triple>/release/`
|
||||
* Links `libmy-lib.a` / `my-lib.lib`
|
||||
@@ -0,0 +1,103 @@
|
||||
---
|
||||
sidebar_label: Multi-package workspace
|
||||
---
|
||||
|
||||
# Multi-Package Workspace
|
||||
|
||||
A project with three packages: two libraries and a binary.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
workspace/
|
||||
├── dcr.toml # root workspace
|
||||
├── lib-core/
|
||||
│ ├── dcr.toml
|
||||
│ └── src/core.c
|
||||
├── lib-utils/
|
||||
│ ├── dcr.toml
|
||||
│ └── src/utils.c
|
||||
└── app/
|
||||
├── dcr.toml
|
||||
└── src/main.c
|
||||
```
|
||||
|
||||
## Root dcr.toml
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-workspace"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
inherit = true
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
workspace_only = true
|
||||
|
||||
[workspace.lib-core]
|
||||
path = "lib-core"
|
||||
|
||||
[workspace.lib-utils]
|
||||
path = "lib-utils"
|
||||
deps = ["lib-core"]
|
||||
|
||||
[workspace.app]
|
||||
path = "app"
|
||||
deps = ["lib-core", "lib-utils"]
|
||||
main = true
|
||||
```
|
||||
|
||||
## Packages
|
||||
|
||||
`lib-core/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "lib-core"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`lib-utils/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "lib-utils"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "staticlib"
|
||||
```
|
||||
|
||||
`app/dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
kind = "bin"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
cd workspace
|
||||
dcr build # builds everything in correct order
|
||||
dcr build --workspace app # only app (lib-core and lib-utils built as deps)
|
||||
dcr run # builds and runs main package
|
||||
```
|
||||
|
||||
Build order (topological sort):
|
||||
|
||||
1. `lib-core`
|
||||
2. `lib-utils` (depends on lib-core)
|
||||
3. `app` (depends on lib-core, lib-utils)
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_label: Build profiles
|
||||
---
|
||||
|
||||
# Build Profiles
|
||||
|
||||
Profiles allow overriding `[build]` fields for specific build modes.
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c17"
|
||||
cflags = ["-Wall"]
|
||||
|
||||
[build.debug]
|
||||
cflags = ["-O0", "-g"]
|
||||
|
||||
[build.release]
|
||||
cflags = ["-O3", "-DNDEBUG"]
|
||||
```
|
||||
|
||||
## Merge rules
|
||||
|
||||
Fields from `[build.\<profile>]` are merged on top of `[build]`:
|
||||
|
||||
* **Scalar fields** (strings, numbers, bools) — replaced
|
||||
* **Arrays** (`cflags`, `ldflags`, ...) — **appended** (extend the `[build]` array)
|
||||
|
||||
Set `inherit = false` to disable array inheritance (only profile's own arrays are used).
|
||||
|
||||
## Built-in profiles
|
||||
|
||||
The default flags for each profile are composed from three config fields:
|
||||
|
||||
| Field | debug default | release default |
|
||||
| ----------- | ------------------ | --------------- |
|
||||
| `opt_level` | `"0"` | `"3"` |
|
||||
| `debug` | `true` | `false` |
|
||||
| `warnings` | `["all", "extra"]` | `[]` |
|
||||
|
||||
Which produce the equivalent compiler flags:
|
||||
|
||||
| Profile | Effective flags |
|
||||
| --------- | ---------------------------------------------------------- |
|
||||
| `debug` | `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG` |
|
||||
| `release` | `-O3 -DNDEBUG` |
|
||||
|
||||
Additional build options can be toggled per-profile:
|
||||
|
||||
```toml
|
||||
[build.release]
|
||||
opt_level = "z"
|
||||
lto = true
|
||||
strip = true
|
||||
panic = "abort"
|
||||
codegen-units = "1"
|
||||
|
||||
[build.debug]
|
||||
opt_level = "1"
|
||||
debug = false
|
||||
warnings = ["all", "error"]
|
||||
```
|
||||
|
||||
## Target-specific profiles
|
||||
|
||||
```toml
|
||||
[build.linux]
|
||||
cflags = ["-DLINUX"]
|
||||
|
||||
[build.windows.debug]
|
||||
cflags = ["-DWIN32", "-O0", "-g"]
|
||||
```
|
||||
|
||||
Application order (highest priority first):
|
||||
|
||||
1. `[build.\<target>.\<profile>]`
|
||||
2. `[build.\<profile>.\<target>]`
|
||||
3. `[build.\<target>]`
|
||||
4. `[build.\<profile>]`
|
||||
5. `[build]`
|
||||
131
docs-crowdin-export/ru-RU/docs/reference/build-system.mdx.mdx
Normal file
131
docs-crowdin-export/ru-RU/docs/reference/build-system.mdx.mdx
Normal file
@@ -0,0 +1,131 @@
|
||||
---
|
||||
sidebar_label: Build system
|
||||
---
|
||||
|
||||
# Build System
|
||||
|
||||
## Compiler Backends
|
||||
|
||||
DCR supports 7 compilation backends. Selection is automatic based on file extension and `build.compiler` value.
|
||||
|
||||
| Backend | Files | When used |
|
||||
| --------- | --------------------------------- | ------------------------------------- |
|
||||
| `unix_cc` | `.c`, `.cpp`, `.cxx`, `.cc`, `.S` | gcc/clang on Linux/macOS/BSD |
|
||||
| `msvc` | `.c`, `.cpp`, `.cxx`, `.cc` | Windows (cl, clang-cl) |
|
||||
| `gas` | `.s` | ARM/ARM64 assembler (no preprocessor) |
|
||||
| `nasm` | `.asm`, `.s` | x86/x86_64 NASM assembler |
|
||||
| `masm` | `.asm` | MASM (ml/ml64) on Windows |
|
||||
| `fasm` | `.asm`, `.fasm` | Flat Assembler |
|
||||
| `llvm_ir` | `.ll` | LLVM IR via `llc -filetype=obj` |
|
||||
|
||||
## Qt Support
|
||||
|
||||
DCR provides native Qt support for automatic meta-object handling (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.
|
||||
|
||||
```toml
|
||||
[build]
|
||||
qt = true
|
||||
```
|
||||
|
||||
*Note: Requires `qt6` modules (Core, Widgets, Gui, Svg) installed via `pkg-config`.*
|
||||
|
||||
Advanced customization is still possible via `build.steps` if special handling is needed:
|
||||
|
||||
```toml
|
||||
[build.steps]
|
||||
moc = "moc {in} -o {out}"
|
||||
```
|
||||
|
||||
### Unix CC
|
||||
|
||||
* Compiler resolved via `resolve_compiler()`: `DCR_COMPILER` > `DCR_CC` > `[toolchain]` > `build.compiler` > `PATH`
|
||||
* Supports `.d` files for header dependency tracking
|
||||
* Flags: `-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`
|
||||
|
||||
### MSVC
|
||||
|
||||
* Supports cl.exe and clang-cl.exe
|
||||
* Flags: `/std:`, `/Fo:`, `/Fe:`, `/I`, `/link`
|
||||
|
||||
### GAS / NASM / MASM / FASM / LLVM-IR
|
||||
|
||||
* GAS: `-I`, `-c -o`, `--defsym`
|
||||
* NASM: `-I`, `-o`, `-D`, `-f` (format: win64/elf64/macho64/macho32/elf32)
|
||||
* MASM: `/nologo /c /Fo\<obj> <source>`
|
||||
* FASM: `<source> \<output>` (output path is the object file)
|
||||
* LLVM IR: `-filetype=obj <source> -o \<output>`
|
||||
|
||||
## Incremental Builds
|
||||
|
||||
Three levels of incrementality:
|
||||
|
||||
1. **mtime** — if output is newer than all inputs, skip
|
||||
2. **`.d` files** — header change tracking (including transitive)
|
||||
3. **SHA256 fingerprint** — recompile if compiler flags changed (stored in `.dcr_fingerprint`)
|
||||
|
||||
## Parallel Compilation
|
||||
|
||||
* `thread::scope` for thread pool
|
||||
* Atomic task queue (`AtomicU64`)
|
||||
* Mutex on stdout (`OUTPUT_MUTEX`)
|
||||
* Thread count = `available_parallelism()`, capped by `build.codegen-units` if set
|
||||
|
||||
## Build Kinds
|
||||
|
||||
| Kind | Type | Path (Linux example) |
|
||||
| ----------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `bin` | Executable | `target/\<triple>/\<profile>/\<name>` (.exe on Windows) |
|
||||
| `staticlib` | Static library | `target/\<triple>/\<profile>/lib\<name>.a` (.lib) |
|
||||
| `sharedlib` | Dynamic library | `target/\<triple>/\<profile>/lib\<name>.so` (.dll/.dylib) |
|
||||
| `efi` | UEFI application | `target/\<triple>/\<profile>/\<name>.efi` |
|
||||
| `elf` | ELF without stdlib | `target/\<triple>/\<profile>/\<name>` |
|
||||
| `none` | Compile only, no link | — |
|
||||
| `custom` | Full filename+extension control | `target/\<triple>/\<profile>/\<filename>.\<extension>` |
|
||||
|
||||
## Build Steps
|
||||
|
||||
DCR supports pre-build and post-build steps:
|
||||
|
||||
* `build.steps` — commands before compilation
|
||||
* `build.post_steps` — commands after compilation
|
||||
|
||||
Substitutions: `{stem}`, `{in}`, `{out}`, `{profile}`, `{version}`, `{name}`.
|
||||
|
||||
Example Qt codegen via build steps:
|
||||
|
||||
```toml
|
||||
[build.steps]
|
||||
moc = "moc {in} -o {out}"
|
||||
```
|
||||
|
||||
## pkg-config
|
||||
|
||||
Automatic lookup (read from raw config):
|
||||
|
||||
```toml
|
||||
[build]
|
||||
pkg_config = ["sdl2", "gl"]
|
||||
```
|
||||
|
||||
DCR runs `pkg-config --cflags sdl2 gl` and `pkg-config --libs sdl2 gl` and adds results to compiler/linker flags.
|
||||
|
||||
## Variable Substitution
|
||||
|
||||
Supported variables:
|
||||
|
||||
| Variable | Description |
|
||||
| ----------------------- | ---------------------------- |
|
||||
| `{version}` | Package version |
|
||||
| `{version_major}` | Major version part |
|
||||
| `{version_minor}` | Minor version part |
|
||||
| `{version_patch}` | Patch version |
|
||||
| `{version_suffix}` | Suffix (e.g., `-rc1`) |
|
||||
| `{version_suffix_dash}` | Suffix with dash |
|
||||
| `{profile}` | Profile name (debug/release) |
|
||||
| `{name}` | Package name |
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_label: Cross-compilation
|
||||
---
|
||||
|
||||
# Cross-Compilation
|
||||
|
||||
## Short Names
|
||||
|
||||
DCR supports short platform names:
|
||||
|
||||
| Short Name | Full Triple |
|
||||
| ---------- | -------------------------- |
|
||||
| `linux` | `x86_64-unknown-linux-gnu` |
|
||||
| `macos` | `x86_64-apple-darwin` |
|
||||
| `windows` | `x86_64-pc-windows-msvc` |
|
||||
|
||||
```bash
|
||||
dcr build --target windows
|
||||
```
|
||||
|
||||
## Full Triples
|
||||
|
||||
```bash
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
dcr build --target x86_64-pc-windows-gnu # mingw
|
||||
dcr build --target armv7-unknown-linux-gnueabihf
|
||||
```
|
||||
|
||||
## clang --target
|
||||
|
||||
When using clang, DCR injects `--target=\<triple>` into CFLAGS.
|
||||
|
||||
```toml
|
||||
[build]
|
||||
compiler = "clang"
|
||||
target = "aarch64-unknown-linux-gnu"
|
||||
# Auto: cflags += ["--target=aarch64-unknown-linux-gnu"]
|
||||
```
|
||||
|
||||
## Bare-Metal / Freestanding
|
||||
|
||||
For targets containing `none`, `-elf`, `eabi`, or `baremetal`, DCR automatically:
|
||||
|
||||
1. **Disables default flags** — no system include paths, no `-l` libc
|
||||
2. **Injects `-ffreestanding`** at compile time and `-nostdlib -static` at link time
|
||||
|
||||
You can also enable freestanding mode explicitly:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
freestanding = true
|
||||
```
|
||||
|
||||
```bash
|
||||
dcr build --target aarch64-none-elf
|
||||
```
|
||||
|
||||
## Target Directory
|
||||
|
||||
On Linux with explicit target:
|
||||
|
||||
```
|
||||
target/<triple>/<profile>/
|
||||
```
|
||||
|
||||
On macOS/Windows or without target:
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
176
docs-crowdin-export/ru-RU/docs/reference/dcr-toml.mdx.mdx
Normal file
176
docs-crowdin-export/ru-RU/docs/reference/dcr-toml.mdx.mdx
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
sidebar_label: dcr.toml overview
|
||||
---
|
||||
|
||||
# dcr.toml
|
||||
|
||||
Main project configuration file. Located at the project root.
|
||||
|
||||
## Structure
|
||||
|
||||
```toml
|
||||
[package]
|
||||
# required fields
|
||||
|
||||
[build]
|
||||
# build settings
|
||||
|
||||
[build.debug] # optional: debug override
|
||||
[build.release] # optional: release override
|
||||
|
||||
[build.linux] # optional: Linux override
|
||||
[build.windows] # optional: Windows override
|
||||
[build.windows.debug] # target + profile combination
|
||||
|
||||
[toolchain]
|
||||
# compiler/linker paths
|
||||
|
||||
[dependencies]
|
||||
# project dependencies
|
||||
|
||||
[workspace]
|
||||
# multi-package configuration
|
||||
|
||||
[run]
|
||||
# run settings
|
||||
```
|
||||
|
||||
## [package]
|
||||
|
||||
| Field | Required | Description |
|
||||
| --------- | -------- | ------------------------------------------- |
|
||||
| `name` | yes | Project name |
|
||||
| `version` | yes | Semantic version |
|
||||
| `type` | no | `app`, `lib`, `none` (defaults to `"none"`) |
|
||||
| `license` | no | SPDX license identifier |
|
||||
| `author` | no | Author |
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "app"
|
||||
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`.
|
||||
|
||||
| Field | Default | Description |
|
||||
| ---------------- | ------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `language` | `"c"` | `"c"`, `"c++"`, `"cpp"`, `"cxx"`, `"asm"` (optional, defaults to `"c"`) |
|
||||
| `standard` | `"c11"` | C standard (`c11`, `c17`, `c23`) |
|
||||
| `cxx_standard` | — | C++ standard (`c++17`, `c++20`, `c++23`) |
|
||||
| `compiler` | `"clang"` | Preferred compiler (optional, defaults to `"clang"`) |
|
||||
| `kind` | `"bin"` | `bin`, `staticlib`, `sharedlib`, `efi`, `elf`, `none`, `custom` |
|
||||
| `target` | host | Target triple for cross-compilation |
|
||||
| `platform` | `"native"` | `native`, `efi` |
|
||||
| `cflags` | `[]` | Additional C/C++/ASM flags |
|
||||
| `ldflags` | `[]` | Additional linker flags |
|
||||
| `filename` | `""` | Custom output file name |
|
||||
| `extension` | `""` | Custom file extension |
|
||||
| `roots` | `["src"]` | Source root directories |
|
||||
| `exclude` | `[]` | Exclude patterns |
|
||||
| `include` | `[]` | Additional include directories |
|
||||
| `src_disable` | `false` | Disable auto source discovery |
|
||||
| `inherit` | `false` | Inherit build from workspace root |
|
||||
| `clean` | `[]` | Glob patterns for custom clean paths |
|
||||
| `out_dir` | `""` | Custom output directory |
|
||||
| `workspace_only` | `false` | Workspace-only, not built standalone (no `language`/`compiler` required) |
|
||||
| `freestanding` | `false` | Compile in freestanding mode (`-ffreestanding` + `-nostdlib -static`) |
|
||||
| `opt_level` | — | Optimization level: `0`-`3`, `"s"`, `"z"` (derived from profile if omitted) |
|
||||
| `debug` | profile-based | Emit debug symbols (`-g`): `true` in debug, `false` in release |
|
||||
| `lto` | `false` | Link-time optimization (`-flto` for both compiler and linker) |
|
||||
| `strip` | `false` | Strip symbols from output (`-s` in ldflags) |
|
||||
| `warnings` | `[]` | Warning flags (e.g. `"all"`, `"extra"`, `"pedantic"`); engine adds `-Wall -Wextra` in debug if empty |
|
||||
| `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) |
|
||||
|
||||
Settings from raw config (not in typed struct):
|
||||
|
||||
* `pkg_config` — list of pkg-config packages
|
||||
* `ldscript` — linker script path
|
||||
* `build.steps` / `build.post_steps` — codegen steps
|
||||
|
||||
## Per-language overrides: `[build.c]`, `[build.cxx]`, `[build.asm]`
|
||||
|
||||
Each language can have its own table that overrides the flat `[build]` settings:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
compiler = "clang"
|
||||
standard = "c11"
|
||||
|
||||
[build.c]
|
||||
standard = "c23"
|
||||
compiler = "gcc"
|
||||
|
||||
[build.cxx]
|
||||
standard = "c++23"
|
||||
compiler = "g++"
|
||||
|
||||
[build.asm]
|
||||
compiler = "nasm"
|
||||
flags = ["-felf64"]
|
||||
```
|
||||
|
||||
The flat `[build]` acts as fallback; per-language tables take precedence for their language.
|
||||
|
||||
Example:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
language = "c++"
|
||||
standard = "c23"
|
||||
cxx_standard = "c++23"
|
||||
compiler = "clang"
|
||||
kind = "sharedlib"
|
||||
cflags = ["-Wall", "-Wextra"]
|
||||
opt_level = "z"
|
||||
lto = true
|
||||
strip = true
|
||||
panic = "abort"
|
||||
codegen-units = "2"
|
||||
```
|
||||
|
||||
## [toolchain]
|
||||
|
||||
```toml
|
||||
[toolchain]
|
||||
cc = "/usr/bin/clang"
|
||||
cxx = "/usr/bin/clang++"
|
||||
as = "/usr/bin/as"
|
||||
ar = "/usr/bin/ar"
|
||||
ld = "/usr/bin/ld.lld"
|
||||
```
|
||||
|
||||
Raw config also supports `uic`, `moc`, `rcc` for Qt codegen.
|
||||
|
||||
## [dependencies]
|
||||
|
||||
See [dependencies](/docs/reference/dependencies).
|
||||
|
||||
## [run]
|
||||
|
||||
```toml
|
||||
[run]
|
||||
cmd = "./target/{profile}/{name}"
|
||||
```
|
||||
|
||||
Substitutions:
|
||||
|
||||
* `{version}` — package version
|
||||
* `{version_major}`, `{version_minor}`, `{version_patch}`, `{version_suffix}`, `{version_suffix_dash}` — version parts
|
||||
* `{profile}` — debug / release
|
||||
* `{name}` — package name
|
||||
|
||||
Default `cmd` = `./target/{profile}/{name}` (macOS/Windows) or `./target/\<triple>/\<profile>/\<name>` (Linux).
|
||||
|
||||
## [workspace]
|
||||
|
||||
See [workspaces](/docs/reference/workspaces).
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_label: Dependencies
|
||||
---
|
||||
|
||||
# Dependencies
|
||||
|
||||
## Formats
|
||||
|
||||
The `[dependencies]` section supports three formats:
|
||||
|
||||
### String (registry)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
fmt = "10.1.1"
|
||||
spdlog = "1.12"
|
||||
catch2 = "3.4.0"
|
||||
```
|
||||
|
||||
The version string is used as-is for registry lookup.
|
||||
|
||||
### Table (git)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
fmt = { git = "https://github.com/fmtlib/fmt", tag = "10.1.1" }
|
||||
```
|
||||
|
||||
Fields: `git`, `branch`, `tag`, `rev`.
|
||||
|
||||
### Table (path)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
mylib = { path = "../mylib" }
|
||||
```
|
||||
|
||||
## Registry
|
||||
|
||||
DCR uses a package registry for dependency lookup by name.
|
||||
|
||||
```toml
|
||||
# ~/.dcr/config.toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
Registry priority: order in `config.toml`. The `DCR_INDEX_PATH` variable overrides the path to `index.json`.
|
||||
|
||||
## Git dependencies
|
||||
|
||||
Git dependencies are parsed and recorded in `dcr.lock`. DCR supports specifying branch/tag/rev for git sources:
|
||||
|
||||
* `branch` — switch to a branch
|
||||
* `tag` — switch to a tag
|
||||
* `rev` — switch to a specific commit
|
||||
* `features` — feature flags (parsed, but does not affect build)
|
||||
|
||||
## Path dependencies
|
||||
|
||||
Local paths. DCR automatically discovers include and lib directories from the neighbor's `dcr.toml`.
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
mylib = { path = "/abs/path/to/lib" }
|
||||
mylib = { path = "../relative/path" }
|
||||
```
|
||||
|
||||
## dcr.lock
|
||||
|
||||
Dependency lock file. Contains package names and sources.
|
||||
|
||||
Created during `dcr build` when registry dependencies are present. Not updated during `dcr add` — only on the next `dcr build`.
|
||||
|
||||
## Resolution process
|
||||
|
||||
1. Load all dependencies (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
|
||||
5. Collect `include_dirs`, `lib_dirs`, `libs` for the compiler
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_label: Environment variables
|
||||
---
|
||||
|
||||
# Environment Variables
|
||||
|
||||
## DCR_COMPILER
|
||||
|
||||
Overrides the compiler for all languages. **Highest priority.**
|
||||
|
||||
```bash
|
||||
export DCR_COMPILER=clang
|
||||
dcr build
|
||||
```
|
||||
|
||||
Compiler resolution priority:
|
||||
|
||||
1. `DCR_COMPILER` (env)
|
||||
2. `DCR_CC` / `DCR_CXX` / `DCR_AS` (env)
|
||||
3. `[toolchain]` (dcr.toml)
|
||||
4. `build.compiler` (dcr.toml)
|
||||
5. `PATH`
|
||||
|
||||
## DCR_CC / DCR_CXX / DCR_AS
|
||||
|
||||
Per-language override (lower priority than `DCR_COMPILER`, higher than `[toolchain]`).
|
||||
|
||||
```bash
|
||||
export DCR_CC=gcc-14
|
||||
export DCR_CXX=g++-14
|
||||
export DCR_AS=arm-linux-gnueabihf-as
|
||||
```
|
||||
|
||||
## DCR_LD / DCR_AR
|
||||
|
||||
Override linker and archiver.
|
||||
|
||||
```bash
|
||||
export DCR_LD=ld.lld
|
||||
export DCR_AR=llvm-ar
|
||||
```
|
||||
|
||||
## DCR_DEBUG
|
||||
|
||||
Enables debug mode — prints all compilation commands to stderr before execution.
|
||||
|
||||
```bash
|
||||
export DCR_DEBUG=1
|
||||
dcr build
|
||||
```
|
||||
|
||||
## DCR_INDEX_PATH
|
||||
|
||||
Overrides the path to the registry `index.json`.
|
||||
|
||||
```bash
|
||||
export DCR_INDEX_PATH=/custom/path/index.json
|
||||
```
|
||||
|
||||
Default: `~/.dcr/index.json`.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: Platform support
|
||||
---
|
||||
|
||||
# Platform Support
|
||||
|
||||
## Target Triples
|
||||
|
||||
DCR normalizes target triples. Short platform names are expanded to full triples.
|
||||
|
||||
### Linux
|
||||
|
||||
```
|
||||
target/<arch>-unknown-linux-gnu/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64` (host-detected).
|
||||
|
||||
Artifact type: ELF. Extensions: `.so` (sharedlib), `.a` (staticlib).
|
||||
|
||||
### macOS
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64` (host-detected).
|
||||
|
||||
Extensions: `.dylib` (sharedlib), `.a` (staticlib).
|
||||
|
||||
### Windows
|
||||
|
||||
```
|
||||
target/<profile>/
|
||||
```
|
||||
|
||||
Architectures: `x86_64`, `aarch64`.
|
||||
|
||||
Extensions: `.exe` (bin), `.lib` (staticlib), `.dll` (sharedlib), `.efi` (UEFI).
|
||||
|
||||
### BSD
|
||||
|
||||
```
|
||||
target/<arch>-unknown-<os>/<profile>/
|
||||
```
|
||||
|
||||
Supported systems: `freebsd`, `openbsd`, `netbsd`, `dragonfly`.
|
||||
|
||||
## Host Detection
|
||||
|
||||
DCR uses `std::env::consts::ARCH` and `std::env::consts::OS` for host platform detection. Used as fallback when `target` is not specified.
|
||||
85
docs-crowdin-export/ru-RU/docs/reference/workspaces.mdx.mdx
Normal file
85
docs-crowdin-export/ru-RU/docs/reference/workspaces.mdx.mdx
Normal file
@@ -0,0 +1,85 @@
|
||||
---
|
||||
sidebar_label: Workspaces
|
||||
---
|
||||
|
||||
# Workspaces
|
||||
|
||||
Workspaces allow managing multiple packages in a single repository.
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml
|
||||
[workspace.lib-core]
|
||||
path = "lib-core"
|
||||
|
||||
[workspace.lib-utils]
|
||||
path = "lib-utils"
|
||||
deps = ["lib-core"]
|
||||
|
||||
[workspace.app]
|
||||
path = "app"
|
||||
deps = ["lib-core", "lib-utils"]
|
||||
main = true
|
||||
```
|
||||
|
||||
### Member fields
|
||||
|
||||
| Field | Description |
|
||||
| ------ | ------------------------------------------------ |
|
||||
| `path` | Path to the package (relative to workspace root) |
|
||||
| `deps` | Dependencies on other members |
|
||||
| `main` | Mark as the main package |
|
||||
|
||||
## Topological sort
|
||||
|
||||
DCR automatically sorts packages by dependencies: package A is built before B if B depends on A.
|
||||
|
||||
Cyclic dependencies are detected and cause an error.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build # build all packages in dependency order
|
||||
dcr build --workspace app # build only app (dependencies built automatically)
|
||||
```
|
||||
|
||||
When building a workspace, member outputs (libraries) are automatically added to include/lib paths of dependent packages.
|
||||
|
||||
## Clean
|
||||
|
||||
```bash
|
||||
dcr clean # clean only root target/
|
||||
dcr clean --all # clean target/ of all packages
|
||||
```
|
||||
|
||||
## Inheritance
|
||||
|
||||
If a member has `inherit = true` in its `[build]` section, fields from the root `[build]` are merged into the member:
|
||||
|
||||
```toml
|
||||
# root dcr.toml
|
||||
[build]
|
||||
inherit = true
|
||||
language = "c"
|
||||
standard = "c17"
|
||||
|
||||
# member inherits language and standard
|
||||
```
|
||||
|
||||
## Workspace-only root (no build of its own)
|
||||
|
||||
A workspace root can set `workspace_only = true` — it won't be built itself, and doesn't need `language` or `compiler`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-workspace"
|
||||
version = "0.1.0"
|
||||
|
||||
[build]
|
||||
workspace_only = true
|
||||
kind = "bin"
|
||||
|
||||
[workspace]
|
||||
lib-core = { path = "lib-core" }
|
||||
app = { path = "app", deps = ["lib-core"] }
|
||||
```
|
||||
46
docs-crowdin-export/ru-RU/docs/self-update.mdx.mdx
Normal file
46
docs-crowdin-export/ru-RU/docs/self-update.mdx.mdx
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_label: Self Update
|
||||
---
|
||||
|
||||
# Self Update
|
||||
|
||||
## dcr --update
|
||||
|
||||
Automatic update to the latest version. Downloads a binary (not an archive) from GitHub Releases and replaces the current executable.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
## How it works
|
||||
|
||||
1. DCR detects the current platform and architecture
|
||||
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)
|
||||
5. Replaces the current executable via `self_replace`
|
||||
|
||||
## Asset naming
|
||||
|
||||
Pattern: `dcr-\<triple>` or `dcr-\<triple>.exe`
|
||||
|
||||
| Platform | Asset name |
|
||||
| -------------- | -------------------------------- |
|
||||
| Linux x86_64 | `dcr-x86_64-unknown-linux-gnu` |
|
||||
| macOS x86_64 | `dcr-x86_64-apple-darwin` |
|
||||
| macOS ARM64 | `dcr-aarch64-apple-darwin` |
|
||||
| Windows x86_64 | `dcr-x86_64-pc-windows-msvc.exe` |
|
||||
|
||||
## AUR
|
||||
|
||||
If DCR was installed via AUR, `--update` shows a warning:
|
||||
|
||||
```
|
||||
Update via package manager: yay/paru -Syu {package_name} or sudo pacman -Syu {package_name}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
* Cannot detect platform — error
|
||||
* Cannot fetch release — error with URL
|
||||
* No write permission — error (use `sudo` or manual install)
|
||||
45
docs-crowdin-export/ru-RU/docs/testing/running-tests.mdx.mdx
Normal file
45
docs-crowdin-export/ru-RU/docs/testing/running-tests.mdx.mdx
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_label: Running tests
|
||||
---
|
||||
|
||||
# Running Tests
|
||||
|
||||
## Execution
|
||||
|
||||
```bash
|
||||
dcr test
|
||||
```
|
||||
|
||||
Builds the project, then compiles and runs test files from `tests/`.
|
||||
|
||||
## Profiles
|
||||
|
||||
```bash
|
||||
dcr test # debug (default)
|
||||
dcr test --release # release
|
||||
dcr test --debug # explicit debug
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
```
|
||||
=====================
|
||||
Testsuite summary
|
||||
=====================
|
||||
TOTAL: 5
|
||||
PASS: 3
|
||||
SKIP: 1
|
||||
FAIL: 1
|
||||
=====================
|
||||
```
|
||||
|
||||
## Exit code
|
||||
|
||||
* 0 — all tests passed (FAIL = 0)
|
||||
* 1 — test failures or build error
|
||||
|
||||
## What gets built
|
||||
|
||||
* All `.c` files from `tests/` (`.cpp` not supported)
|
||||
* Include path: `tests/` (for `dcr_test.h`)
|
||||
* Linked with project if `package.type = "lib"` or `kind = "staticlib"`/`"sharedlib"`
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_label: Test framework (EXPECT, TEST, ...)
|
||||
---
|
||||
|
||||
# Test Framework
|
||||
|
||||
DCR has a built-in minimal test framework for C.
|
||||
|
||||
## Macros
|
||||
|
||||
### `EXPECT(expr)`
|
||||
|
||||
Asserts that an expression is true.
|
||||
|
||||
```c
|
||||
EXPECT(1 + 1 == 2);
|
||||
EXPECT(ptr != NULL);
|
||||
```
|
||||
|
||||
### `SKIP(reason)`
|
||||
|
||||
Skips a test with a message.
|
||||
|
||||
```c
|
||||
SKIP("not implemented on Windows");
|
||||
```
|
||||
|
||||
### `TEST(name)`
|
||||
|
||||
Defines a test.
|
||||
|
||||
```c
|
||||
TEST(addition) {
|
||||
EXPECT(1 + 1 == 2);
|
||||
EXPECT(2 + 2 == 4);
|
||||
}
|
||||
```
|
||||
|
||||
### `TEST_CASE(name)`
|
||||
|
||||
Registers a test case.
|
||||
|
||||
```c
|
||||
TEST_CASE(math) {
|
||||
EXPECT(1 + 1 == 2);
|
||||
}
|
||||
```
|
||||
|
||||
## Initialization
|
||||
|
||||
```bash
|
||||
dcr test --init
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `tests/dcr_test.h` — framework header (do not edit)
|
||||
* `tests/test.c` — template with example test
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
tests/
|
||||
├── dcr_test.h # framework (do not edit)
|
||||
├── test.c # main tests
|
||||
└── ... # additional .c test files
|
||||
```
|
||||
|
||||
Only `.c` files are compiled (`.cpp` is not supported).
|
||||
63
docs-crowdin-export/uk-UA/docs/README.mdx.mdx
Normal file
63
docs-crowdin-export/uk-UA/docs/README.mdx.mdx
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_label: Introduction
|
||||
---
|
||||
|
||||
# DCR — C/C++ Build Tool & Package Manager
|
||||
|
||||
<details>
|
||||
<summary>Quick reference</summary>
|
||||
|
||||
```bash
|
||||
# Installation
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
|
||||
# Create a project
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
|
||||
# Build and run
|
||||
dcr build
|
||||
dcr run
|
||||
|
||||
# Run tests
|
||||
dcr test
|
||||
|
||||
# Add a dependency
|
||||
dcr add fmt
|
||||
|
||||
# Generate IDE files
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Contents
|
||||
|
||||
| Section | Description |
|
||||
| ----------------------------------------------------- | --------------------------------------------- |
|
||||
| [Getting Started](/docs/getting-started/installation) | Installation and first steps |
|
||||
| [Commands](/docs/commands/project-commands) | All CLI commands |
|
||||
| [Reference](/docs/reference/dcr-toml) | Configuration, build, dependencies, platforms |
|
||||
| [Testing](/docs/testing/test-framework) | Built-in test framework |
|
||||
| [Recipes](/docs/recipes/cross-to-windows) | Common scenarios |
|
||||
| [IDE Integration](/docs/ide-integration) | VS Code, CLion, compile_commands.json |
|
||||
| [Self Update](/docs/self-update) | Auto-update |
|
||||
| [FAQ](/docs/faq) | Frequently asked questions |
|
||||
| [Changelog](/docs/changelog) | Version history |
|
||||
| [License](/docs/license) | DCR and vendored library licenses |
|
||||
| [Contributing](/docs/contributing) | DCR development |
|
||||
|
||||
## Features
|
||||
|
||||
* **Incremental builds** — mtime + `.d` headers + SHA256 fingerprint
|
||||
* **Parallel compilation** — thread::scope, atomic task queue
|
||||
* **4 backends** — gcc/clang, MSVC/clang-cl, GAS (ARM), NASM (x86)
|
||||
* **7 project kinds** — bin, staticlib, sharedlib, efi, elf, none, custom
|
||||
* **Cross-compilation** — short names and full triples
|
||||
* **Profiles** — debug / release with field overrides
|
||||
* **Workspaces** — multi-package projects with topological sort
|
||||
* **Registry + Git + Path** — three dependency mechanisms
|
||||
* **IDE generation** — VS Code, CLion, compile_commands.json, JSON metadata
|
||||
* **pkg-config** — automatic system library discovery
|
||||
* **Per-command `--help`** — `dcr build --help`, `dcr new --help`, etc.
|
||||
* **Man pages** — `man dcr`, `man dcr-build`, `man dcr-new`
|
||||
91
docs-crowdin-export/uk-UA/docs/changelog.mdx.mdx
Normal file
91
docs-crowdin-export/uk-UA/docs/changelog.mdx.mdx
Normal file
@@ -0,0 +1,91 @@
|
||||
---
|
||||
sidebar_label: Changelog
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
## 0.7.1 (2026-06-02)
|
||||
|
||||
### Added
|
||||
|
||||
* **`--help` for all commands** — `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-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,
|
||||
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.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`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.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **`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.
|
||||
|
||||
## 0.7.0 (2026-06-01)
|
||||
|
||||
### Added
|
||||
|
||||
* **OpenBSD and NetBSD target support** — full platform routing with dynamic target triples using `std::env::consts::ARCH` and `std::env::consts::OS`. Affects `build`, `run`, `clean` commands and the platform module.
|
||||
* **`src/platform/bsd.rs`** — new BSD platform module (shared by FreeBSD, OpenBSD, NetBSD) providing `bin_path`, `lib_path`, `elf_path`, `efi_path`, `shared_lib_path`.
|
||||
* **`build.out_dir` config option** — custom output directory that overrides the default `target/\<triple>/\<profile>` path for final artifacts. Supported in `build`, `run`, and config validation.
|
||||
* **`dcr fmt` command** — new CLI command that formats all C/C++ source files (`*.c`, `*.cpp`, `*.h`, `*.hpp`) in `src/` and `tests/` using `clang-format`.
|
||||
* **Incremental linking** — `needs_link()` in `common.rs` checks if any object file is newer than the linked output, skipping unnecessary relinking. Implemented for all backends (`unix_cc`, `msvc`, `gas`, `nasm`).
|
||||
* **`build.kind = "none"` and `"custom"`** — two new project kinds for special build scenarios that don't produce standard artifacts.
|
||||
* **`install_bsd.sh`** — POSIX-compliant installation script for BSD systems (FreeBSD, OpenBSD, NetBSD) with binary download and source build modes.
|
||||
* **Linux ARM64 support in `install.sh`** — added `Linux:aarch64|Linux:arm64` target detection for pre-built binary downloads.
|
||||
* **BSD OS detection in `install.sh`** — detects FreeBSD, OpenBSD, NetBSD and determines target triple.
|
||||
* **`rust-toolchain.toml`** — explicit toolchain pinning to `stable` channel.
|
||||
* **Integration tests** — `build_with_target_config` (verifies `build.target = "linux"`) and `build_with_out_dir` (validates custom output directory).
|
||||
* **`get_build_string_with_profile` made `pub`** — so `run.rs` can determine custom output directory configuration.
|
||||
|
||||
### Changed
|
||||
|
||||
* **`build.target` semantics changed** — now strictly contains a target triple (e.g., `x86_64-unknown-linux-gnu`) or short name (`linux`, `macos`, `windows`). No longer used as custom output directory — this functionality moved to `build.out_dir`.
|
||||
* **`build.standard` made optional** — changed from `String` to `Option\<String>`. Validation only enforces non-empty for non-ASM languages. Skipped in `dcr.toml` output if empty.
|
||||
* **`dcr run` with `out_dir`** — now determines target directory respecting `build.out_dir` via `get_build_string_with_profile()` from `build.rs`.
|
||||
* **`collect_sources()` returns empty vector** instead of error when no sources are found, allowing `kind = "none"` or `kind = "custom"` projects with no source files.
|
||||
* **CI/CD release workflow refactored** — `git2` made target-specific (no vendored-openssl on Windows), Zig-based cross-compilation for non-x86_64 Linux targets, Arch Linux package version cleanup (dashes → dots), `gmake` symlink for NetBSD.
|
||||
* **README compatibility table** — FreeBSD, OpenBSD, NetBSD build/run status upgraded from "community/best-effort" to "officially supported".
|
||||
* **Documentation updated** — `build-section.md` describes new `build.target` and `build.out_dir` fields. `target-directory.md` rewritten to clarify the distinction.
|
||||
|
||||
### Fixed
|
||||
|
||||
* **stdout/stderr not inherited in `dcr run`** — child process output was captured and manually printed, breaking interactive programs. Fixed by switching to `Command::status()`.
|
||||
* **Race condition in release CI** — matrix build jobs could upload assets to a release that didn't exist yet. Fixed by adding a dedicated `create-release` job.
|
||||
* **Release GHA — stable toolchain override** — fixed Rust toolchain override issues in CI.
|
||||
* **Arch Linux package version sanitization** — version strings with dashes (e.g., `0.7.0-dev`) are invalid for `pkgver`. Fixed by replacing dashes with dots.
|
||||
* **GPG permissions after Docker** — Docker operations changed GPG directory ownership. Fixed by running `chown` after Docker commands.
|
||||
* **RPM artifact paths** — RPM artifacts were placed in `rpm/x86_64/` instead of `fedora/x86_64/`. Fixed in Dexoron Packages Index workflow.
|
||||
* **JSON parsing reliability in `install.sh`** — added `jq` as primary parser with `python3` fallback for dev channel release lookup.
|
||||
|
||||
### Removed
|
||||
|
||||
* **`format_roots()` helper function** — removed from `common.rs`. Was only used by the old error handling path in `collect_sources()`.
|
||||
* **Per-distribution artifact download steps** — three separate `actions/download-artifact` steps replaced with unified `gh release download --clobber`.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
sidebar_label: Build commands (build, run, clean)
|
||||
---
|
||||
|
||||
# Build Commands
|
||||
|
||||
## `dcr build`
|
||||
|
||||
Builds the project according to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr build # debug profile
|
||||
dcr build --release # release build
|
||||
dcr build --debug # explicit debug
|
||||
dcr build --target aarch64-unknown-linux-gnu
|
||||
dcr build --force # full rebuild
|
||||
dcr build --clean # clean + build
|
||||
dcr build --verbose # show compilation commands
|
||||
dcr build --workspace pkg-a # build specific workspace package
|
||||
```
|
||||
|
||||
Artifacts: `target/\<triple>/\<profile>/\<binary-name>` (Linux with explicit target).
|
||||
|
||||
## `dcr run`
|
||||
|
||||
Builds (if sources are newer than artifacts) and runs the binary.
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
dcr run --release
|
||||
```
|
||||
|
||||
## `dcr clean`
|
||||
|
||||
Removes `target/` directory (or `target/\<target>/\<profile>`).
|
||||
|
||||
```bash
|
||||
dcr clean
|
||||
dcr clean --release # target/release/ only
|
||||
dcr clean --target windows # target/x86_64-pc-windows-msvc/
|
||||
dcr clean --all # clean all workspace packages
|
||||
```
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_label: Dependency commands (add, tree)
|
||||
---
|
||||
|
||||
# Dependency Commands
|
||||
|
||||
## `dcr add \<name> [source]`
|
||||
|
||||
Adds a dependency to `dcr.toml`.
|
||||
|
||||
```bash
|
||||
dcr add fmt # registry lookup
|
||||
dcr add mylib ../path/to/lib # path as source
|
||||
dcr add mylib path:./lib # explicit path prefix
|
||||
dcr add mylib git:https://github.com/user/repo # explicit git prefix
|
||||
dcr add mylib github:user/repo # GitHub shorthand
|
||||
dcr add mylib gitlab:user/repo # GitLab shorthand
|
||||
```
|
||||
|
||||
Source prefixes:
|
||||
|
||||
* `path:` — local path
|
||||
* `git:` — generic git URL
|
||||
* `github:` — expands to `https://github.com/\<user>/\<repo>`
|
||||
* `gitlab:` — expands to `https://gitlab.com/\<user>/\<repo>`
|
||||
* `http://` / `https://` / `git@` — full URL
|
||||
|
||||
Flags:
|
||||
|
||||
* `--branch \<name>` — git branch
|
||||
* `--tag \<name>` — git tag
|
||||
* `--rev \<hash>` — git commit
|
||||
|
||||
If source is omitted — DCR searches connected registries.
|
||||
|
||||
## `dcr tree`
|
||||
|
||||
Displays the project dependency tree.
|
||||
|
||||
```bash
|
||||
dcr tree
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```
|
||||
my-app v0.1.0
|
||||
├── fmt (registry)
|
||||
│ └── spdlog (registry)
|
||||
└── catch2 (registry)
|
||||
```
|
||||
|
||||
For path dependencies, recursively shows their own dependencies (from their `dcr.toml`).
|
||||
73
docs-crowdin-export/uk-UA/docs/commands/gen-commands.mdx.mdx
Normal file
73
docs-crowdin-export/uk-UA/docs/commands/gen-commands.mdx.mdx
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
sidebar_label: Gen commands (vscode, clion, ...)
|
||||
---
|
||||
|
||||
# Gen Commands
|
||||
|
||||
## `dcr gen \<target>`
|
||||
|
||||
Generates IDE integration files.
|
||||
|
||||
### vscode
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.vscode/tasks.json` — `build` task (dcr build)
|
||||
* `.vscode/launch.json` — debug launch configuration
|
||||
* `.vscode/settings.json` — C/C++ settings (clangd paths, includes)
|
||||
* `.vscode/extensions.json` — recommended extensions (vscode-clangd, vscode-lldb)
|
||||
|
||||
### clion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Creates:
|
||||
|
||||
* `.idea/externalTools.xml` — external tools (build, run, clean, test)
|
||||
* `.idea/customTargets.xml` — custom build targets
|
||||
* `.idea/misc.xml` — C/C++ project settings
|
||||
* `.idea/runConfigurations/\<name>.xml` — per-binary run configurations
|
||||
|
||||
### compile-commands
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` — standard format for clangd, cpptools, static analyzers.
|
||||
|
||||
### project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"name": "my-app",
|
||||
"version": "0.1.0",
|
||||
"root": "/path/to/project",
|
||||
"profile": "debug",
|
||||
"language": "c",
|
||||
"standard": "c17",
|
||||
"cxx_standard": null,
|
||||
"compiler": "/usr/bin/clang",
|
||||
"kind": "bin",
|
||||
"sources": ["src/main.c"],
|
||||
"include_dirs": ["src"],
|
||||
"lib_dirs": [],
|
||||
"libs": [],
|
||||
"cflags": ["-std=c17", "-O0", "-g"],
|
||||
"ldflags": []
|
||||
}
|
||||
]
|
||||
```
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
sidebar_label: Project commands (new, init)
|
||||
---
|
||||
|
||||
# Project Commands
|
||||
|
||||
## `dcr new \<name>`
|
||||
|
||||
Creates a new project with a standard structure and `dcr.toml`. The `name` argument is required.
|
||||
|
||||
Only ASCII letters, digits, underscores `_` and hyphens `-` are allowed in the project name.
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
dcr new my-app --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
Generates:
|
||||
|
||||
* `dcr.toml` with basic fields
|
||||
* `src/main.c` with a `main` template
|
||||
|
||||
## `dcr init`
|
||||
|
||||
Initializes a DCR project in the current (empty) directory.
|
||||
|
||||
```bash
|
||||
dcr init
|
||||
dcr init --vcs none
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
* `--vcs \<git|none>` — Initialize version control system (defaults to `git` if available, or `none`).
|
||||
|
||||
The project name is taken from the current directory name. The directory name must follow the same naming rules as `dcr new`.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_label: Quality commands (test, fmt)
|
||||
---
|
||||
|
||||
# Quality Commands
|
||||
|
||||
## `dcr test`
|
||||
|
||||
Runs tests.
|
||||
|
||||
```bash
|
||||
dcr test # debug profile
|
||||
dcr test --release # release profile
|
||||
dcr test --debug # explicit debug
|
||||
dcr test --help # detailed help
|
||||
```
|
||||
|
||||
Before first use, initialize tests:
|
||||
|
||||
```bash
|
||||
dcr test --init
|
||||
```
|
||||
|
||||
This creates `tests/dcr_test.h` (framework) and `tests/test.c` (template).
|
||||
|
||||
What `dcr test` does:
|
||||
|
||||
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
|
||||
6. Returns non-zero exit code on any FAIL
|
||||
|
||||
## `dcr fmt`
|
||||
|
||||
Formats C/C++ source files using `clang-format`.
|
||||
|
||||
```bash
|
||||
dcr fmt
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}` and `tests/**/*.{c,cpp,cxx,cc,h,hpp,hxx,hh}`.
|
||||
|
||||
Uses `.clang-format` at the project root (if present), otherwise default clang-format style.
|
||||
|
||||
## `dcr lint`
|
||||
|
||||
Runs `clang-tidy` on C/C++ source files for static analysis.
|
||||
|
||||
```bash
|
||||
dcr lint # show diagnostics
|
||||
dcr lint --fix # apply fixes automatically
|
||||
dcr lint --help # detailed help
|
||||
```
|
||||
|
||||
Processes: `src/**/*.{c,cpp,cxx,cc}` and `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.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: System commands (setup, --help, ...)
|
||||
---
|
||||
|
||||
# System Commands
|
||||
|
||||
## `dcr setup`
|
||||
|
||||
Shows configured registries from `~/.dcr/config.toml`.
|
||||
|
||||
```bash
|
||||
dcr setup
|
||||
```
|
||||
|
||||
If `~/.dcr/config.toml` is not found, DCR returns an error. Create it manually:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
## `dcr --help`
|
||||
|
||||
Shows help for all commands.
|
||||
|
||||
```bash
|
||||
dcr --help
|
||||
```
|
||||
|
||||
## `dcr --version`
|
||||
|
||||
Shows version and target triple.
|
||||
|
||||
```bash
|
||||
dcr --version # dcr 0.7.0 (x86_64-unknown-linux-gnu)
|
||||
```
|
||||
|
||||
## `dcr --update`
|
||||
|
||||
Self-update. Downloads the latest release binary from GitHub Releases and replaces the current one.
|
||||
|
||||
```bash
|
||||
dcr --update
|
||||
```
|
||||
|
||||
Features:
|
||||
|
||||
* Auto-detects platform and architecture
|
||||
* Warns if installed via AUR (use package manager instead)
|
||||
* Works on Linux, macOS, Windows
|
||||
51
docs-crowdin-export/uk-UA/docs/contributing.mdx.mdx
Normal file
51
docs-crowdin-export/uk-UA/docs/contributing.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: Contributing
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dexoron/dcr
|
||||
cd dcr
|
||||
cargo build
|
||||
```
|
||||
|
||||
## Code style
|
||||
|
||||
All code must be formatted with `cargo fmt`:
|
||||
|
||||
```bash
|
||||
cargo fmt
|
||||
```
|
||||
|
||||
## Linting
|
||||
|
||||
```bash
|
||||
cargo clippy --all-targets -- -D warnings
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
cargo test --all-targets
|
||||
```
|
||||
|
||||
## PR process
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a branch: `git checkout -b feature/description`
|
||||
3. Make changes
|
||||
4. Run `cargo fmt && cargo clippy && cargo test`
|
||||
5. Open a Pull Request
|
||||
|
||||
## CI
|
||||
|
||||
CI runs:
|
||||
|
||||
* `cargo fmt --check`
|
||||
* `cargo clippy --all-targets -- -D warnings`
|
||||
* `cargo test --all-targets`
|
||||
* Build on Linux, macOS, Windows
|
||||
* Integration tests
|
||||
81
docs-crowdin-export/uk-UA/docs/faq.mdx.mdx
Normal file
81
docs-crowdin-export/uk-UA/docs/faq.mdx.mdx
Normal file
@@ -0,0 +1,81 @@
|
||||
---
|
||||
sidebar_label: FAQ
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
## Registry not found
|
||||
|
||||
```
|
||||
error: registry not found
|
||||
```
|
||||
|
||||
**Solution:** Make sure `~/.dcr/config.toml` exists:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
|
||||
And check `DCR_INDEX_PATH`:
|
||||
|
||||
```bash
|
||||
echo $DCR_INDEX_PATH
|
||||
```
|
||||
|
||||
## Compiler not found
|
||||
|
||||
```
|
||||
error: compiler not found
|
||||
```
|
||||
|
||||
**Solution:** Ensure a compiler is installed and available in PATH.
|
||||
|
||||
```bash
|
||||
which gcc
|
||||
which clang
|
||||
```
|
||||
|
||||
Or specify explicitly via `[toolchain]` in `dcr.toml`.
|
||||
|
||||
## openssl-sys build failed
|
||||
|
||||
When building DCR from source:
|
||||
|
||||
```
|
||||
error: failed to run custom build command for openssl-sys
|
||||
```
|
||||
|
||||
**Solution:** Install OpenSSL development headers:
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt install libssl-dev
|
||||
|
||||
# Fedora
|
||||
sudo dnf install openssl-devel
|
||||
|
||||
# macOS
|
||||
brew install openssl
|
||||
```
|
||||
|
||||
## Ctrl+C during build
|
||||
|
||||
DCR handles SIGINT: interrupts the current compilation and exits with non-zero code.
|
||||
|
||||
## How to create a library?
|
||||
|
||||
See [Library Recipe](/docs/recipes/library-project).
|
||||
|
||||
## How to cross-compile to Windows?
|
||||
|
||||
See [Cross-Compile Recipe](/docs/recipes/cross-to-windows).
|
||||
|
||||
## How to create a multi-package project?
|
||||
|
||||
See [Workspace Recipe](/docs/recipes/multi-package-workspace).
|
||||
|
||||
## Lock file
|
||||
|
||||
`dcr.lock` is created during builds (`dcr build`) when registry dependencies are present. To force an update — delete `dcr.lock` and run `dcr build`.
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
sidebar_label: First steps
|
||||
---
|
||||
|
||||
# First Steps
|
||||
|
||||
## Create a project
|
||||
|
||||
```bash
|
||||
dcr new my-app
|
||||
cd my-app
|
||||
```
|
||||
|
||||
Structure:
|
||||
|
||||
```
|
||||
my-app/
|
||||
├── dcr.toml
|
||||
└── src/
|
||||
└── main.c
|
||||
```
|
||||
|
||||
`dcr.toml`:
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "my-app"
|
||||
version = "0.1.0"
|
||||
type = "none"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
dcr build
|
||||
```
|
||||
|
||||
Output — `target/\<triple>/debug/my-app` (Linux) or `target/debug/my-app.exe` (Windows).
|
||||
|
||||
Build profiles:
|
||||
|
||||
```bash
|
||||
dcr build --release # release build
|
||||
dcr build --debug # debug (default)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
dcr run
|
||||
```
|
||||
|
||||
Builds (if needed) and runs the binary.
|
||||
|
||||
## First test
|
||||
|
||||
```bash
|
||||
dcr test --init # create test template
|
||||
dcr test # run tests
|
||||
```
|
||||
|
||||
## Formatting
|
||||
|
||||
```bash
|
||||
dcr fmt # clang-format with .clang-format
|
||||
```
|
||||
@@ -0,0 +1,109 @@
|
||||
---
|
||||
sidebar_label: Installation
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
## Linux (Dexoron Packages)
|
||||
|
||||
Configure your package manager at https://pkg.dexoron.su and install:
|
||||
|
||||
**Arch Linux**
|
||||
|
||||
```sh
|
||||
sudo pacman -Sy dcr
|
||||
```
|
||||
|
||||
**Debian/Ubuntu**
|
||||
|
||||
```sh
|
||||
sudo apt update && sudo apt install dcr
|
||||
```
|
||||
|
||||
**Fedora/RHEL**
|
||||
|
||||
```sh
|
||||
sudo dnf install dcr
|
||||
```
|
||||
|
||||
## Arch Linux (AUR)
|
||||
|
||||
```sh
|
||||
yay -S dcr
|
||||
```
|
||||
|
||||
## macOS / Linux (Homebrew)
|
||||
|
||||
```sh
|
||||
brew tap dexoron/dexoron
|
||||
brew install dcr
|
||||
```
|
||||
|
||||
## Snap (Linux)
|
||||
|
||||
```sh
|
||||
sudo snap install dcrup
|
||||
```
|
||||
|
||||
## Nix (flake)
|
||||
|
||||
```sh
|
||||
nix run github:dexoron/dcr
|
||||
# or install to profile:
|
||||
nix profile install github:dexoron/dcr
|
||||
```
|
||||
|
||||
## Cargo (crates.io)
|
||||
|
||||
```sh
|
||||
cargo install dcr
|
||||
```
|
||||
|
||||
## Linux / macOS (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||
```
|
||||
|
||||
## BSD (script)
|
||||
|
||||
```sh
|
||||
curl -fsSL https://dcr.dexoron.su/install_bsd.sh | sh
|
||||
```
|
||||
|
||||
## Windows (PowerShell)
|
||||
|
||||
```powershell
|
||||
irm https://dcr.dexoron.su/install.ps1 | iex
|
||||
```
|
||||
|
||||
## From source
|
||||
|
||||
```sh
|
||||
git clone https://github.com/dexoron/dcr.git
|
||||
cd dcr && cargo build --release
|
||||
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
||||
```
|
||||
|
||||
## Post-install
|
||||
|
||||
Verify the installation:
|
||||
|
||||
```bash
|
||||
dcr --version
|
||||
```
|
||||
|
||||
Man pages are available after installation:
|
||||
|
||||
```bash
|
||||
man dcr
|
||||
man dcr-build
|
||||
```
|
||||
|
||||
To use the registry, create `~/.dcr/config.toml`:
|
||||
|
||||
```toml
|
||||
[registry.default]
|
||||
url = "https://index.dcr.pm"
|
||||
priority = 1
|
||||
```
|
||||
51
docs-crowdin-export/uk-UA/docs/ide-integration.mdx.mdx
Normal file
51
docs-crowdin-export/uk-UA/docs/ide-integration.mdx.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_label: IDE Integration
|
||||
---
|
||||
|
||||
# IDE Integration
|
||||
|
||||
## VS Code
|
||||
|
||||
```bash
|
||||
dcr gen vscode
|
||||
```
|
||||
|
||||
Generates in `.vscode/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ----------------- | -------------------------------------------- |
|
||||
| `tasks.json` | `build` task (dcr build) |
|
||||
| `launch.json` | Debug launch configuration |
|
||||
| `settings.json` | clangd/IntelliSense: include paths, standard |
|
||||
| `extensions.json` | Recommends vscode-clangd, vscode-lldb |
|
||||
|
||||
## CLion
|
||||
|
||||
```bash
|
||||
dcr gen clion
|
||||
```
|
||||
|
||||
Generates in `.idea/`:
|
||||
|
||||
| File | Purpose |
|
||||
| ------------------------------------------------ | ----------------------------------------- |
|
||||
| `externalTools.xml` | Build, Run, Clean, Test as external tools |
|
||||
| `customTargets.xml` | Custom build targets |
|
||||
| `misc.xml` | C/C++ project settings |
|
||||
| `runConfigurations/\<name>.xml` | Per-binary run configurations |
|
||||
|
||||
## compile_commands.json
|
||||
|
||||
```bash
|
||||
dcr gen compile-commands
|
||||
```
|
||||
|
||||
Generates `compile_commands.json` at project root. Standard format for clangd, C/C++ IntelliSense, static analyzers.
|
||||
|
||||
## project-info
|
||||
|
||||
```bash
|
||||
dcr gen project-info
|
||||
```
|
||||
|
||||
Outputs JSON array with project metadata (see [gen-commands](/docs/commands/gen-commands)).
|
||||
33
docs-crowdin-export/uk-UA/docs/license.mdx.mdx
Normal file
33
docs-crowdin-export/uk-UA/docs/license.mdx.mdx
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
sidebar_label: License
|
||||
---
|
||||
|
||||
# License
|
||||
|
||||
## DCR
|
||||
|
||||
DCR itself is [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) licensed.
|
||||
|
||||
> **Note:** DCR is a build tool, not a library. The GPL applies only to DCR's own source code. Projects built with DCR are not subject to DCR's license — their licensing is determined solely by their own code and dependencies.
|
||||
|
||||
## Rust dependencies
|
||||
|
||||
DCR is written in Rust. The following notable Rust crates are statically linked:
|
||||
|
||||
| Crate | License |
|
||||
| ------------------------------------------------------- | ----------------- |
|
||||
| [`ureq`](https://crates.io/crates/ureq) | MIT OR Apache-2.0 |
|
||||
| [`serde`](https://crates.io/crates/serde) | MIT OR Apache-2.0 |
|
||||
| [`toml`](https://crates.io/crates/toml) | MIT OR Apache-2.0 |
|
||||
| [`toml_edit`](https://crates.io/crates/toml_edit) | MIT OR Apache-2.0 |
|
||||
| [`serde_json`](https://crates.io/crates/serde_json) | MIT OR Apache-2.0 |
|
||||
| [`sha2`](https://crates.io/crates/sha2) | MIT OR Apache-2.0 |
|
||||
| [`glob`](https://crates.io/crates/glob) | MIT OR Apache-2.0 |
|
||||
| [`self-replace`](https://crates.io/crates/self-replace) | MIT OR Apache-2.0 |
|
||||
| [`ctrlc`](https://crates.io/crates/ctrlc) | MIT OR Apache-2.0 |
|
||||
|
||||
Full dependency tree is available in [`Cargo.lock`](https://github.com/dexoron/dcr/blob/main/Cargo.lock). The overwhelming majority are dual-licensed under MIT OR Apache-2.0.
|
||||
|
||||
## Additional credits
|
||||
|
||||
* DCR's CLI design and project model are inspired by [Cargo](https://doc.rust-lang.org/cargo/).
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user