mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 17:39:35 +00:00
Compare commits
119 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 803d5891ce | |||
| 9326e23a53 | |||
| 21932ac94a | |||
| 97db82e4f8 | |||
| 3d596d7280 | |||
| 5cb4473bd1 | |||
| 33f955d4e3 | |||
| 838be72dd2 | |||
| 39fad31c4f | |||
| c8ef38a99b | |||
| 8e0c535cfd | |||
| de88c160ad | |||
| 4daca925a0 | |||
| 595b7ac105 | |||
|
|
11ae3762d0 | ||
|
|
4c439317e3 | ||
| 0aa3f87f99 | |||
| a6ce0a3332 | |||
| cea43e99c8 | |||
| de4fb0bc29 | |||
| 59e27b6f5d | |||
| c8cb155e5a | |||
| 6424aab69d | |||
|
|
dabeb411d3 | ||
|
|
b8338c752b | ||
| b70438b16d | |||
| 0597b5ddb2 | |||
|
|
8866fb0796 | ||
|
|
7d853482aa | ||
|
|
ef9ca57295 | ||
|
|
8e1fb60692 | ||
|
|
d6ddb5da3d | ||
|
|
d26e93dd47 | ||
| 97d2970727 | |||
|
|
35f9b6be94 | ||
| 6885a82be7 | |||
| 5d587db227 | |||
| 424f4f6929 | |||
| 443306aa5f | |||
| f21f50facb | |||
| 23c4f4ca87 | |||
| c42575e360 | |||
| c756d94f96 | |||
|
|
8e21432764 | ||
|
|
772d50811f | ||
| ea1546b13a | |||
| f5d5795872 | |||
| e6788b4d71 | |||
| 865d8c52ff | |||
| 94aa6c0f01 | |||
|
|
e462de6272 | ||
|
|
0587965283 | ||
|
|
478d1ad0c5 | ||
|
|
060b92111f | ||
|
|
86f0566dc2 | ||
|
|
768e2fc0dc | ||
|
|
619493bcbd | ||
|
|
1dac8661b6 | ||
|
|
80a6d574a3 | ||
|
|
daf465368f | ||
|
|
800fe38fba | ||
|
|
a7f9b79b93 | ||
|
|
b03660a9d7 | ||
|
|
2cb02aa102 | ||
|
|
06a8458ca7 | ||
| c2ef5483a0 | |||
| eb24d616c5 | |||
| 4f76f54b63 | |||
| 37b9b855ec | |||
| 8f0f67ad62 | |||
| 49945aa65d | |||
| 83593aa592 | |||
| 2835188da9 | |||
| 78160e2bb9 | |||
| 7f9cd3d643 | |||
| 4d1bd1dbdc | |||
| 7bc571ea27 | |||
| f431c3d018 | |||
| 9fd1652ebb | |||
| c59d6de54f | |||
| 73b6ce903e | |||
| e97b9b6e00 | |||
| 12d1bc5111 | |||
| 8c9dd39503 | |||
| e3c35793ec | |||
| a55d64c5ff | |||
| acdd1cc175 | |||
| b5bbdb929b | |||
| 29120e0e29 | |||
| b66c846956 | |||
| 2a9c918711 | |||
| 2af3baf4bb | |||
| 4e3601b1df | |||
| 7969209eae | |||
| adfa24f8f4 | |||
| ef2fb1e8e4 | |||
| 9ad968374e | |||
| c4a49cb345 | |||
| 527a789410 | |||
| 6b9e731c7b | |||
| b2854db91b | |||
| fce9c44181 | |||
| 3b54500d4d | |||
| 933fae749d | |||
|
|
9ab7ce15db | ||
|
|
954f2870ba | ||
|
|
9a24a80d59 | ||
|
|
a123f647c8 | ||
|
|
8f04a37eb0 | ||
| 441c9f4df3 | |||
| 60b9c4f983 | |||
|
|
f5fd273e29 | ||
| d6840fc7a2 | |||
|
|
f507148849 | ||
|
|
cfc6be1e95 | ||
| 2de836a421 | |||
| ed85f801e9 | |||
| 9d8dcda366 | |||
| 0193834bfd |
15
.github/FUNDING.yml
vendored
Normal file
15
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# These are supported funding model platforms
|
||||||
|
|
||||||
|
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||||
|
patreon: # Replace with a single Patreon username
|
||||||
|
open_collective: # Replace with a single Open Collective username
|
||||||
|
ko_fi: # Replace with a single Ko-fi username
|
||||||
|
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||||
|
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||||
|
liberapay: # Replace with a single Liberapay username
|
||||||
|
issuehunt: # Replace with a single IssueHunt username
|
||||||
|
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
||||||
|
polar: # Replace with a single Polar username
|
||||||
|
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
|
||||||
|
thanks_dev: # Replace with a single thanks.dev username
|
||||||
|
custom: 'https://dalink.to/dexoron'
|
||||||
51
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
51
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
---
|
||||||
|
name: Bug Report
|
||||||
|
about: Something is broken or behaves unexpectedly
|
||||||
|
title: "[bug] "
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- A clear and concise description of the bug -->
|
||||||
|
|
||||||
|
## Steps to Reproduce
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
|
||||||
|
<!-- What should have happened -->
|
||||||
|
|
||||||
|
## Actual Behavior
|
||||||
|
|
||||||
|
<!-- What actually happened, include full error output -->
|
||||||
|
|
||||||
|
```
|
||||||
|
paste error output here
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
- **DCR version** (`dcr --version`):
|
||||||
|
- **OS**:
|
||||||
|
- **Compiler / toolchain** (`gcc --version` or `clang --version`):
|
||||||
|
|
||||||
|
## Minimal Reproducible Project
|
||||||
|
|
||||||
|
<!-- If possible, share a minimal dcr.toml + source that reproduces the issue -->
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# dcr.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
```c
|
||||||
|
// src/main.c
|
||||||
|
```
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
|
||||||
|
<!-- Anything else that might help -->
|
||||||
35
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
35
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
---
|
||||||
|
name: Feature Request
|
||||||
|
about: Suggest an idea or improvement
|
||||||
|
title: "[feat] "
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
## Problem / Motivation
|
||||||
|
|
||||||
|
<!-- What problem does this solve? What are you trying to do that's currently hard or impossible? -->
|
||||||
|
|
||||||
|
## Proposed Solution
|
||||||
|
|
||||||
|
<!-- Describe what you want. Be as specific as possible — CLI flags, config syntax, behavior -->
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
<!-- Show how it would look in practice (command, dcr.toml snippet, output) -->
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# example command
|
||||||
|
```
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# example config
|
||||||
|
```
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
<!-- Have you tried workarounds? Are there other ways to solve this? -->
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
|
||||||
|
<!-- Links, prior art, related issues, etc. -->
|
||||||
136
.github/workflows/aur.yml
vendored
136
.github/workflows/aur.yml
vendored
@@ -1,136 +0,0 @@
|
|||||||
name: AUR Publish
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
version:
|
|
||||||
description: "Tag version without v prefix (e.g. 0.2.2)"
|
|
||||||
required: true
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- "v*"
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish-aur:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment: aur
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Derive version and checksum
|
|
||||||
id: meta
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
if [[ "${GITHUB_EVENT_NAME}" == "workflow_dispatch" ]]; then
|
|
||||||
PKGVER="${{ inputs.version }}"
|
|
||||||
else
|
|
||||||
PKGVER="${GITHUB_REF_NAME#v}"
|
|
||||||
fi
|
|
||||||
SRC_URL="https://github.com/dexoron/dcr/archive/refs/tags/v${PKGVER}.tar.gz"
|
|
||||||
SHA256="$(curl -fsSL "$SRC_URL" | sha256sum | awk '{print $1}')"
|
|
||||||
|
|
||||||
echo "pkgver=$PKGVER" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "source_url=$SRC_URL" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "sha256=$SHA256" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
- name: Render AUR metadata
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
PKGVER='${{ steps.meta.outputs.pkgver }}'
|
|
||||||
SRC_URL='${{ steps.meta.outputs.source_url }}'
|
|
||||||
SHA256='${{ steps.meta.outputs.sha256 }}'
|
|
||||||
|
|
||||||
cat > packaging/aur/dcr/PKGBUILD <<PKG
|
|
||||||
pkgname=dcr
|
|
||||||
pkgver=${PKGVER}
|
|
||||||
pkgrel=1
|
|
||||||
pkgdesc="Cargo-like utility to manage C/C++ projects"
|
|
||||||
arch=('x86_64' 'aarch64')
|
|
||||||
url="https://github.com/dexoron/dcr"
|
|
||||||
license=('MIT')
|
|
||||||
depends=('gcc-libs')
|
|
||||||
makedepends=('cargo')
|
|
||||||
options=('!lto')
|
|
||||||
optdepends=(
|
|
||||||
'gcc: build C/C++ projects with GCC'
|
|
||||||
'clang: build C/C++ projects with Clang'
|
|
||||||
)
|
|
||||||
source=("\$pkgname-\$pkgver.tar.gz::\$url/archive/refs/tags/v\$pkgver.tar.gz")
|
|
||||||
sha256sums=('${SHA256}')
|
|
||||||
|
|
||||||
build() {
|
|
||||||
cd "\$srcdir/\$pkgname-\$pkgver"
|
|
||||||
export CARGO_PROFILE_RELEASE_LTO=false
|
|
||||||
export RUSTFLAGS="\${RUSTFLAGS:-}"
|
|
||||||
export RUSTFLAGS="\${RUSTFLAGS/-C link-arg=-fuse-ld=lld/}"
|
|
||||||
cargo build --release --locked
|
|
||||||
}
|
|
||||||
|
|
||||||
package() {
|
|
||||||
cd "\$srcdir/\$pkgname-\$pkgver"
|
|
||||||
install -Dm755 "target/release/dcr" "\$pkgdir/usr/bin/dcr"
|
|
||||||
install -Dm644 LICENSE "\$pkgdir/usr/share/licenses/\$pkgname/LICENSE"
|
|
||||||
}
|
|
||||||
PKG
|
|
||||||
|
|
||||||
cat > packaging/aur/dcr/.SRCINFO <<SRC
|
|
||||||
pkgbase = dcr
|
|
||||||
pkgdesc = Cargo-like utility to manage C/C++ projects
|
|
||||||
pkgver = ${PKGVER}
|
|
||||||
pkgrel = 1
|
|
||||||
url = https://github.com/dexoron/dcr
|
|
||||||
arch = x86_64
|
|
||||||
arch = aarch64
|
|
||||||
license = MIT
|
|
||||||
makedepends = cargo
|
|
||||||
depends = gcc-libs
|
|
||||||
optdepends = gcc: build C/C++ projects with GCC
|
|
||||||
optdepends = clang: build C/C++ projects with Clang
|
|
||||||
options = !lto
|
|
||||||
source = dcr-${PKGVER}.tar.gz::${SRC_URL}
|
|
||||||
sha256sums = ${SHA256}
|
|
||||||
|
|
||||||
pkgname = dcr
|
|
||||||
SRC
|
|
||||||
|
|
||||||
- name: Push to AUR
|
|
||||||
env:
|
|
||||||
AUR_SSH_PRIVATE_KEY: ${{ secrets.AUR_SSH_PRIVATE_KEY }}
|
|
||||||
AUR_PACKAGE: dcr
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
if [[ -z "${AUR_SSH_PRIVATE_KEY:-}" ]]; then
|
|
||||||
echo "AUR_SSH_PRIVATE_KEY secret is missing"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
install -d -m 700 ~/.ssh
|
|
||||||
printf '%s\n' "$AUR_SSH_PRIVATE_KEY" > ~/.ssh/aur
|
|
||||||
chmod 600 ~/.ssh/aur
|
|
||||||
ssh-keyscan aur.archlinux.org >> ~/.ssh/known_hosts
|
|
||||||
|
|
||||||
export GIT_SSH_COMMAND='ssh -i ~/.ssh/aur -o IdentitiesOnly=yes'
|
|
||||||
git clone "ssh://aur@aur.archlinux.org/${AUR_PACKAGE}.git" aur-repo
|
|
||||||
cp packaging/aur/dcr/PKGBUILD aur-repo/PKGBUILD
|
|
||||||
cp packaging/aur/dcr/.SRCINFO aur-repo/.SRCINFO
|
|
||||||
|
|
||||||
cd aur-repo
|
|
||||||
git config user.name "github-actions[bot]"
|
|
||||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
||||||
|
|
||||||
if git diff --quiet; then
|
|
||||||
echo "No AUR changes"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
git add PKGBUILD .SRCINFO
|
|
||||||
git commit -m "dcr ${{ steps.meta.outputs.pkgver }}"
|
|
||||||
git push
|
|
||||||
109
.github/workflows/dexoron-packages-index.yml
vendored
Normal file
109
.github/workflows/dexoron-packages-index.yml
vendored
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
name: Dexoron Packages Index
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
tag:
|
||||||
|
description: "Версия (тег) для ручного импорта пакетов (например, v0.6.9)"
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["Release"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update-packages-index:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: ${{ github.event_name == 'workflow_dispatch' || github.event_workflow_run.conclusion == 'success' }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout Central Packages Repo
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
repository: 'dexoron/packages'
|
||||||
|
token: ${{ secrets.PACKAGES_REPO_TOKEN }}
|
||||||
|
path: 'central-packages'
|
||||||
|
|
||||||
|
- name: Import GPG Key
|
||||||
|
uses: crazy-max/ghaction-import-gpg@v6
|
||||||
|
with:
|
||||||
|
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
|
||||||
|
|
||||||
|
# --- Загрузка артефактов (сохранена прежняя логика) ---
|
||||||
|
- name: Download Artifacts
|
||||||
|
if: ${{ github.event_name == 'workflow_run' }}
|
||||||
|
uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
path: central-packages/
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ github.event.workflow_run.id }}
|
||||||
|
|
||||||
|
- name: Download Packages from Release Assets
|
||||||
|
if: ${{ github.event_name == 'workflow_dispatch' }}
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
TAG: ${{ inputs.tag }}
|
||||||
|
run: |
|
||||||
|
gh release download "$TAG" --repo dexoron/dcr --pattern "*.pkg.tar.zst" --dir central-packages/archlinux/x86_64/ --clobber
|
||||||
|
gh release download "$TAG" --repo dexoron/dcr --pattern "*.deb" --dir central-packages/debian/ --clobber
|
||||||
|
gh release download "$TAG" --repo dexoron/dcr --pattern "*.rpm" --dir central-packages/fedora/x86_64/ --clobber
|
||||||
|
|
||||||
|
# --- ИНДЕКСАЦИЯ И ПОДПИСЬ ---
|
||||||
|
|
||||||
|
- name: Update Pacman Database
|
||||||
|
run: |
|
||||||
|
docker run --rm \
|
||||||
|
-v ${{ github.workspace }}/central-packages:/packages \
|
||||||
|
-v ~/.gnupg:/root/.gnupg \
|
||||||
|
archlinux:latest \
|
||||||
|
bash -c '
|
||||||
|
cd /packages/archlinux/x86_64 && \
|
||||||
|
packages=(*.pkg.tar.zst) && \
|
||||||
|
repo-add --sign dexoron.db.tar.gz "${packages[@]}" && \
|
||||||
|
ln -sf dexoron.db.tar.gz dexoron.db && \
|
||||||
|
ln -sf dexoron.files.tar.gz dexoron.files
|
||||||
|
'
|
||||||
|
- name: Fix GPG permissions after Docker
|
||||||
|
run: sudo chown -R runner:runner ~/.gnupg
|
||||||
|
|
||||||
|
- name: Update Debian APT Repository Index
|
||||||
|
run: |
|
||||||
|
sudo apt-get update && sudo apt-get install -y dpkg-dev
|
||||||
|
cd central-packages/debian
|
||||||
|
dpkg-scanpackages . /dev/null | gzip -9c > Packages.gz
|
||||||
|
|
||||||
|
echo "Origin: Dexoron Packages" > Release
|
||||||
|
echo "Label: Dexoron Packages" >> Release
|
||||||
|
echo "Suite: stable" >> Release
|
||||||
|
echo "Codename: stable" >> Release
|
||||||
|
echo "Architectures: amd64" >> Release
|
||||||
|
echo "Components: main" >> Release
|
||||||
|
echo "Description: Dexoron binary package repository" >> Release
|
||||||
|
echo "Date: $(date -uR)" >> Release
|
||||||
|
echo "SHA256:" >> Release
|
||||||
|
echo " $(sha256sum Packages.gz | awk '{print $1" "$2}')" >> Release
|
||||||
|
|
||||||
|
gpg --batch --yes --pinentry-mode loopback --local-user 74322D39483E9C9E8C86C0AA0770A5C2A2A82DAC --detach-sign --armor --output Release.gpg Release
|
||||||
|
gpg --batch --yes --pinentry-mode loopback --local-user 74322D39483E9C9E8C86C0AA0770A5C2A2A82DAC --clearsign --output InRelease Release
|
||||||
|
|
||||||
|
- name: Update Fedora DNF Repository Index
|
||||||
|
run: |
|
||||||
|
sudo apt-get update && sudo apt-get install -y createrepo-c
|
||||||
|
cd central-packages/fedora/x86_64
|
||||||
|
createrepo_c .
|
||||||
|
gpg --batch --yes --detach-sign --armor --output repodata/repomd.xml.asc repodata/repomd.xml
|
||||||
|
|
||||||
|
- name: Push to dexoron/packages
|
||||||
|
run: |
|
||||||
|
cd central-packages
|
||||||
|
git config user.name "github-actions[bot]"
|
||||||
|
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||||
|
git add .
|
||||||
|
if ! git diff --cached --quiet; then
|
||||||
|
git commit -m "chore: update and sign repositories"
|
||||||
|
git push
|
||||||
|
fi
|
||||||
1226
.github/workflows/release.yml
vendored
1226
.github/workflows/release.yml
vendored
File diff suppressed because it is too large
Load Diff
5
.gitignore
vendored
5
.gitignore
vendored
@@ -2,4 +2,7 @@ target/
|
|||||||
sandbox/**
|
sandbox/**
|
||||||
.idea/
|
.idea/
|
||||||
.vscode/
|
.vscode/
|
||||||
.env
|
.cargo/
|
||||||
|
.env
|
||||||
|
|
||||||
|
personal/
|
||||||
126
AGENT.md
126
AGENT.md
@@ -1,126 +0,0 @@
|
|||||||
# AGENT.md
|
|
||||||
|
|
||||||
## Project Overview
|
|
||||||
|
|
||||||
**DCR (Dexoron Cargo Realization)** — CLI-утилита для управления C/C++/ASM проектами в стиле Cargo.
|
|
||||||
|
|
||||||
- **Язык реализации**: Rust (edition 2024)
|
|
||||||
- **Лицензия**: MIT
|
|
||||||
- **Репозиторий**: [github.com/dexoron/dcr](https://github.com/dexoron/dcr)
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
### Source Tree (`src/`)
|
|
||||||
|
|
||||||
```
|
|
||||||
src/
|
|
||||||
├── main.rs # Точка входа, маршрутизация CLI-команд
|
|
||||||
├── config.rs # Глобальные константы: профили сборки, шаблон main.c
|
|
||||||
├── cli/ # Реализация CLI-команд
|
|
||||||
│ ├── new.rs # dcr new <name>
|
|
||||||
│ ├── init.rs # dcr init
|
|
||||||
│ ├── build.rs # dcr build [--debug|--release]
|
|
||||||
│ ├── run.rs # dcr run [--debug|--release]
|
|
||||||
│ ├── clean.rs # dcr clean [--all]
|
|
||||||
│ ├── help.rs # dcr --help
|
|
||||||
│ └── flag_update.rs # dcr --update (self-update через GitHub Releases)
|
|
||||||
├── core/ # Бизнес-логика
|
|
||||||
│ ├── config.rs # Парсинг/валидация/форматирование dcr.toml (struct Config)
|
|
||||||
│ ├── deps.rs # Разрешение path-зависимостей, генерация dcr.lock
|
|
||||||
│ ├── runner.rs # Запуск скомпилированного бинарника
|
|
||||||
│ ├── workspace.rs # Поддержка [workspace] и упорядочивание сборки
|
|
||||||
│ └── builder/ # Бэкенды компиляторов/ассемблеров
|
|
||||||
│ ├── mod.rs # Общий интерфейс сборки
|
|
||||||
│ ├── gcc.rs # GCC backend
|
|
||||||
│ ├── clang.rs # Clang backend
|
|
||||||
│ ├── msvc.rs # MSVC backend
|
|
||||||
│ ├── nasm.rs # NASM backend (ASM)
|
|
||||||
│ └── gas.rs # GAS backend (ASM)
|
|
||||||
├── platform/ # Платформенно-зависимая логика
|
|
||||||
│ ├── mod.rs # Общий интерфейс платформ
|
|
||||||
│ ├── linux.rs
|
|
||||||
│ ├── macos.rs
|
|
||||||
│ └── windows.rs
|
|
||||||
└── utils/ # Вспомогательные утилиты
|
|
||||||
├── fs.rs # Работа с файловой системой
|
|
||||||
├── log.rs # Логирование (error, warn)
|
|
||||||
└── text.rs # Форматирование текста / цвета
|
|
||||||
```
|
|
||||||
|
|
||||||
### Key Concepts
|
|
||||||
|
|
||||||
- **`dcr.toml`** — конфигурационный файл проекта (аналог `Cargo.toml`). Секции: `[package]`, `[build]`, `[toolchain]`, `[dependencies]`, `[workspace]`.
|
|
||||||
- **Профили сборки**: `debug` (по умолчанию) и `release`. Встроенные флаги зависят от компилятора. Пользовательские флаги через `build.cflags` / `build.ldflags`.
|
|
||||||
- **Инкрементальная сборка**: объектные файлы кешируются по mtime. Отслеживание заголовков пока не реализовано (см. `TODO.md`).
|
|
||||||
- **Workspace**: корневой `dcr.toml` с секцией `[workspace]` описывает member-проекты и их зависимости; сборка происходит в топологическом порядке.
|
|
||||||
- **Path dependencies**: зависимости по путям автоматически добавляют include/lib-пути; генерируется `dcr.lock`.
|
|
||||||
- **Build kinds**: `bin` (бинарник), `staticlib` (`.a`), `sharedlib` (`.so`/`.dylib`/`.dll`).
|
|
||||||
|
|
||||||
## Supported Platforms
|
|
||||||
|
|
||||||
| Platform | Target triple |
|
|
||||||
|---|---|
|
|
||||||
| Linux | `x86_64-unknown-linux-gnu` |
|
|
||||||
| macOS Intel | `x86_64-apple-darwin` |
|
|
||||||
| macOS ARM | `aarch64-apple-darwin` |
|
|
||||||
| Windows | `x86_64-pc-windows-msvc` |
|
|
||||||
|
|
||||||
## Dependencies (Cargo)
|
|
||||||
|
|
||||||
| Crate | Purpose |
|
|
||||||
|---|---|
|
|
||||||
| `reqwest` | HTTP-запросы для `--update` (blocking, rustls-tls) |
|
|
||||||
| `serde` | Сериализация/десериализация |
|
|
||||||
| `toml` | Парсинг `dcr.toml` |
|
|
||||||
| `sha2` | Хеширование при обновлении |
|
|
||||||
| `self-replace` | Замена бинарника при `--update` |
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
### Build & Run
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cargo build # debug build
|
|
||||||
cargo build --release # release build
|
|
||||||
cargo run -- new hello # создать проект "hello"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Code Quality
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cargo fmt --all
|
|
||||||
cargo clippy --all-targets --all-features -- -D warnings
|
|
||||||
cargo check
|
|
||||||
cargo test
|
|
||||||
```
|
|
||||||
|
|
||||||
### CI/CD
|
|
||||||
|
|
||||||
- **CI**: `.github/workflows/ci.yml` — проверки при PR/push
|
|
||||||
- **Release**: `.github/workflows/release.yml` — сборка бинарников при пуше тега `v*`
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
- Интеграционные CLI-тесты: `tests/cli_basic.rs`
|
|
||||||
|
|
||||||
## Code Conventions
|
|
||||||
|
|
||||||
- Rust stable edition 2024
|
|
||||||
- Форматирование: `cargo fmt`
|
|
||||||
- Линтинг: `cargo clippy` без warnings
|
|
||||||
- Функции — маленькие и сфокусированные
|
|
||||||
- Имена — понятные и описательные
|
|
||||||
- Пользовательские сообщения CLI — на английском языке
|
|
||||||
- Вывод ошибок/предупреждений через `utils::log::{error, warn}`
|
|
||||||
|
|
||||||
## TODO
|
|
||||||
|
|
||||||
- В файле `TODO.md`
|
|
||||||
|
|
||||||
## Useful Links
|
|
||||||
|
|
||||||
- Документация проекта: `docs/`
|
|
||||||
- Changelog: `CHANGELOG.md`
|
|
||||||
- Contributing: `CONTRIBUTING.md`
|
|
||||||
- FAQ: `FAQ.md`
|
|
||||||
- Установка: `install.sh` (Linux/macOS), `install.ps1` (Windows)
|
|
||||||
56
AGENTS.md
Normal file
56
AGENTS.md
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo build --release && ./target/release/dcr setup
|
||||||
|
```
|
||||||
|
|
||||||
|
## Pre-PR (CI) gate
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo fmt --all --check
|
||||||
|
cargo clippy --all-targets --all-features -- -D warnings
|
||||||
|
cargo check --all-targets --all-features
|
||||||
|
cargo test
|
||||||
|
```
|
||||||
|
|
||||||
|
CI (`.github/workflows/ci.yml`) runs fmt, clippy, check — **not** tests.
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
- Integration tests in `tests/` build the dcr binary and run it in temp dirs under `sandbox/cli-tests/` (gitignored).
|
||||||
|
- Some tests **skip** if no C compiler (`gcc`/`clang`/`cc`) is found at runtime.
|
||||||
|
- Compiler can be overridden via `DCR_COMPILER` or `DCR_CC` env vars.
|
||||||
|
- Tests use `$CARGO_BIN_EXE_dcr` when available, else `target/debug/dcr`.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
- **Single Rust package** (edition 2024), not a workspace. Only one binary: `dcr`.
|
||||||
|
- **Entrypoint**: `src/main.rs` — matches `args[1]` against command names.
|
||||||
|
- **Compiler backends** in `src/core/builder/`: `unix_cc` (gcc/clang), `msvc` (cl/clang-cl), `gas`, `nasm`. Dispatched by matching compiler name string.
|
||||||
|
- **Config**: `dcr.toml` (per-project), `~/.dcr/config.toml` (registry), `~/.dcr/index.json` (index). Defaults: `language=c`, `standard=c11`, `compiler=clang`, `kind=bin`.
|
||||||
|
- **`build.rs`** embeds `TARGET` as `DCR_TARGET` env var (shown in `--version`).
|
||||||
|
- **CLI output** must be in English. Use `utils::log` for messaging.
|
||||||
|
|
||||||
|
## Key commands
|
||||||
|
|
||||||
|
| Command | Notes |
|
||||||
|
|---|---|
|
||||||
|
| `dcr new <name>` | Creates project dir |
|
||||||
|
| `dcr init` | Init from CWD (must be empty) |
|
||||||
|
| `dcr build [--debug\|--release] [--target <triple>]` | Default profile: `--debug` |
|
||||||
|
| `dcr run [--debug\|--release]` | Only for `kind = "bin"` |
|
||||||
|
| `dcr clean [--debug\|--release] [--all]` | `--all` for workspace roots |
|
||||||
|
| `dcr tree` | Dependency tree viewer |
|
||||||
|
| `dcr test [--init]` | Runs/test project tests |
|
||||||
|
| `dcr gen <vscode\|clion\|compile-commands>` | IDE integration |
|
||||||
|
| `dcr --update` | Self-update from GitHub Releases |
|
||||||
|
|
||||||
|
## Cross-compilation
|
||||||
|
|
||||||
|
`--target` accepts short names (`linux`, `macos`, `windows`) or full triples. In CI, Linux cross-builds use `cargo-zigbuild`. When `build.target` is set in `dcr.toml`, DCR auto-injects `--target=<value>` into cflags (clang). Bare-metal targets (containing `none`/`-elf`/`eabi`/`baremetal`) skip DCR's default compiler flags.
|
||||||
|
|
||||||
|
## Dependencies (Cargo)
|
||||||
|
|
||||||
|
reqwest (blocking+json+rustls-tls), serde, toml, git2, openssl (vendored), self-replace, sha2, ctrlc.
|
||||||
424
CHANGELOG.md
424
CHANGELOG.md
@@ -1,5 +1,421 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [0.7.4] - 2026-06-17 "Qt Поддержка, Linting и Рефакторинг Архитектуры / Qt Support, Linting, & Architecture Refactor"
|
||||||
|
|
||||||
|
### RU
|
||||||
|
|
||||||
|
**Добавлено:**
|
||||||
|
|
||||||
|
- **Нативная поддержка Qt** — добавлена автоматическая обработка мета-объектов (MOC, UIC, RCC) при включении `build.qt = true` в `dcr.toml`.
|
||||||
|
- **Команда `dcr lint`** — статический анализ C/C++ через `clang-tidy`. Поддерживает `--fix` для автоматического исправления. Уважает `build.roots` и `build.src_disable` из конфига.
|
||||||
|
- **Три новых ассемблерных бэкенда**:
|
||||||
|
- **MASM** (`compiler = "ml"` / `"ml64"`) — Microsoft Macro Assembler.
|
||||||
|
- **FASM** (`compiler = "fasm"`) — Flat Assembler.
|
||||||
|
- **LLVM IR** (`compiler = "llc"`) — компиляция `.ll` → объектный файл.
|
||||||
|
- **Общий ASM-пайплайн** — линковка и архивирование вынесены в `core/builder/asm.rs`. Новый ассемблерный бэкенд теперь пишется за ~30 строк.
|
||||||
|
- **Утилиты для файловой системы** — `to_hex()` и `home_dir()` вынесены в `utils/fs.rs`.
|
||||||
|
- **Утилиты для сборки** — `normalize_target()`, `normalize_kind()`, `normalize_platform()`, `default_profile_flags()` вынесены в `utils/build.rs`.
|
||||||
|
- **Утилиты для бэкендов** — `asm_lang_flag()`, `source_extensions()`, `elapsed_secs()` добавлены в `core/builder/common.rs`.
|
||||||
|
|
||||||
|
- **Полноценная автоматизация Bare-Metal / Freestanding** — добавлен конфигурационный флаг `build.freestanding = true`. При его включении (или при обнаружении bare-metal таргета) DCR автоматически инжектирует флаг `-ffreestanding` на этапе компиляции, а также `-nostdlib` и `-static` на этапе линковки.
|
||||||
|
- **Оптимизация артефактов (LTO и Strip)** — в `dcr.toml` добавлены параметры `build.lto` (авто-инжекция флага `-flto` для компилятора и линкера) и `build.strip` (автоматическое отсекание отладочной информации через флаг `-s` линкера).
|
||||||
|
- **Контроль многопоточности сборки** — добавлен параметр `build.codegen-units`, позволяющий жестко ограничить максимальное количество параллельных потоков сборки для кастомного движка `parallel_build`.
|
||||||
|
- **Управление паникой (Panic Abort)** — добавлен параметр `build.panic = "abort"`. Для C++ проектов он автоматически отключает генерацию таблиц раскрутки стека и исключений через флаги `-fno-exceptions`, `-fno-unwind-tables` и `-fno-asynchronous-unwind-tables`.
|
||||||
|
|
||||||
|
**Изменено:**
|
||||||
|
|
||||||
|
- **Интеллектуальные дефолтные флаги (DCR Defaults)** — генерация дефолтных флагов оптимизации (`-O3`/`-O0`), отладки (`-g`) и предупреждений (`-Wall -Wextra`) теперь автоматически отключается для bare-metal и freestanding целей, если пользователь переопределил `build.cflags`.
|
||||||
|
- **Глобальный вынос bare-metal детектора** — функция `is_bare_metal_target` вынесена в общие утилиты `src/utils/build.rs` для сквозного использования в конвейере сборки.
|
||||||
|
- **Рефакторинг архитектуры**:
|
||||||
|
- `src/config.rs` переименован в `src/templates.rs`.
|
||||||
|
- Начата консолидация конфигурационной логики и оркестрации сборки.
|
||||||
|
|
||||||
|
### EN
|
||||||
|
|
||||||
|
**Added:**
|
||||||
|
|
||||||
|
- **Native Qt support** — automatic meta-object handling (MOC, UIC, RCC) added when `build.qt = true` is set in `dcr.toml`.
|
||||||
|
- **`dcr lint` command** — C/C++ static analysis via `clang-tidy`. Supports `--fix` for automatic fixes. Respects `build.roots` and `build.src_disable` from config.
|
||||||
|
- **Three new assembler backends**:
|
||||||
|
- **MASM** (`compiler = "ml"` / `"ml64"`) — Microsoft Macro Assembler.
|
||||||
|
- **FASM** (`compiler = "fasm"`) — Flat Assembler.
|
||||||
|
- **LLVM IR** (`compiler = "llc"`) — compiles `.ll` files via `llc -filetype=obj`.
|
||||||
|
- **Shared ASM pipeline** — linking and archiving logic consolidated into `core/builder/asm.rs`. Adding a new assembler backend now takes ~30 lines.
|
||||||
|
- **Filesystem utilities** — `to_hex()` and `home_dir()` extracted to `utils/fs.rs`.
|
||||||
|
- **Build utilities** — `normalize_target()`, `normalize_kind()`, `normalize_platform()`, `default_profile_flags()` extracted to `utils/build.rs`.
|
||||||
|
- **Backend helpers** — `asm_lang_flag()`, `source_extensions()`, `elapsed_secs()` added to `core/builder/common.rs`.
|
||||||
|
|
||||||
|
- **Full Bare-Metal / Freestanding Automation** — introduced the `build.freestanding = true` configuration option. When enabled (or when a bare-metal target is detected), DCR automatically injects `-ffreestanding` during compilation and both `-nostdlib` and `-static` during linking.
|
||||||
|
- **Artifact Optimization (LTO & Strip)** — added `build.lto` (auto-injects `-flto` for compiler and linker) and `build.strip` (automatically strips debug symbols via linker `-s` flag) options to `dcr.toml`.
|
||||||
|
- **Compilation Thread Control** — added the `build.codegen-units` option to strictly limit the maximum number of parallel jobs utilized by the custom `parallel_build` worker pool.
|
||||||
|
- **Panic Behavior Management** — added `build.panic = "abort"` support. For C++ targets, it automatically strips exception handling and unwind tables via `-fno-exceptions`, `-fno-unwind-tables`, and `-fno-asynchronous-unwind-tables`.
|
||||||
|
|
||||||
|
**Changed:**
|
||||||
|
|
||||||
|
- **Intelligent Default Flags Generation** — automated injection of fallback optimization (`-O3`/`-O0`), debug (`-g`), and warning (`-Wall -Wextra`) flags is now suppressed for bare-metal and freestanding builds if `build.cflags` are overridden.
|
||||||
|
- **Centralized Bare-Metal Detection** — relocated the `is_bare_metal_target` helper to common build utilities (`src/utils/build.rs`) for unified access across the building core.
|
||||||
|
- **Architectural Refactoring**:
|
||||||
|
- Renamed `src/config.rs` to `src/templates.rs`.
|
||||||
|
- Started consolidation of configuration and build orchestration logic.
|
||||||
|
|
||||||
|
## [0.7.3] - 2026-06-13 "Оптимизация Зависимостей и VCS / Dependency Optimization & VCS"
|
||||||
|
|
||||||
|
### RU
|
||||||
|
|
||||||
|
**Добавлено:**
|
||||||
|
|
||||||
|
- **Параметр `--vcs` для команд `new` и `init`** — добавлена возможность явно указывать систему контроля версий через `--vcs <git|none>`.
|
||||||
|
- **Интеграция Git-информации в `--version`** — утилита теперь выводит текущий короткий хэш коммита и суффикс `-dirty`, если в репозитории DCR есть незакоммиченные изменения.
|
||||||
|
- **Автоматическая генерация `.gitignore`** — при инициализации Git-репозитория автоматически создается файл `.gitignore` с исключением директории `/target`.
|
||||||
|
- **Защита от вложенных репозиториев** — автоматическая инициализация Git теперь пропускается, если `dcr new` или `dcr init` запускаются внутри уже существующего Git-репозитория.
|
||||||
|
- **Тесты для верификации VCS** — добавлены интеграционные тесты `new_vcs_options_work` и `init_vcs_options_work` для проверки логики инициализации репозиториев.
|
||||||
|
|
||||||
|
**Изменено:**
|
||||||
|
|
||||||
|
- **Полный отказ от библиотеки `git2`** — работа с Git (клонирование зависимостей, инициализация VCS, проверка статуса) переведена на вызовы системного `git` через `Command`. Это облегчает сборку проекта и убирает необходимость в фичах `vendored` и `openssl`.
|
||||||
|
- **Миграция с `reqwest` на `ureq`** — в модуле обновления (`flag_update.rs`) тяжелый `reqwest` заменен на легковесный синхронный клиент `ureq 2.10`, что уменьшило оверхед и размер итогового бинарника.
|
||||||
|
|
||||||
|
### EN
|
||||||
|
|
||||||
|
**Added:**
|
||||||
|
|
||||||
|
- **`--vcs` option for `new` and `init` commands** — introduced explicit version control system selection via `--vcs <git|none>`.
|
||||||
|
- **Git metadata integration in `--version`** — the CLI now appends the current short commit hash and a `-dirty` suffix if there are uncommitted changes in the DCR repository.
|
||||||
|
- **Automatic `.gitignore` generation** — Git repository initialization now automatically writes a `.gitignore` file excluding the `/target` directory.
|
||||||
|
- **Nested repository prevention** — automatic Git initialization is now skipped if `dcr new` or `dcr init` is executed inside an already existing Git repository.
|
||||||
|
- **VCS verification tests** — added `new_vcs_options_work` and `init_vcs_options_work` integration tests to ensure reliable repository behavior.
|
||||||
|
|
||||||
|
**Changed:**
|
||||||
|
|
||||||
|
- **Complete removal of `git2` dependency** — all Git actions (dependency fetching, VCS setup, status checks) are now delegated to the system `git` executable via `Command`. This simplifies compilation and drops the need for `vendored` and `openssl` features.
|
||||||
|
- **Migrated from `reqwest` to `ureq`** — replaced the heavy `reqwest` crate in `flag_update.rs` with the lightweight synchronous `ureq 2.10` client, reducing overhead and the final binary size.
|
||||||
|
|
||||||
|
## [0.7.2] - 2026-06-07 "Исправление Таргетов и Линковки / Target & Linker Fixes"
|
||||||
|
|
||||||
|
### RU
|
||||||
|
|
||||||
|
**Добавлено:**
|
||||||
|
- Учтён `target_env` в `default_target_triple()` — Linux (gnu/musl) и Windows (msvc/gnu) теперь используют правильное окружение, а не хардкод.
|
||||||
|
|
||||||
|
**Исправлено:**
|
||||||
|
- **Сборка на macOS Apple Silicon падала с `_main` undefined** — `--target=` теперь передаётся и в ldflags, не только в cflags. `default_target_triple()` на macOS использует `std::env::consts::ARCH` вместо хардкода `x86_64`.
|
||||||
|
- **Бейджи GitHub Stars и GPL-3.0 не рендерились в README** — блок бейджей переведён на чистый HTML.
|
||||||
|
|
||||||
|
**Изменено:**
|
||||||
|
- Вычисление таргета по умолчанию вынесено в общую функцию `default_target_triple()` — устранено дублирование в build, run, clean.
|
||||||
|
|
||||||
|
### EN
|
||||||
|
|
||||||
|
**Added:**
|
||||||
|
- `default_target_triple()` now respects `target_env` — Linux (gnu/musl) and Windows (msvc/gnu) use the correct environment instead of hardcoded values.
|
||||||
|
|
||||||
|
**Fixed:**
|
||||||
|
- **macOS Apple Silicon builds failed with `_main` undefined** — `--target=` is now passed to ldflags, not just cflags. `default_target_triple()` uses `std::env::consts::ARCH` on macOS instead of hardcoded `x86_64`.
|
||||||
|
- **GitHub Stars and GPL-3.0 badges not rendering in README** — badge block converted to pure HTML.
|
||||||
|
|
||||||
|
**Changed:**
|
||||||
|
- Default target resolution extracted into shared `default_target_triple()` — removed duplication across build, run, clean.
|
||||||
|
|
||||||
|
## [0.7.1] - 2026-06-02 "Мультиархитектурное расширение / The Multi-Arch Expansion"
|
||||||
|
|
||||||
|
### RU
|
||||||
|
|
||||||
|
**Добавлено:**
|
||||||
|
- Вывод `--help` для всех команд с цветным форматированием.
|
||||||
|
- man-страницы (12 штук в `man/man1/`) и их установка во всех пакетах.
|
||||||
|
- Валидация имен проектов в `dcr init` и `dcr new` (только ASCII буквы, цифры, `_` и `-`).
|
||||||
|
- Метаданные `documentation` и `homepage` в `Cargo.toml`.
|
||||||
|
- Оптимизация сборки: `opt-level = "z"`, LTO, `codegen-units = 1`, `panic = "abort"`, `strip = true`.
|
||||||
|
- Поддержка новых архитектур (i686, armv7, riscv64gc, aarch64) в рабочих процессах и установочных скриптах.
|
||||||
|
- Сборка пакетов `deb` и `rpm` для всех 5 архитектур Linux через `cargo-zigbuild`.
|
||||||
|
- Пакеты AUR (`dcr-dev`, `dcr-dev-bin`) и сборка Snap в CI.
|
||||||
|
|
||||||
|
**Изменено:**
|
||||||
|
- Функция `validate_package_name` стала публичной.
|
||||||
|
- Команды `gen`, `tree`, `fmt`, `setup` больше не игнорируют аргументы и используют цветной вывод.
|
||||||
|
- Инструкция в README изменена с `| bash` на `| sh` для POSIX.
|
||||||
|
- Отключена архитектура Windows 32-bit (GNU) из-за проблем со сборкой.
|
||||||
|
|
||||||
|
**Исправлено:**
|
||||||
|
|
||||||
|
- **`dcr new <invalid-name>` создаёт директорию, затем падает** — валидация теперь происходит до операций с файлами.
|
||||||
|
- **`dcr init` создаёт dcr.toml, затем падает при невалидном имени директории** — то же исправление.
|
||||||
|
- **Man-страницы отсутствовали после установки** — теперь устанавливаются через скрипты установки, пакетные менеджеры и Homebrew.
|
||||||
|
- **Ложное срабатывание на букву диска в Windows** — в парсинге файлов зависимостей.
|
||||||
|
- **CRLF `\r\n` ломает парсер зависимостей** — теперь обрабатываются смешанные окончания строк.
|
||||||
|
- **Новая строка после обратного слеша не поглощалась** — в обработке escape-последовательностей `parse_d_file`.
|
||||||
|
|
||||||
|
### EN
|
||||||
|
|
||||||
|
**Added:**
|
||||||
|
- `--help` for all commands with styled headers and usage lines.
|
||||||
|
- Man pages (12 troff man pages in `man/man1/`) and their installation across all packaging formats.
|
||||||
|
- Project name validation in `dcr init` and `dcr new` (ASCII letters, digits, `_`, `-` only).
|
||||||
|
- `documentation` and `homepage` metadata in `Cargo.toml`.
|
||||||
|
- Release profile optimizations (`opt-level = "z"`, LTO, `codegen-units = 1`, `panic = "abort"`, `strip = true`).
|
||||||
|
- Linux i686, armv7, riscv64gc, aarch64 architecture support in release workflows and installation scripts.
|
||||||
|
- Multi-arch `deb` and `rpm` package builds for all 5 Linux architectures via `cargo-zigbuild`.
|
||||||
|
- AUR packages (`dcr-dev`, `dcr-dev-bin`) and Snap build in CI.
|
||||||
|
|
||||||
|
**Changed:**
|
||||||
|
- `validate_package_name` made public and callable from CLI commands directly.
|
||||||
|
- `gen.rs`, `tree.rs`, `fmt.rs`, `setup.rs` no longer ignore arguments and use styled output.
|
||||||
|
- README install instructions changed from `| bash` to `| sh` for POSIX compatibility.
|
||||||
|
- Disabled Windows 32-bit (GNU) target due to build issues.
|
||||||
|
|
||||||
|
Fixed:
|
||||||
|
|
||||||
|
- **`dcr new <invalid-name>` creates directory then fails** — validation now happens
|
||||||
|
before any file operations.
|
||||||
|
- **`dcr init` creates dcr.toml then fails on invalid directory name** — same fix.
|
||||||
|
- **Man pages missing after installation** — now installed via install scripts,
|
||||||
|
package managers, and Homebrew.
|
||||||
|
- **Windows drive letter false positive** — in dependency file parsing.
|
||||||
|
- **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-02
|
||||||
|
|
||||||
|
Added:
|
||||||
|
|
||||||
|
- **OpenBSD and NetBSD target support** — full platform routing with dynamically generated target triples using `std::env::consts::ARCH` and `std::env::consts::OS`. Affects `build`, `run`, `clean`, and the platform module.
|
||||||
|
- **`src/platform/bsd.rs`** — new dedicated BSD platform module shared by FreeBSD, OpenBSD, NetBSD, providing `bin_path`, `lib_path`, `elf_path`, `efi_path`, and `shared_lib_path`.
|
||||||
|
- **`build.out_dir` configuration 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()` function in `common.rs` that checks whether any object file is newer than the linked output, skipping unnecessary re-linking. Implemented for all backends (`unix_cc`, `msvc`, `gas`, `nasm`).
|
||||||
|
- **`build.kind = "none"` and `"custom"`** — two new project kind types for special build scenarios where no standard artifact is produced.
|
||||||
|
- **`install_bsd.sh`** — dedicated POSIX-compliant install 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 triple detection for pre-built binary downloads.
|
||||||
|
- **BSD OS detection in `install.sh`** — FreeBSD, OpenBSD, NetBSD detection and target triple resolution.
|
||||||
|
- **`rust-toolchain.toml`** — explicit `stable` channel toolchain pinning.
|
||||||
|
- **Nix support** — `flake.nix` for Nix package manager. Run via `nix run github:dexoron/dcr` or install with `nix profile install github:dexoron/dcr`. Contributed by community contributor.
|
||||||
|
- **Snapcraft publish** — `dcrup` published on Snapcraft. Install with `sudo snap install dcrup`.
|
||||||
|
- **Integration tests** — `build_with_target_config` (verifies `build.target = "linux"`) and `build_with_out_dir` (verifies custom output directory).
|
||||||
|
- **`get_build_string_with_profile` made `pub`** — so `run.rs` can resolve custom output directory configuration.
|
||||||
|
|
||||||
|
Changed:
|
||||||
|
|
||||||
|
- **`build.target` semantics changed** — now strictly holds the target triple (e.g. `x86_64-unknown-linux-gnu`) or a short name (`linux`, `macos`, `windows`). No longer doubles as a custom output directory — that 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 when empty.
|
||||||
|
- **`dcr run` with `out_dir`** — now resolves target directory respecting `build.out_dir` when configured, via `get_build_string_with_profile()` from `build.rs`.
|
||||||
|
- **`collect_sources()` returns empty vec** instead of error when no source files are found, allowing `kind = "none"` or `kind = "custom"` projects to have 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 sanitization (dashes → dots), NetBSD `gmake` symlink.
|
||||||
|
- **README compatibility table** — FreeBSD, OpenBSD, NetBSD build/runtime status upgraded from community/best-effort to officially supported.
|
||||||
|
- **Documentation rewritten** — available at [dcr.dexoron.su/docs](https://dcr.dexoron.su/docs) or in the `docs/` directory. Installation guides, commands, and reference updated to reflect current CLI and config format.
|
||||||
|
- **Site rewritten** — `dcr-site` migrated to Docusaurus with internationalization (i18n) support, improved navigation, and updated content across all sections.
|
||||||
|
- **Dev channel dependency check in `install.sh`** — checks for `python3` or `jq` before attempting dev channel installations.
|
||||||
|
|
||||||
|
Fixed:
|
||||||
|
|
||||||
|
- **`dcr run` stdout/stderr not inherited** — child process output was captured and manually printed, breaking interactive programs. Fixed by switching to `Command::status()`.
|
||||||
|
- **Release CI race condition** — build matrix jobs could upload assets to a release that did not yet exist. Fixed by adding a dedicated `create-release` job.
|
||||||
|
- **GHA release — stable toolchain override** — resolved Rust toolchain override issues in CI.
|
||||||
|
- **Arch Linux package version sanitization** — version strings with dashes (e.g. `0.7.0-dev`) are invalid for Arch Linux `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 package artifact paths** — RPM artifacts placed under `rpm/x86_64/` instead of `fedora/x86_64/`. Corrected in Dexoron Packages Index workflow.
|
||||||
|
- **`install.sh` JSON parsing robustness** — added `jq` as primary parser with `python3` fallback for dev channel release lookups.
|
||||||
|
|
||||||
|
Removed:
|
||||||
|
|
||||||
|
- **`format_roots()` helper** — removed from `common.rs`. Was only used by the old error path in `collect_sources()`.
|
||||||
|
- **Individual per-distro artifact download steps** — three separate `actions/download-artifact` steps replaced with unified `gh release download --clobber`.
|
||||||
|
|
||||||
|
## [0.6.9] - 2026-05-28
|
||||||
|
|
||||||
|
Added:
|
||||||
|
|
||||||
|
- **Dexoron Packages Index** — new standalone CI workflow (`.github/workflows/dexoron-packages-index.yml`)
|
||||||
|
that automatically updates the `dexoron/packages` repository indexes after a release.
|
||||||
|
Supports Arch Linux (`repo-add`), Debian (`dpkg-scanpackages`), and Fedora (`createrepo_c`).
|
||||||
|
Triggered by `workflow_dispatch` or `workflow_run` on the Release workflow.
|
||||||
|
|
||||||
|
- **Arch Linux native package** (`.pkg.tar.zst`) build inside the release workflow —
|
||||||
|
builds from source in an `archlinux:latest` Docker container using a dynamically
|
||||||
|
generated PKGBUILD.
|
||||||
|
|
||||||
|
- **AUR publish support** — new `run_aur` workflow dispatch input and `publish-aur` /
|
||||||
|
`publish-aur-bin` jobs that push PKGBUILD / `.SRCINFO` to `aur.archlinux.org`.
|
||||||
|
|
||||||
|
Changed:
|
||||||
|
|
||||||
|
- **Release workflow refactored** — Linux packages (deb, rpm, snap, arch) and BSD
|
||||||
|
builds now use `strategy.matrix` instead of separate jobs. A new
|
||||||
|
`publish-dexoron-packages` job collects all package artifacts and uploads them
|
||||||
|
to the GitHub Release in one step. Removed standalone `build-arch-package`,
|
||||||
|
`build-snap`, `build-deb-rpm` jobs. The old `run_arch_native` input is now
|
||||||
|
`run_linux_packages`.
|
||||||
|
|
||||||
|
- **Dexoron Packages Index workflow** extracted from `release.yml` into its own
|
||||||
|
file with support for Debian and RPM repository indexes in addition to Arch.
|
||||||
|
|
||||||
|
- **git2 vendoring** — enabled `vendored-libgit2` and `vendored-openssl` features
|
||||||
|
for reproducible CI builds without system libraries.
|
||||||
|
|
||||||
|
- **cargo-generate-rpm metadata** — updated to the current `package.metadata.rpm`
|
||||||
|
format (uses `files` table instead of `assets` array).
|
||||||
|
|
||||||
|
Fixed:
|
||||||
|
|
||||||
|
- **`--target=<triple>` no longer passed to GCC** — the flag is now only injected into
|
||||||
|
cflags when the resolved compiler name contains `"clang"`. GCC rejects this flag
|
||||||
|
with `unrecognized command-line option`.
|
||||||
|
|
||||||
|
- **Workspace clean test** — removed assertions for member-local `target/`
|
||||||
|
directories. Workspace members share the root `target/` directory, so their
|
||||||
|
individual `src/<name>/target/` is never created.
|
||||||
|
|
||||||
|
- **Release build test path** — corrected expected directory from `target/release`
|
||||||
|
to `target/x86_64-unknown-linux-gnu/release`.
|
||||||
|
|
||||||
|
## [0.6.8] - 2026-05-27
|
||||||
|
|
||||||
|
Added:
|
||||||
|
|
||||||
|
- `build.cxx_standard` — separate C++ language standard for `.cpp`/`.cxx`/`.cc` files.
|
||||||
|
When set, overrides `build.standard` for C++ sources. Example:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[build]
|
||||||
|
language = ["c", "c++"]
|
||||||
|
standard = "gnu11"
|
||||||
|
cxx_standard = "gnu++17"
|
||||||
|
```
|
||||||
|
|
||||||
|
- Variable substitution for `cflags`, `ldflags`, and `include` directory entries.
|
||||||
|
All `{version}`, `{version_major}`, `{name}`, `{profile}` and other step variables
|
||||||
|
are now available. Example:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[build]
|
||||||
|
cflags = ['-DPROJECT_VERSION="{version}"']
|
||||||
|
```
|
||||||
|
|
||||||
|
- FreeBSD build support in CI — new `run_bsd` workflow input and `build-bsd` job
|
||||||
|
that cross-compiles `x86_64-unknown-freebsd` via `cargo-zigbuild`.
|
||||||
|
|
||||||
|
Changed:
|
||||||
|
|
||||||
|
- License changed from MIT to **GPL-3.0-or-later**. All source files now carry
|
||||||
|
the GPL-3.0 header. Default license in `dcr new` / `dcr init` changed to
|
||||||
|
`"GPL-3.0-or-later"`. README, FAQ, and CONTRIBUTING.md updated accordingly.
|
||||||
|
- `get_list_with_profile_and_target` no longer duplicates list values when
|
||||||
|
`inherit = true` and the profile/target value is identical to the base value.
|
||||||
|
|
||||||
|
Fixed:
|
||||||
|
|
||||||
|
- Multi-language `language` array (e.g. `["c", "c++", "asm"]`) no longer drops `c++`
|
||||||
|
during internal parsing — `.cxx`/`.cpp`/`.cc` source files are correctly discovered
|
||||||
|
and compiled.
|
||||||
|
- `-std=` flag is no longer passed to C++ files when only `standard` (C standard) is
|
||||||
|
configured — uses `cxx_standard` when available, otherwise skips `-std=` for C++
|
||||||
|
sources, avoiding clang error `invalid argument '-std=c11' not allowed with 'C++'`.
|
||||||
|
- Object file collision: source files with the same stem but different extensions
|
||||||
|
(e.g. `gdt.cxx` and `gdt.S`) no longer overwrite each other. Object filenames
|
||||||
|
now include the original source extension (e.g. `gdt.cxx.o`, `gdt.S.o`).
|
||||||
|
- MSVC backend compile step now detects language per source file extension instead
|
||||||
|
of using the global `language` field, fixing mixed C/C++ compilation with MSVC.
|
||||||
|
- Assembler `-x` flag in `unix_cc.rs` and `gen.rs` is now placed **before** the
|
||||||
|
source file, as required by clang/gcc.
|
||||||
|
- `{version}` variables in `build.clean` are now correctly substituted.
|
||||||
|
|
||||||
|
## [0.6.7] - 2026-05-26
|
||||||
|
|
||||||
|
Added:
|
||||||
|
|
||||||
|
- `build.kind = "efi"` — UEFI PE32+ executable support. Links with `-shared -nostdlib -Wl,-dll -Wl,--subsystem,10`, output via `efi_path()` with `.efi` extension, rejected by `dcr run`.
|
||||||
|
- `build.kind = "elf"` — bare-metal ELF executable support. Uses `elf_path()` output path, rejected by `dcr run`, no extra linker flags.
|
||||||
|
- `build.filename` and `build.extension` in `dcr.toml` — complete control over the final artifact name without relying on `package.name`.
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[build]
|
||||||
|
filename = "KERNEL"
|
||||||
|
extension = "EFI"
|
||||||
|
```
|
||||||
|
|
||||||
|
Produces `KERNEL.EFI` (works for `bin`, `staticlib`, and `sharedlib`).
|
||||||
|
- Automatic injection of `--target=<build.target>` into compiler flags when `build.target` is set in `dcr.toml`. This greatly simplifies clang-based cross-compilation (especially for bare-metal targets like `aarch64-none-elf`).
|
||||||
|
- Bare-metal targets (containing `none`, `-elf`, `eabi`, `baremetal`) no longer receive DCR's internal default flags (`-g`, `-Wall`, `-Wextra`, `-fno-omit-frame-pointer`, `-DDCR_DEBUG`, etc.). Prevents unwanted sections (`.comment`, debug info, etc.) that break custom linker scripts when `inherit = true`.
|
||||||
|
- `build.ldscript` in `dcr.toml` — linker script path passed as `-T <path>` to the linker. Essential for bare-metal/embedded/freestanding targets.
|
||||||
|
- `dcr build --verbose` — prints compiler/linker command lines (also works with `DCR_DEBUG` env var).
|
||||||
|
- `dcr add <name>` without a source argument — if a registry is configured, DCR looks up the package by name and adds it as a version dependency.
|
||||||
|
|
||||||
|
Fixed:
|
||||||
|
|
||||||
|
- `build.target` declared in `dcr.toml` is now correctly used as the default target even when `--target` is not passed on the command line (previously the host target was always forced for config resolution).
|
||||||
|
- `dcr run` with `--target` or `build.target` now correctly finds the binary in the arch-specific target directory.
|
||||||
|
- `dcr run` checks profile-specific `build.{profile}.kind` before rejecting library builds (previously only checked `build.kind`).
|
||||||
|
- `dcr clean` now reads `build.target` from `dcr.toml` when no `--target` flag is given.
|
||||||
|
- Linux: target directory is now consistent — `target/<arch>-unknown-linux-gnu/<profile>/` (no stale `target/<profile>/`).
|
||||||
|
- `dcr.lock` is now populated with all resolved dependencies (registry, path, git) instead of being always empty.
|
||||||
|
- Git dependencies are now properly recognized and recorded in `dcr.lock`.
|
||||||
|
- `is_registry_dep` correctly identifies version-based registry dependency tables (`{ version = "..." }`) and rejects tables with unknown keys.
|
||||||
|
- `dcr test` accepts `--debug`/`--release` flags (defaults to `debug` profile instead of always `release`).
|
||||||
|
- Build fingerprint cache (`build_cache_path`) now includes `target_dir` — different targets no longer share a single cache entry.
|
||||||
|
- `object_path` no longer hardcodes the `src/` prefix — works correctly with custom `build.roots` (e.g. `roots = ["lib"]`).
|
||||||
|
- `dcr update` now generates `.exe` candidates for all Windows targets, not just `x86_64-pc-windows-msvc`.
|
||||||
|
- Compiler existence is verified before starting the build (clear error if compiler is not found in PATH).
|
||||||
|
- Consolidated duplicate `OUTPUT_MUTEX` definitions — MSVC backend now uses the shared mutex from `common.rs`.
|
||||||
|
- Registry cache root directory is created if missing (prevents cryptic errors when `~/.dcr/` does not exist).
|
||||||
|
|
||||||
|
Changed:
|
||||||
|
|
||||||
|
- `openssl` dependency is now conditional (`cfg(not(windows))`) — no longer pulled in on Windows, fixing Windows CI builds that lack Perl `Locale::Maketext::Simple`. On Linux (including musl cross-compilation) the vendored OpenSSL build is unchanged.
|
||||||
|
|
||||||
|
## [0.6.6] - 2026-05-18
|
||||||
|
|
||||||
|
Fixed:
|
||||||
|
|
||||||
|
- Path dependencies now work correctly: `dcr add` stores them as `{ path =
|
||||||
|
"./..." }` tables, `is_registry_dep` properly distinguishes registry strings
|
||||||
|
from path/git strings, and `deps/mod.rs` resolves both table-form and
|
||||||
|
legacy string-form path dependencies
|
||||||
|
- Registry dependency paths no longer hardcoded to `project_root/dcr-index`;
|
||||||
|
now use `package_root_from_registry_info()` which resolves relative to the
|
||||||
|
registry cache root (`~/.dcr/`)
|
||||||
|
- Registry dependencies are now actually built: `build_project_at()` is
|
||||||
|
called when `include_dir` or `lib_dir` is missing
|
||||||
|
|
||||||
|
Added:
|
||||||
|
|
||||||
|
- `SIGINT`/`Ctrl+C` handler via `ctrlc` crate — `dcr build` now checks
|
||||||
|
`BUILD_INTERRUPTED` flag at key points and aborts cleanly
|
||||||
|
- `utils/build.rs` — extracted shared utilities: `parse_version_info`,
|
||||||
|
`normalize_target_os`, `resolve_compiler`, `primary_language`,
|
||||||
|
`resolve_pkg_config_flags` and config helpers. Eliminates code duplication
|
||||||
|
between `cli/build.rs`, `cli/run.rs`, `cli/clean.rs`, `cli/gen.rs`
|
||||||
|
- `utils/fs.rs::with_dir` — extracted common directory-scoped execution
|
||||||
|
- `run_command_sync_output` in `builder/common.rs` with global `OUTPUT_MUTEX`
|
||||||
|
— synchronized compiler output across all backends (unix_cc, gas, nasm, msvc)
|
||||||
|
- New helper functions in `deps/register.rs`: `get_registry_cache_root`,
|
||||||
|
`package_root_from_registry_info`, `registry_include_dir`, `registry_lib_dir`,
|
||||||
|
`path_from_string_dep`
|
||||||
|
- Unit tests for `register.rs` (`is_registry_dep`, `package_root_from_registry_info`),
|
||||||
|
`deps/mod.rs` (`path_dep_path`, `push_default_lib_dirs`),
|
||||||
|
`utils/build.rs` (`normalize_target_os`, `parse_version_info`)
|
||||||
|
- `dcr tree` command — visual dependency tree viewer (similar to `cargo tree`)
|
||||||
|
|
||||||
|
Removed:
|
||||||
|
|
||||||
|
- Removed unused dependencies `indicatif` and `console` from `Cargo.toml`
|
||||||
|
|
||||||
|
## [0.6.5] - 2026-05-13
|
||||||
|
|
||||||
|
Added:
|
||||||
|
|
||||||
|
- New dependency registry system
|
||||||
|
- Package type support (`lib`, `app`, `none`) in `dcr.toml`
|
||||||
|
- Library packaging functionality: automatically generates `include` and `lib` directories in `target/` for `lib` type projects
|
||||||
|
- Expanded CI build targets:
|
||||||
|
- Linux: `aarch64-unknown-linux-gnu`, `x86_64-unknown-linux-musl`, `aarch64-unknown-linux-musl`
|
||||||
|
- Windows: `aarch64-pc-windows-msvc`, `x86_64-pc-windows-gnu`, `aarch64-pc-windows-gnullvm`
|
||||||
|
|
||||||
|
Changed:
|
||||||
|
|
||||||
|
- `src/core/deps/` modular architecture overhaul
|
||||||
|
- Native platform pathing defaults for Linux (now dynamic architecture detection)
|
||||||
|
- Improved `run` command output handling
|
||||||
|
|
||||||
## [0.6.0] - 2026-05-12
|
## [0.6.0] - 2026-05-12
|
||||||
|
|
||||||
Added:
|
Added:
|
||||||
@@ -62,10 +478,10 @@ Added:
|
|||||||
Added:
|
Added:
|
||||||
|
|
||||||
- `dcr gen` command for IDE integration and build tool support
|
- `dcr gen` command for IDE integration and build tool support
|
||||||
- `dcr gen project-info`: Output project metadata as JSON
|
- - `dcr gen project-info`: Output project metadata as JSON
|
||||||
- `dcr gen compile-commands`: Generate `compile_commands.json` for clangd and clang-tidy
|
- - `dcr gen compile-commands`: Generate `compile_commands.json` for clangd and clang-tidy
|
||||||
- `dcr gen vscode`: Generate VS Code `.vscode/` integration (launch.json, tasks.json, settings.json)
|
- - `dcr gen vscode`: Generate VS Code `.vscode/` integration (launch.json, tasks.json, settings.json)
|
||||||
- `dcr gen clion`: Generate JetBrains CLion `.idea/` integration (run configurations, build targets)
|
- - `dcr gen clion`: Generate JetBrains CLion `.idea/` integration (run configurations, build targets)
|
||||||
- Full workspace support for all `gen` subcommands
|
- Full workspace support for all `gen` subcommands
|
||||||
|
|
||||||
## [0.2.10] - 2026-03-16
|
## [0.2.10] - 2026-03-16
|
||||||
|
|||||||
@@ -31,8 +31,9 @@ DCR supports cross-compilation via `--target <triple>` or short names:
|
|||||||
- `dcr build --target windows --release` (maps to `x86_64-pc-windows-msvc`)
|
- `dcr build --target windows --release` (maps to `x86_64-pc-windows-msvc`)
|
||||||
- Full triples: `dcr build --target aarch64-linux-gnu --release`
|
- Full triples: `dcr build --target aarch64-linux-gnu --release`
|
||||||
- Configure multiple targets in `dcr.toml`:
|
- Configure multiple targets in `dcr.toml`:
|
||||||
```
|
|
||||||
[build.targets]
|
```toml
|
||||||
|
[build]
|
||||||
targets = ["linux", "macos"]
|
targets = ["linux", "macos"]
|
||||||
|
|
||||||
[build.linux]
|
[build.linux]
|
||||||
@@ -41,6 +42,7 @@ DCR supports cross-compilation via `--target <triple>` or short names:
|
|||||||
[build.macos]
|
[build.macos]
|
||||||
compiler = "clang"
|
compiler = "clang"
|
||||||
```
|
```
|
||||||
|
|
||||||
- If no `--target`, builds for targets in `build.targets` or native if empty.
|
- If no `--target`, builds for targets in `build.targets` or native if empty.
|
||||||
|
|
||||||
## Checks
|
## Checks
|
||||||
@@ -70,10 +72,15 @@ cargo test
|
|||||||
- In PRs, include a short description and rationale.
|
- In PRs, include a short description and rationale.
|
||||||
- Update documentation when behavior changes.
|
- Update documentation when behavior changes.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the **GNU General Public License v3.0**. By contributing, you agree that your contributions will be licensed under the same license.
|
||||||
|
|
||||||
## Questions
|
## Questions
|
||||||
|
|
||||||
If anything is unclear, open an issue or ask in the PR.
|
If anything is unclear, open an issue or ask in the PR.
|
||||||
|
|
||||||
You can also reach out directly:
|
You can also reach out directly:
|
||||||
|
|
||||||
- TG: @dexoron
|
- TG: @dexoron
|
||||||
- DS: dexoron
|
- DS: dexoron
|
||||||
|
|||||||
1287
Cargo.lock
generated
1287
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
79
Cargo.toml
79
Cargo.toml
@@ -1,16 +1,85 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "dcr"
|
name = "dcr"
|
||||||
version = "0.6.0"
|
version = "0.7.4"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
build = "build.rs"
|
build = "build.rs"
|
||||||
|
description = "DCR is a utility for managing C/C++ projects in a Cargo-like style."
|
||||||
|
license = "GPL-3.0-or-later"
|
||||||
|
repository = "https://github.com/dexoron/dcr"
|
||||||
|
documentation = "https://dcr-tool.ru/docs"
|
||||||
|
homepage = "https://dcr-tool.ru"
|
||||||
|
|
||||||
|
[package.metadata.binstall]
|
||||||
|
pkg-fmt = "bin"
|
||||||
|
pkg-url = "{ repo }/releases/download/v{ version }/dcr-{ target }-{ version }{ bin-suffix }"
|
||||||
|
|
||||||
|
[package.metadata.deb]
|
||||||
|
maintainer = "Dexoron (Bezotechestvo Vladimir) <main@dexoron.su>"
|
||||||
|
copyright = "2026, Dexoron"
|
||||||
|
extended-description = """
|
||||||
|
Cargo-like utility to manage C/C++ projects.
|
||||||
|
"""
|
||||||
|
section = "devel"
|
||||||
|
priority = "optional"
|
||||||
|
assets = [
|
||||||
|
["target/release/dcr", "usr/bin/dcr", "755"],
|
||||||
|
["man/man1/dcr.1", "usr/share/man/man1/dcr.1", "644"],
|
||||||
|
["man/man1/dcr-add.1", "usr/share/man/man1/dcr-add.1", "644"],
|
||||||
|
["man/man1/dcr-build.1", "usr/share/man/man1/dcr-build.1", "644"],
|
||||||
|
["man/man1/dcr-clean.1", "usr/share/man/man1/dcr-clean.1", "644"],
|
||||||
|
["man/man1/dcr-fmt.1", "usr/share/man/man1/dcr-fmt.1", "644"],
|
||||||
|
["man/man1/dcr-gen.1", "usr/share/man/man1/dcr-gen.1", "644"],
|
||||||
|
["man/man1/dcr-init.1", "usr/share/man/man1/dcr-init.1", "644"],
|
||||||
|
["man/man1/dcr-new.1", "usr/share/man/man1/dcr-new.1", "644"],
|
||||||
|
["man/man1/dcr-run.1", "usr/share/man/man1/dcr-run.1", "644"],
|
||||||
|
["man/man1/dcr-setup.1", "usr/share/man/man1/dcr-setup.1", "644"],
|
||||||
|
["man/man1/dcr-test.1", "usr/share/man/man1/dcr-test.1", "644"],
|
||||||
|
["man/man1/dcr-tree.1", "usr/share/man/man1/dcr-tree.1", "644"],
|
||||||
|
]
|
||||||
|
|
||||||
|
[package.metadata.generate-rpm]
|
||||||
|
summary = "Cargo-like utility to manage C/C++ projects"
|
||||||
|
description = """
|
||||||
|
Cargo-like utility to manage C/C++ projects.
|
||||||
|
"""
|
||||||
|
|
||||||
|
assets = [
|
||||||
|
{ source = "target/release/dcr", dest = "/usr/bin/dcr", mode = "755" },
|
||||||
|
{ source = "man/man1/dcr.1", dest = "/usr/share/man/man1/dcr.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-add.1", dest = "/usr/share/man/man1/dcr-add.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-build.1", dest = "/usr/share/man/man1/dcr-build.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-clean.1", dest = "/usr/share/man/man1/dcr-clean.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-fmt.1", dest = "/usr/share/man/man1/dcr-fmt.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-gen.1", dest = "/usr/share/man/man1/dcr-gen.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-init.1", dest = "/usr/share/man/man1/dcr-init.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-new.1", dest = "/usr/share/man/man1/dcr-new.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-run.1", dest = "/usr/share/man/man1/dcr-run.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-setup.1", dest = "/usr/share/man/man1/dcr-setup.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-test.1", dest = "/usr/share/man/man1/dcr-test.1", mode = "644" },
|
||||||
|
{ source = "man/man1/dcr-tree.1", dest = "/usr/share/man/man1/dcr-tree.1", mode = "644" },
|
||||||
|
]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
glob = "0.3"
|
glob = "0.3"
|
||||||
reqwest = { version = "0.12", default-features = false, features = ["blocking", "json", "rustls-tls"] }
|
ureq = { version = "2.10", default-features = false, features = ["json", "native-certs"] }
|
||||||
serde = { version = "1", features = ["derive"] }
|
serde = { version = "1", features = ["derive"] }
|
||||||
self-replace = "1"
|
self-replace = "1"
|
||||||
sha2 = "0.10"
|
sha2 = "0.10"
|
||||||
toml = "1.0.3"
|
toml = "1.0.3"
|
||||||
indicatif = "0.18.4"
|
serde_json = "1"
|
||||||
console = "0.16.3"
|
ctrlc = "3"
|
||||||
git2 = "0.20.4"
|
|
||||||
|
[profile.release]
|
||||||
|
opt-level = "z"
|
||||||
|
lto = "thin"
|
||||||
|
codegen-units = 1
|
||||||
|
panic = "abort"
|
||||||
|
strip = true
|
||||||
|
|
||||||
|
[profile.fast]
|
||||||
|
inherits = "release"
|
||||||
|
opt-level = 1
|
||||||
|
lto = false
|
||||||
|
codegen-units = 16
|
||||||
|
panic = "abort"
|
||||||
|
strip = true
|
||||||
23
FAQ.md
23
FAQ.md
@@ -1,38 +1,46 @@
|
|||||||
# FAQ
|
# FAQ
|
||||||
|
|
||||||
## What is this project about?
|
## What is this project about?
|
||||||
|
|
||||||
`dcr` is a tool for managing C/C++ projects and their dependencies.
|
`dcr` is a tool for managing C/C++ projects and their dependencies.
|
||||||
It is inspired by Cargo, but it is not a direct equivalent of Makefile, CMake, or other classic build systems.
|
It is inspired by Cargo, but it is not a direct equivalent of Makefile, CMake, or other classic build systems.
|
||||||
|
|
||||||
The goal is to provide a simpler and easier-to-configure development workflow.
|
The goal is to provide a simpler and easier-to-configure development workflow.
|
||||||
|
|
||||||
## How is the project developed?
|
## How is the project developed?
|
||||||
|
|
||||||
The project is written in Rust and is primarily developed by one maintainer, Dexoron.
|
The project is written in Rust and is primarily developed by one maintainer, Dexoron.
|
||||||
|
|
||||||
AI tools are used during development, but they do not write the project end-to-end. Their role is limited to supporting specific tasks (for example, suggestions, wording checks, and translations).
|
AI tools are used during development, but they do not write the project end-to-end. Their role is limited to supporting specific tasks (for example, suggestions, wording checks, and translations).
|
||||||
|
|
||||||
## Which tools are used for development?
|
## Which tools are used for development?
|
||||||
|
|
||||||
Main development stack:
|
Main development stack:
|
||||||
|
|
||||||
- `RustRover` 2025 - development IDE.
|
- `RustRover` 2025 - development IDE.
|
||||||
- `Codex` (`GPT-5.3-Codex (medium)`) - primary AI tool, integrated via JetBrains AI Chat.
|
- `Codex` (`GPT-5.3-Codex (medium)`) - primary AI tool, integrated via JetBrains AI Chat.
|
||||||
- `Rust` - main project language.
|
- `Rust` - main project language.
|
||||||
- `Cargo` - tool for building, testing, and dependency management in Rust projects.
|
- `Cargo` - tool for building, testing, and dependency management in Rust projects.
|
||||||
|
|
||||||
## Is the project open source?
|
## Is the project open source?
|
||||||
|
|
||||||
Yes, the project is open source.
|
Yes, the project is open source.
|
||||||
You can propose ideas, report issues, and contribute code changes.
|
You can propose ideas, report issues, and contribute code changes.
|
||||||
|
|
||||||
The project is distributed under the MIT license (see `LICENSE`).
|
The project is distributed under the GPL-3.0 license (see `LICENSE`).
|
||||||
|
|
||||||
## How can I contribute?
|
## How can I contribute?
|
||||||
|
|
||||||
Thank you for contributing.
|
Thank you for contributing.
|
||||||
You can:
|
You can:
|
||||||
|
|
||||||
- help with code;
|
- help with code;
|
||||||
- help with translations;
|
- help with translations;
|
||||||
- help with documentation;
|
- help with documentation;
|
||||||
- suggest an idea or report a bug.
|
- suggest an idea or report a bug.
|
||||||
|
|
||||||
### If you want to submit changes (code, translation, documentation)
|
### If you want to submit changes (code, translation, documentation)
|
||||||
|
|
||||||
1. Fork the required repository: `dexoron/dcr` (main project) or `dexoron/dcr-site` (project website).
|
1. Fork the required repository: `dexoron/dcr` (main project) or `dexoron/dcr-site` (project website).
|
||||||
2. Make your changes following the rules in `CONTRIBUTING.md`.
|
2. Make your changes following the rules in `CONTRIBUTING.md`.
|
||||||
3. Push changes to your fork.
|
3. Push changes to your fork.
|
||||||
@@ -40,6 +48,7 @@ You can:
|
|||||||
5. Wait for review.
|
5. Wait for review.
|
||||||
|
|
||||||
### If you want to report a problem or suggest an idea
|
### If you want to report a problem or suggest an idea
|
||||||
|
|
||||||
1. Open the relevant repository: `dexoron/dcr` or `dexoron/dcr-site`.
|
1. Open the relevant repository: `dexoron/dcr` or `dexoron/dcr-site`.
|
||||||
2. Go to the `Issues` tab.
|
2. Go to the `Issues` tab.
|
||||||
3. Create an Issue and specify its type (bug, suggestion, question/help).
|
3. Create an Issue and specify its type (bug, suggestion, question/help).
|
||||||
@@ -47,13 +56,17 @@ You can:
|
|||||||
5. Wait for feedback.
|
5. Wait for feedback.
|
||||||
|
|
||||||
## How do I install `dcr`?
|
## How do I install `dcr`?
|
||||||
|
|
||||||
Available installation methods may vary by project version.
|
Available installation methods may vary by project version.
|
||||||
Recommended path:
|
Recommended path:
|
||||||
|
|
||||||
- check instructions in `README.md`;
|
- check instructions in `README.md`;
|
||||||
- if there is no prebuilt package for your platform, build from source using `cargo build --release`.
|
- if there is no prebuilt package for your platform, build from source using `cargo build --release`.
|
||||||
|
|
||||||
## How can I get started quickly?
|
## How can I get started quickly?
|
||||||
|
|
||||||
Minimal workflow:
|
Minimal workflow:
|
||||||
|
|
||||||
1. Install `dcr`.
|
1. Install `dcr`.
|
||||||
2. Create a project (or open an existing C/C++ project).
|
2. Create a project (or open an existing C/C++ project).
|
||||||
3. Initialize `dcr` configuration.
|
3. Initialize `dcr` configuration.
|
||||||
@@ -63,21 +76,25 @@ Minimal workflow:
|
|||||||
For detailed commands and examples, see `README.md` and the project documentation.
|
For detailed commands and examples, see `README.md` and the project documentation.
|
||||||
|
|
||||||
## What is the project status?
|
## What is the project status?
|
||||||
|
|
||||||
`dcr` is under active development.
|
`dcr` is under active development.
|
||||||
This means some interfaces and behaviors may change between versions.
|
This means some interfaces and behaviors may change between versions.
|
||||||
|
|
||||||
Before upgrading, check the changelog and release notes.
|
Before upgrading, check the changelog and release notes.
|
||||||
|
|
||||||
## Which systems does `dcr` support?
|
## Which systems does `dcr` support?
|
||||||
|
|
||||||
`dcr` targets modern C/C++ development environments.
|
`dcr` targets modern C/C++ development environments.
|
||||||
Actual compatibility depends on the `dcr` version, operating system, and toolchain.
|
Actual compatibility depends on the `dcr` version, operating system, and toolchain.
|
||||||
|
|
||||||
Before starting, check documentation for:
|
Before starting, check documentation for:
|
||||||
|
|
||||||
- supported operating systems;
|
- supported operating systems;
|
||||||
- supported compilers and linkers;
|
- supported compilers and linkers;
|
||||||
- version-specific limitations.
|
- version-specific limitations.
|
||||||
|
|
||||||
## How is `dcr` different from Make/CMake?
|
## How is `dcr` different from Make/CMake?
|
||||||
|
|
||||||
`dcr` does not aim to be a direct replacement for Make/CMake.
|
`dcr` does not aim to be a direct replacement for Make/CMake.
|
||||||
Its main focus is simplifying project and dependency management with a Cargo-like experience.
|
Its main focus is simplifying project and dependency management with a Cargo-like experience.
|
||||||
|
|
||||||
@@ -85,13 +102,17 @@ If you need low-level, full control over build steps, classic tools may be a bet
|
|||||||
If you want a simpler and more uniform configuration model, `dcr` may be more convenient.
|
If you want a simpler and more uniform configuration model, `dcr` may be more convenient.
|
||||||
|
|
||||||
## Where can I find documentation and examples?
|
## Where can I find documentation and examples?
|
||||||
|
|
||||||
Primary sources:
|
Primary sources:
|
||||||
|
|
||||||
- `README.md` in the repository;
|
- `README.md` in the repository;
|
||||||
- project documentation (see the project website);
|
- project documentation (see the project website);
|
||||||
- `Issues` for known problems and discussions.
|
- `Issues` for known problems and discussions.
|
||||||
|
|
||||||
## How do I report a bug properly?
|
## How do I report a bug properly?
|
||||||
|
|
||||||
To make a bug report easy to reproduce, include:
|
To make a bug report easy to reproduce, include:
|
||||||
|
|
||||||
1. `dcr` version.
|
1. `dcr` version.
|
||||||
2. OS and compiler/toolchain version.
|
2. OS and compiler/toolchain version.
|
||||||
3. Steps to reproduce.
|
3. Steps to reproduce.
|
||||||
|
|||||||
688
LICENSE
688
LICENSE
@@ -1,21 +1,675 @@
|
|||||||
MIT License
|
# GNU GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
Copyright (c) 2026 Dexoron (Bezotechestvo Vladimir) [main@dexoron.su]
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
<https://fsf.org/>
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
copies or substantial portions of the Software.
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
## Preamble
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
The GNU General Public License is a free, copyleft license for
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
software and other kinds of works.
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
The licenses for most software and other practical works are designed
|
||||||
SOFTWARE.
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom
|
||||||
|
to share and change all versions of a program--to make sure it remains
|
||||||
|
free software for all its users. We, the Free Software Foundation, use
|
||||||
|
the GNU General Public License for most of our software; it applies
|
||||||
|
also to any other work released this way by its authors. You can apply
|
||||||
|
it to your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you
|
||||||
|
have certain responsibilities if you distribute copies of the
|
||||||
|
software, or if you modify it: responsibilities to respect the freedom
|
||||||
|
of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the
|
||||||
|
manufacturer can do so. This is fundamentally incompatible with the
|
||||||
|
aim of protecting users' freedom to change the software. The
|
||||||
|
systematic pattern of such abuse occurs in the area of products for
|
||||||
|
individuals to use, which is precisely where it is most unacceptable.
|
||||||
|
Therefore, we have designed this version of the GPL to prohibit the
|
||||||
|
practice for those products. If such problems arise substantially in
|
||||||
|
other domains, we stand ready to extend this provision to those
|
||||||
|
domains in future versions of the GPL, as needed to protect the
|
||||||
|
freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish
|
||||||
|
to avoid the special danger that patents applied to a free program
|
||||||
|
could make it effectively proprietary. To prevent this, the GPL
|
||||||
|
assures that patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
## TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
### 0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds
|
||||||
|
of works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of
|
||||||
|
an exact copy. The resulting work is called a "modified version" of
|
||||||
|
the earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user
|
||||||
|
through a computer network, with no transfer of a copy, is not
|
||||||
|
conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices" to
|
||||||
|
the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
### 1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work for
|
||||||
|
making modifications to it. "Object code" means any non-source form of
|
||||||
|
a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users can
|
||||||
|
regenerate automatically from other parts of the Corresponding Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that same
|
||||||
|
work.
|
||||||
|
|
||||||
|
### 2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not convey,
|
||||||
|
without conditions so long as your license otherwise remains in force.
|
||||||
|
You may convey covered works to others for the sole purpose of having
|
||||||
|
them make modifications exclusively for you, or provide you with
|
||||||
|
facilities for running those works, provided that you comply with the
|
||||||
|
terms of this License in conveying all material for which you do not
|
||||||
|
control copyright. Those thus making or running the covered works for
|
||||||
|
you must do so exclusively on your behalf, under your direction and
|
||||||
|
control, on terms that prohibit them from making any copies of your
|
||||||
|
copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under the
|
||||||
|
conditions stated below. Sublicensing is not allowed; section 10 makes
|
||||||
|
it unnecessary.
|
||||||
|
|
||||||
|
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such
|
||||||
|
circumvention is effected by exercising rights under this License with
|
||||||
|
respect to the covered work, and you disclaim any intention to limit
|
||||||
|
operation or modification of the work as a means of enforcing, against
|
||||||
|
the work's users, your or third parties' legal rights to forbid
|
||||||
|
circumvention of technological measures.
|
||||||
|
|
||||||
|
### 4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
### 5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
- a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
- b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under
|
||||||
|
section 7. This requirement modifies the requirement in section 4
|
||||||
|
to "keep intact all notices".
|
||||||
|
- c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
- d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
### 6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms of
|
||||||
|
sections 4 and 5, provided that you also convey the machine-readable
|
||||||
|
Corresponding Source under the terms of this License, in one of these
|
||||||
|
ways:
|
||||||
|
|
||||||
|
- a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
- b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the Corresponding
|
||||||
|
Source from a network server at no charge.
|
||||||
|
- c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
- d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
- e) Convey the object code using peer-to-peer transmission,
|
||||||
|
provided you inform other peers where the object code and
|
||||||
|
Corresponding Source of the work are being offered to the general
|
||||||
|
public at no charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal,
|
||||||
|
family, or household purposes, or (2) anything designed or sold for
|
||||||
|
incorporation into a dwelling. In determining whether a product is a
|
||||||
|
consumer product, doubtful cases shall be resolved in favor of
|
||||||
|
coverage. For a particular product received by a particular user,
|
||||||
|
"normally used" refers to a typical or common use of that class of
|
||||||
|
product, regardless of the status of the particular user or of the way
|
||||||
|
in which the particular user actually uses, or expects or is expected
|
||||||
|
to use, the product. A product is a consumer product regardless of
|
||||||
|
whether the product has substantial commercial, industrial or
|
||||||
|
non-consumer uses, unless such uses represent the only significant
|
||||||
|
mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to
|
||||||
|
install and execute modified versions of a covered work in that User
|
||||||
|
Product from a modified version of its Corresponding Source. The
|
||||||
|
information must suffice to ensure that the continued functioning of
|
||||||
|
the modified object code is in no case prevented or interfered with
|
||||||
|
solely because modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or
|
||||||
|
updates for a work that has been modified or installed by the
|
||||||
|
recipient, or for the User Product in which it has been modified or
|
||||||
|
installed. Access to a network may be denied when the modification
|
||||||
|
itself materially and adversely affects the operation of the network
|
||||||
|
or violates the rules and protocols for communication across the
|
||||||
|
network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
### 7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders
|
||||||
|
of that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
- a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
- b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
- c) Prohibiting misrepresentation of the origin of that material,
|
||||||
|
or requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
- d) Limiting the use for publicity purposes of names of licensors
|
||||||
|
or authors of the material; or
|
||||||
|
- e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
- f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions
|
||||||
|
of it) with contractual assumptions of liability to the recipient,
|
||||||
|
for any liability that these contractual assumptions directly
|
||||||
|
impose on those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions; the
|
||||||
|
above requirements apply either way.
|
||||||
|
|
||||||
|
### 8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your license
|
||||||
|
from a particular copyright holder is reinstated (a) provisionally,
|
||||||
|
unless and until the copyright holder explicitly and finally
|
||||||
|
terminates your license, and (b) permanently, if the copyright holder
|
||||||
|
fails to notify you of the violation by some reasonable means prior to
|
||||||
|
60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
### 9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or run
|
||||||
|
a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
### 10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
### 11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims owned
|
||||||
|
or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within the
|
||||||
|
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||||
|
the non-exercise of one or more of the rights that are specifically
|
||||||
|
granted under this License. You may not convey a covered work if you
|
||||||
|
are a party to an arrangement with a third party that is in the
|
||||||
|
business of distributing software, under which you make payment to the
|
||||||
|
third party based on the extent of your activity of conveying the
|
||||||
|
work, and under which the third party grants, to any of the parties
|
||||||
|
who would receive the covered work from you, a discriminatory patent
|
||||||
|
license (a) in connection with copies of the covered work conveyed by
|
||||||
|
you (or copies made from those copies), or (b) primarily for and in
|
||||||
|
connection with specific products or compilations that contain the
|
||||||
|
covered work, unless you entered into that arrangement, or that patent
|
||||||
|
license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
### 12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under
|
||||||
|
this License and any other pertinent obligations, then as a
|
||||||
|
consequence you may not convey it at all. For example, if you agree to
|
||||||
|
terms that obligate you to collect a royalty for further conveying
|
||||||
|
from those to whom you convey the Program, the only way you could
|
||||||
|
satisfy both those terms and this License would be to refrain entirely
|
||||||
|
from conveying the Program.
|
||||||
|
|
||||||
|
### 13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
### 14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in
|
||||||
|
detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program
|
||||||
|
specifies that a certain numbered version of the GNU General Public
|
||||||
|
License "or any later version" applies to it, you have the option of
|
||||||
|
following the terms and conditions either of that numbered version or
|
||||||
|
of any later version published by the Free Software Foundation. If the
|
||||||
|
Program does not specify a version number of the GNU General Public
|
||||||
|
License, you may choose any version ever published by the Free
|
||||||
|
Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future versions
|
||||||
|
of the GNU General Public License can be used, that proxy's public
|
||||||
|
statement of acceptance of a version permanently authorizes you to
|
||||||
|
choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
### 15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
||||||
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||||
|
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||||
|
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||||
|
CORRECTION.
|
||||||
|
|
||||||
|
### 16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||||
|
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||||
|
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||||
|
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||||
|
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||||
|
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||||
|
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
|
### 17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
## How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these
|
||||||
|
terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest to
|
||||||
|
attach them to the start of each source file to most effectively state
|
||||||
|
the exclusion of warranty; and each file should have at least the
|
||||||
|
"copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper
|
||||||
|
mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands \`show w' and \`show c' should show the
|
||||||
|
appropriate parts of the General Public License. Of course, your
|
||||||
|
program's commands might be different; for a GUI interface, you would
|
||||||
|
use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or
|
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
|
necessary. For more information on this, and how to apply and follow
|
||||||
|
the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your
|
||||||
|
program into proprietary programs. If your program is a subroutine
|
||||||
|
library, you may consider it more useful to permit linking proprietary
|
||||||
|
applications with the library. If this is what you want to do, use the
|
||||||
|
GNU Lesser General Public License instead of this License. But first,
|
||||||
|
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
414
README.md
414
README.md
@@ -1,190 +1,186 @@
|
|||||||
# DCR (Dexoron Cargo Realization)
|
<h1 align="center">DCR — Dexoron Cargo Realization</h1>
|
||||||
|
|
||||||
DCR is a utility for managing C/C++ projects in a Cargo-like style.
|
<p align="center"><strong>A Cargo-style build tool for C/C++ projects</strong></p>
|
||||||
|
|
||||||
The current implementation is written in Rust.
|
<p align="center">
|
||||||
|
<a href="https://github.com/dexoron/dcr/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/dexoron/dcr/actions/workflows/ci.yml/badge.svg"></a>
|
||||||
|
<a href="https://github.com/dexoron/dcr/releases/latest"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/dexoron/dcr"></a>
|
||||||
|
<a href="https://github.com/dexoron/dcr/releases"><img alt="Platform" src="https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-lightgrey"></a>
|
||||||
|
<br>
|
||||||
|
<a href="https://aur.archlinux.org/packages/dcr"><img alt="AUR" src="https://img.shields.io/aur/version/dcr"></a>
|
||||||
|
<a href="https://crates.io/crates/dcr"><img alt="Crates.io" src="https://img.shields.io/crates/v/dcr"></a>
|
||||||
|
<a href="https://github.com/dexoron/homebrew-dexoron"><img alt="Homebrew" src="https://img.shields.io/badge/homebrew-dexoron%2Fdexoron-orange"></a>
|
||||||
|
<br>
|
||||||
|
<a href="https://github.com/dexoron/dcr/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/dexoron/dcr?style=flat"></a>
|
||||||
|
<a href="LICENSE"><img alt="License: GPL-3.0" src="https://img.shields.io/badge/License-GPL--3.0-blue.svg"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
## Why DCR
|
<!-- Snap badge removed: classic confinement was denied for this project. -->
|
||||||
- Unified project structure without manual setup
|
|
||||||
- Simple commands for common tasks
|
|
||||||
- Transparent compilation and predictable build profiles
|
|
||||||
|
|
||||||
## Features
|
---
|
||||||
- Create a new project or initialize the current directory
|
|
||||||
- Build a project with `debug` and `release` profiles
|
|
||||||
- Run the compiled binary
|
|
||||||
- Clean build artifacts
|
|
||||||
- Generate IDE integration files (VS Code, CLion) and compilation databases
|
|
||||||
- Generate a minimal C project template
|
|
||||||
- Build static and shared libraries
|
|
||||||
- Git and Path dependency support with `dcr.lock` and automatic resolution
|
|
||||||
- ASM projects with NASM/GAS or via GCC/Clang
|
|
||||||
- Mixed language projects (`language = ["c", "asm"]` and similar)
|
|
||||||
- Cross-compilation with `--target` (short names: `linux`, `macos`, `windows`)
|
|
||||||
- Target-specific configurations and inheritance
|
|
||||||
- Update the binary via `dcr --update` (GitHub Releases, not for pacman/AUR installs)
|
|
||||||
|
|
||||||
## Supported Platforms
|
## Why DCR?
|
||||||
- Linux: `x86_64-unknown-linux-gnu`
|
|
||||||
- macOS Intel: `x86_64-apple-darwin`
|
- **No boilerplate** — one config file, predictable structure
|
||||||
- macOS Apple Silicon: `aarch64-apple-darwin`
|
- **Cargo-like workflow** — `build`, `run`, `clean`, `test`, `add`, `fmt`
|
||||||
- Windows: `x86_64-pc-windows-msvc`
|
- **Cross-compilation** — full target triple support with short names
|
||||||
|
- **IDE integration** — VS Code, CLion, `compile_commands.json` out of the box
|
||||||
|
- **Dependencies** — path, git, and registry-based with lock file
|
||||||
|
- **Man pages** — `man dcr` and per-command pages (`man dcr-build`, `man dcr-new`, etc.)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Package Manager
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td><b>Linux (Dexoron Packages)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
**Arch Linux**
|
See https://pkg.dexoron.su for settings youre packages manager
|
||||||
```sh
|
|
||||||
yay -S dcr # or paru and other AUR package managers
|
|
||||||
```
|
|
||||||
|
|
||||||
### From Source
|
**Arch Linux:**
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/dexoron/dcr.git
|
sudo pacman -Sy dcr
|
||||||
cd dcr
|
|
||||||
cargo build --release
|
|
||||||
mkdir -p ~/.local/bin
|
|
||||||
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Via `install.sh` (Linux/macOS)
|
**Debian/Ubuntu:**
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
curl -fsSL https://dcr.dexoron.su/install.sh | bash
|
sudo apt update && sudo apt install dcr
|
||||||
```
|
```
|
||||||
|
|
||||||
### Via `install.ps1` (Windows)
|
**Fedora/RHEL:**
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo dnf install dcr
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>Arch Linux (AUR)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
```sh
|
||||||
|
yay -S dcr
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>macOS/Linux(GNU) (Homebrew)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
```sh
|
||||||
|
brew tap dexoron/dexoron
|
||||||
|
brew install dcr
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>Nix (flake)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
```sh
|
||||||
|
nix run github:dexoron/dcr
|
||||||
|
# or install to profile:
|
||||||
|
nix profile install github:dexoron/dcr
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>Cargo (crates.io)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo install dcr
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>Linux / macOS (script)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -fsSL https://dcr.dexoron.su/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>BSD (script)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -fsSL https://dcr.dexoron.su/install_bsd.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>Snap (Linux)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
> Snap Store publishing temporarily disabled — see [#51671](https://forum.snapcraft.io/t/classic-confinement-request-for-dcrup/51671).
|
||||||
|
> Download the `.snap` from [GitHub Releases](https://github.com/dexoron/dcr/releases/latest) and install manually:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo snap install --classic --dangerous dcrup_*.snap
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>Windows (PowerShell)</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
irm https://dcr.dexoron.su/install.ps1 | iex
|
irm https://dcr.dexoron.su/install.ps1 | iex
|
||||||
```
|
```
|
||||||
|
|
||||||
When executed, both scripts ask whether to:
|
</td>
|
||||||
- download a prebuilt binary from GitHub Releases
|
</tr>
|
||||||
- or build the project from `git`
|
<tr>
|
||||||
|
<td><b>From source</b></td>
|
||||||
|
<td>
|
||||||
|
|
||||||
Release assets:
|
```sh
|
||||||
- `dcr-x86_64-unknown-linux-gnu`
|
git clone https://github.com/dexoron/dcr.git
|
||||||
- `dcr-x86_64-apple-darwin`
|
cd dcr && cargo build --release
|
||||||
- `dcr-aarch64-apple-darwin`
|
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
||||||
- `dcr-x86_64-pc-windows-msvc.exe`
|
```
|
||||||
|
|
||||||
## Update
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
- If DCR was installed from GitHub release assets, `install.sh`, `install.ps1`, or built manually:
|
---
|
||||||
- use `dcr --update`
|
|
||||||
- If DCR is installed via `pacman/AUR`:
|
|
||||||
- update with your package manager: `paru/yay -Syu dcr` or `sudo pacman -Syu dcr`
|
|
||||||
- `dcr --update` detects package-managed installs and asks you to update via package manager
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
Create a new project:
|
|
||||||
`dcr new hello`
|
|
||||||
|
|
||||||
Or initialize the current directory (the directory must be empty):
|
|
||||||
`dcr init`
|
|
||||||
|
|
||||||
Project structure:
|
|
||||||
|
|
||||||
```txt
|
|
||||||
hello/
|
|
||||||
- src/
|
|
||||||
- - main.c
|
|
||||||
- dcr.toml
|
|
||||||
```
|
|
||||||
|
|
||||||
Build and run the project:
|
|
||||||
`dcr run` or `dcr run --release`
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
### `dcr new <name>`
|
|
||||||
Creates a project with the specified name in the current directory.
|
|
||||||
|
|
||||||
### `dcr init`
|
|
||||||
Creates a project in the current directory. The project name is taken from the directory name. The directory must be empty.
|
|
||||||
|
|
||||||
### `dcr add <name> <source>`
|
|
||||||
Adds a dependency to `dcr.toml`.
|
|
||||||
Sources can be `path:`, `github:`, `gitlab:`, `git:`, or a full URL.
|
|
||||||
Use `--branch`, `--tag`, or `--rev` for Git dependencies.
|
|
||||||
|
|
||||||
### `dcr build [profile]`
|
|
||||||
Builds the project. If no profile is specified, `--debug` is used.
|
|
||||||
Use `--force` to rebuild without cache, `--clean` to clean before build.
|
|
||||||
|
|
||||||
### `dcr run [profile]`
|
|
||||||
Builds the project and runs the binary. If no profile is specified, `--debug` is used.
|
|
||||||
Use `--force` to rebuild without cache, `--clean` to clean before build.
|
|
||||||
|
|
||||||
Run manually:
|
|
||||||
`./target/<profile>/<name>`
|
|
||||||
|
|
||||||
### `dcr clean`
|
|
||||||
Removes the `target` directory in the project root.
|
|
||||||
Use `dcr clean --all` in a workspace root to clean all member projects.
|
|
||||||
|
|
||||||
### `dcr gen`
|
|
||||||
Generates IDE integration files and build tools.
|
|
||||||
- `dcr gen vscode`: VS Code workspace config
|
|
||||||
- `dcr gen clion`: CLion project files
|
|
||||||
- `dcr gen compile-commands`: `compile_commands.json` for clang tools
|
|
||||||
|
|
||||||
### `dcr test`
|
|
||||||
Runs the test suite.
|
|
||||||
Use `dcr test --init` to create test files.
|
|
||||||
|
|
||||||
## Build Profiles
|
|
||||||
Two profiles are supported:
|
|
||||||
- `--debug` (default) - built-in flags per compiler
|
|
||||||
- `--release` - built-in flags per compiler
|
|
||||||
|
|
||||||
Custom flags can be added in `dcr.toml` via `build.cflags` and `build.ldflags`.
|
|
||||||
Profile-specific flags can be added via `[build.debug]` and `[build.release]`.
|
|
||||||
You can also set `build.target` to override the output directory (profile-independent).
|
|
||||||
You can set `build.platform` to pass `-march=<platform>` (GCC/Clang) or `/arch:*` (MSVC) where supported.
|
|
||||||
Use `build.kind = "staticlib"` to build a static library instead of a binary.
|
|
||||||
Use `build.kind = "sharedlib"` to build a shared library (`.so`/`.dylib`/`.dll`).
|
|
||||||
`dcr run` is only for `build.kind = "bin"` and will fail for libraries.
|
|
||||||
Use `build.exclude`/`build.include` to control source/header collection.
|
|
||||||
Use `build.roots` and `build.src_disable` to replace the default `src/` root.
|
|
||||||
Use `build.steps` and `build.post_steps` to run custom commands.
|
|
||||||
Use `build.clean` for extra cleanup paths and `[run].cmd` to override run command.
|
|
||||||
|
|
||||||
## Cross-compilation
|
|
||||||
|
|
||||||
DCR supports cross-compilation via `--target <triple>` or short names:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dcr build --target linux --release # x86_64-unknown-linux-gnu
|
dcr new hello
|
||||||
dcr build --target macos --release # x86_64-apple-darwin
|
cd hello
|
||||||
dcr build --target windows --release # x86_64-pc-windows-msvc
|
dcr run
|
||||||
dcr run --target aarch64-linux-gnu
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configure multiple targets and target-specific settings in `dcr.toml`:
|
**Project structure:**
|
||||||
|
|
||||||
```toml
|
```
|
||||||
[build.targets]
|
hello/
|
||||||
targets = ["linux", "windows"]
|
├── dcr.toml # project config
|
||||||
|
└── src/
|
||||||
[build.linux]
|
└── main.c
|
||||||
compiler = "gcc"
|
|
||||||
cflags = ["-O2"]
|
|
||||||
|
|
||||||
[build.windows]
|
|
||||||
compiler = "x86_64-w64-mingw32-gcc"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
See [Cross-compilation guide](docs/dependencies-and-build/cross-compilation.md) for details.
|
---
|
||||||
|
|
||||||
## Configuration
|
## dcr.toml Example
|
||||||
The main project file is `dcr.toml`.
|
|
||||||
|
|
||||||
Example `dcr.toml`:
|
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[package]
|
[package]
|
||||||
@@ -195,51 +191,89 @@ version = "0.1.0"
|
|||||||
language = "c"
|
language = "c"
|
||||||
standard = "c11"
|
standard = "c11"
|
||||||
compiler = "clang"
|
compiler = "clang"
|
||||||
# Optional platform hint
|
kind = "bin"
|
||||||
# platform = "x86_64"
|
|
||||||
# Optional custom flags
|
|
||||||
cflags = ["-Wall", "-Wextra"]
|
|
||||||
ldflags = ["-lm"]
|
|
||||||
#
|
|
||||||
# Optional include/exclude:
|
|
||||||
# exclude = ["src/vendor", "src/legacy/**"]
|
|
||||||
# include = ["src/boot/arch/**"]
|
|
||||||
|
|
||||||
[toolchain]
|
|
||||||
# Optional tool overrides:
|
|
||||||
# cc = "clang"
|
|
||||||
# cxx = "clang++"
|
|
||||||
# as = "as"
|
|
||||||
# ar = "ar"
|
|
||||||
# ld = "ld"
|
|
||||||
# uic = "uic"
|
|
||||||
# moc = "moc"
|
|
||||||
# rcc = "rcc"
|
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
my_lib = "path:./libs/my_lib"
|
|
||||||
cool_lib = { git = "https://github.com/user/cool_lib", tag = "v1.0" }
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Workspace example:
|
---
|
||||||
...
|
|
||||||
[workspace]
|
## Base Commands
|
||||||
kernel = { path = "src/kernel", deps = ["core", "userspace"] }
|
|
||||||
core = { path = "src/core", deps = ["userspace"] }
|
| Command | Description |
|
||||||
userspace = { path = "src/userspace" }
|
|---|---|
|
||||||
|
| `dcr new <name>` | Create a new project |
|
||||||
|
| `dcr init` | Initialize current directory |
|
||||||
|
| `dcr add <dep>` | Add a dependency |
|
||||||
|
| `dcr build [--release]` | Build the project |
|
||||||
|
| `dcr run [--release]` | Build and run |
|
||||||
|
| `dcr clean` | Remove build artifacts |
|
||||||
|
| `dcr test` | Run project tests |
|
||||||
|
| `dcr fmt` | Format C/C++ sources (clang-format) |
|
||||||
|
| `dcr tree` | View dependency tree |
|
||||||
|
| `dcr gen <vscode\|clion\|compile-commands>` | Generate IDE integration |
|
||||||
|
| `dcr setup` | Initialize DCR registry |
|
||||||
|
|
||||||
|
other in [docs/](docs/), `dcr --help` and `dcr <command> --help`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Platforms (pre-built binary)
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
| OS | x86_64 | aarch64 | armv7 | i686 | riscv64 |
|
||||||
|
|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||||
|
| Linux (GNU) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| Linux (Musl) | ✅ | ✅ | ✅ | ✅ | 🚧 |
|
||||||
|
| macOS | ✅ | ✅ | ❌ | ❌ | ❌ |
|
||||||
|
| Windows (MSVC) | ✅ | ✅ | ❌ | ✅ | ❌ |
|
||||||
|
| Windows (MinGW) | ✅ | 🚧 | ❌ | ❌ | ❌ |
|
||||||
|
| FreeBSD | ✅ | 🚧 | ❌ | ❌ | ❌ |
|
||||||
|
| OpenBSD | ✅ | 🚧 | ❌ | ❌ | ❌ |
|
||||||
|
| NetBSD | ✅ | 🚧 | ❌ | ❌ | ❌ |
|
||||||
|
|
||||||
|
✅ pre-built binary · 🚧 planned · ❌ not supported by platform or CI
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Full docs at **[dcr.dexoron.su](https://dcr.dexoron.su)** or in the [`docs/`](docs/) directory.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
| | Name | Role | GitHub |
|
||||||
|
|:---:|---|---|---|
|
||||||
|
| 👤 | Dexoron (Bezotechestvo Vladimir) | Maintainer, Creator | [@dexoron](https://github.com/dexoron) |
|
||||||
|
| 👤 | Kai | Maintainer | [@peoplemiau1](https://github.com/peoplemiau1) |
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](CONTRIBUTING.md). Before a PR:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo fmt --all
|
||||||
|
cargo clippy --all-targets --all-features -- -D warnings
|
||||||
|
cargo test
|
||||||
```
|
```
|
||||||
|
|
||||||
Git and Path dependencies are supported. DCR will resolve them on build and generate `dcr.lock`.
|
---
|
||||||
|
|
||||||
Incremental build note: object files are rebuilt when source `.c/.cpp` or included header files change.
|
<div align="center">
|
||||||
|
|
||||||
|
GPL-3.0 — see [LICENSE](LICENSE)<br/>
|
||||||
|
DCR is a build tool, not a library. The GPL applies only to DCR's own source code, not to projects built with it.<br/>
|
||||||
|
Made with ❤️ by [Dexoron](https://github.com/dexoron) and contributors.
|
||||||
|
|
||||||
## Requirements
|
</div>
|
||||||
- Rust toolchain (`rustc`, `cargo`) - for building DCR from source
|
|
||||||
- C compiler (`clang`, `gcc`, or 'cl'(msvc))
|
|
||||||
|
|
||||||
## Releases
|
|
||||||
Releases are built automatically via GitHub Actions (`.github/workflows/release.yml`) when a tag matching `v*` is pushed.
|
|
||||||
|
|
||||||
## License
|
|
||||||
See `LICENSE`.
|
|
||||||
|
|||||||
58
TODO.md
58
TODO.md
@@ -2,38 +2,35 @@
|
|||||||
|
|
||||||
Priority list of tasks to turn DCR into a true Cargo killer for C/C++ developers.
|
Priority list of tasks to turn DCR into a true Cargo killer for C/C++ developers.
|
||||||
|
|
||||||
## 🔥 High Priority (Next Releases)
|
**Legend:** `[ ]` — not implemented | `[-]` — partially implemented | `[x]` — implemented
|
||||||
|
|
||||||
- [x] **Git dependencies support**
|
## 🔥 High Priority
|
||||||
`git = "https://github.com/user/repo.git#branch"` and `git = "..."@tag`
|
|
||||||
- [ ] **Conan and vcpkg integration**
|
- [ ] **CLI Output Refactoring & Cleanup**
|
||||||
Automatic download, installation and linking of packages
|
- [ ] Move all terminal strings to a dedicated module (`src/ui/messages.rs`)
|
||||||
- [ ] **Full freestanding / embedded support**
|
- [ ] Standardize logging formats (`error:`, `warning:`, `status:`)
|
||||||
`-nostdlib`, linker scripts, bare-metal targets (i686-elf, aarch64-none-elf, etc.)
|
- [x] Add build execution time statistics to the final output (e.g., `Finished in 4.23s`)
|
||||||
- [ ] **EFI support**
|
- [ ] **Internationalization (i18n) / Localization**
|
||||||
Dedicated platform configuration for EFI targets
|
- [ ] Integrate a lightweight localization engine (`fluent` or `gettext` pure-Rust port)
|
||||||
- [ ] **Custom project name**
|
- [ ] Create initial translation catalogs (`en.ftl`, `ru.ftl`)
|
||||||
Override binary name in `dcr.toml`
|
- [x] **Self-Update Stability Validation**
|
||||||
- [ ] **Custom build steps / targets**
|
- [x] Self-update implemented via `self-replace` + `ureq` in `flag_update.rs`
|
||||||
Ability to define custom pre-build, post-build, codegen steps in `dcr.toml`
|
- [-] **Freestanding / Embedded Automation**
|
||||||
- [ ] **Improved mixed C/C++/ASM projects**
|
- *`-ffreestanding` injected at compile time, `-nostdlib -static` at link time for bare-metal targets or `build.freestanding = true`. Config option `build.freestanding` (bool) added.*
|
||||||
Better handling of `.S` and `.asm` files with correct flags
|
- [ ] **Conan and vcpkg integration** Automatic download, installation and linking of packages
|
||||||
- [ ] **dcr publish + official package registry**
|
|
||||||
Publish and fetch your own libraries easily
|
|
||||||
|
|
||||||
## ✅ Medium Priority
|
## ✅ Medium Priority
|
||||||
|
|
||||||
- [ ] **Static analysis** (`dcr check`)
|
- [ ] **Static analysis** (`dcr check`)
|
||||||
Integration with clang-tidy, cppcheck, include-what-you-use
|
Integration with clang-tidy, cppcheck, include-what-you-use
|
||||||
- [ ] **Linter + Formatter** (`dcr fmt`, `dcr lint`)
|
- [-] **Linter + Formatter** (`dcr fmt`, `dcr lint`)
|
||||||
|
*`dcr fmt` (clang-format) implemented; `dcr lint` does not exist yet*
|
||||||
- [ ] **Hot reload / Live reload** for applications (raylib, SFML, SDL, etc.)
|
- [ ] **Hot reload / Live reload** for applications (raylib, SFML, SDL, etc.)
|
||||||
- [ ] **Better cross-compilation experience**
|
- [-] **Workspaces improvements** Per-member include directories, selective builds, better dependency graph
|
||||||
Ready-to-use toolchains + automatic download
|
*Basic workspaces with dep ordering + topological sort work; advanced features missing*
|
||||||
- [ ] **Linker script support** + direct linker control
|
- [-] **Build-time code generation** Support for protobuf, flatbuffers, Qt moc, custom generators
|
||||||
- [ ] **Workspaces improvements**
|
*Generic `build.steps` machinery + Qt toolchain (uic/moc/rcc) work; no dedicated protobuf/flatbuffers generators*
|
||||||
Per-member include directories, selective builds, better dependency graph
|
- [-] **dcr publish + official package registry** *Registry consumption (fetch, resolve, link) works; `dcr publish` command / local packing missing*
|
||||||
- [ ] **Build-time code generation**
|
|
||||||
Support for protobuf, flatbuffers, Qt moc, custom generators
|
|
||||||
|
|
||||||
## 📌 Low Priority / Nice to Have
|
## 📌 Low Priority / Nice to Have
|
||||||
|
|
||||||
@@ -57,11 +54,12 @@ Priority list of tasks to turn DCR into a true Cargo killer for C/C++ developers
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Currently in progress:**
|
**Currently in progress:**
|
||||||
- ...
|
- UI/UX terminal output unification and benchmarking metrics.
|
||||||
|
|
||||||
**Completed in recent releases:**
|
**Completed in recent releases:**
|
||||||
- Workspaces
|
- Extreme binary size optimization (-50% weight reduction via `ureq` + `native-certs`)
|
||||||
- Cross-compilation
|
- Complete removal of `git2` and `openssl` in favor of system Git execution
|
||||||
|
- Workspaces & Cross-compilation (`--target <triple>`)
|
||||||
- IDE config generation (VS Code, CLion, compile_commands.json)
|
- IDE config generation (VS Code, CLion, compile_commands.json)
|
||||||
- Self-update (`dcr --update`)
|
- EFI support & Linker script support (`build.ldscript`)
|
||||||
- Header tracking
|
- Mixed C/C++/ASM compilation with custom `std::thread::scope` work-stealing engine
|
||||||
50
build.rs
50
build.rs
@@ -1,4 +1,54 @@
|
|||||||
|
// DCR — Cargo-like C/C++ project manager.
|
||||||
|
//
|
||||||
|
// Copyright (C) 2026 Dexoron (Bezotechestvo Vladimir) <main@dexoron.su>
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// (at your option) any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
let target = std::env::var("TARGET").unwrap_or_else(|_| "unknown-target".to_string());
|
let target = std::env::var("TARGET").unwrap_or_else(|_| "unknown-target".to_string());
|
||||||
println!("cargo:rustc-env=DCR_TARGET={target}");
|
println!("cargo:rustc-env=DCR_TARGET={target}");
|
||||||
|
|
||||||
|
// Let's try to retrieve the commit hash for the version
|
||||||
|
let commit = std::process::Command::new("git")
|
||||||
|
.args(["rev-parse", "--short", "HEAD"])
|
||||||
|
.output()
|
||||||
|
.ok()
|
||||||
|
.and_then(|o| {
|
||||||
|
if o.status.success() {
|
||||||
|
String::from_utf8(o.stdout)
|
||||||
|
.ok()
|
||||||
|
.map(|s| s.trim().to_string())
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Check if there are any uncommitted changes in the repository
|
||||||
|
let is_dirty = std::process::Command::new("git")
|
||||||
|
.args(["status", "--porcelain"])
|
||||||
|
.output()
|
||||||
|
.ok()
|
||||||
|
.map(|o| o.status.success() && !o.stdout.is_empty())
|
||||||
|
.unwrap_or(false);
|
||||||
|
|
||||||
|
if let Some(commit_hash) = commit {
|
||||||
|
let dirty_suffix = if is_dirty { "-dirty" } else { "" };
|
||||||
|
println!(
|
||||||
|
"cargo:rustc-env=DCR_GIT_INFO= (git {}{})",
|
||||||
|
commit_hash, dirty_suffix
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
println!("cargo:rustc-env=DCR_GIT_INFO=");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
# Introduction
|
|
||||||
|
|
||||||
DCR (Dexoron Cargo Realization) is a Cargo-style CLI for C/C++ projects.
|
|
||||||
|
|
||||||
Current DCR focuses on a simple, predictable workflow:
|
|
||||||
|
|
||||||
- create or initialize a project (`dcr new`, `dcr init`)
|
|
||||||
- build with `debug` or `release` profiles (`dcr build`)
|
|
||||||
- run binaries (`dcr run`)
|
|
||||||
- clean artifacts (`dcr clean`)
|
|
||||||
- update the installed binary (`dcr --update`)
|
|
||||||
|
|
||||||
## What is implemented in this version
|
|
||||||
|
|
||||||
- Project configuration in `dcr.toml` with `[package]`, `[build]`, `[dependencies]`.
|
|
||||||
- Recursive source discovery in `src/`:
|
|
||||||
- C: `*.c`
|
|
||||||
- C++: `*.cpp`, `*.cxx`, `*.cc`
|
|
||||||
- Compiler selection from `dcr.toml` (`clang`, `gcc`, `cl`, `clang-cl`, etc.).
|
|
||||||
- ASM support via `language = "asm"` (GCC/Clang, NASM, GAS).
|
|
||||||
- Mixed language builds via `language = ["c", "asm"]` and similar combinations.
|
|
||||||
- Three build kinds:
|
|
||||||
- `bin` (default)
|
|
||||||
- `staticlib`
|
|
||||||
- `sharedlib`
|
|
||||||
- Optional custom output directory via `build.target`.
|
|
||||||
- Optional `build.platform` to pass architecture hints (`-march` / `/arch`).
|
|
||||||
- Optional `build.exclude`/`build.include` for source/header selection.
|
|
||||||
- Optional `build.roots`/`build.src_disable` to replace the default `src/` root.
|
|
||||||
- Optional build steps with `build.steps` and `build.post_steps`.
|
|
||||||
- Optional `build.pkg_config` integration.
|
|
||||||
- Optional `build.clean` and `build.expect`.
|
|
||||||
- Optional `[run].cmd` to override run command.
|
|
||||||
- Workspace builds via `[workspace]` with per-project `dcr.toml`.
|
|
||||||
- Path dependencies with include/lib resolution and `dcr.lock` generation.
|
|
||||||
|
|
||||||
## Important behavior notes
|
|
||||||
|
|
||||||
- `dcr.toml` is required for `build`, `run`, and `clean`.
|
|
||||||
- `run` works only with `build.kind = "bin"`.
|
|
||||||
- Incremental rebuild tracks source file timestamps and header dependencies (rebuilds when either source or included headers change).
|
|
||||||
- Object files are always created under `target/<profile>/obj/`.
|
|
||||||
|
|
||||||
## Repository
|
|
||||||
|
|
||||||
- <https://github.com/dexoron/dcr>
|
|
||||||
63
docs/README.mdx
Normal file
63
docs/README.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`
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
# Table of contents
|
|
||||||
|
|
||||||
* [Introduction](README.md)
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
* [Installation](getting-started/installation.md)
|
|
||||||
* [Create your first project](getting-started/create-your-first-project.md)
|
|
||||||
* [Project structure](getting-started/project-structure.md)
|
|
||||||
* [Build and run](getting-started/build-and-run.md)
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
* [dcr.toml overview](configuration/dcr.toml-overview.md)
|
|
||||||
* [Package section](configuration/package-section.md)
|
|
||||||
* [Build section](configuration/build-section.md)
|
|
||||||
* [Dependencies section](configuration/dependencies-section.md)
|
|
||||||
* [Build profiles](configuration/build-profiles.md)
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
* [Global options](commands/global-options.md)
|
|
||||||
* [dcr init/new](commands/dcr-init-or-new.md)
|
|
||||||
* [dcr add](commands/dcr-add.md)
|
|
||||||
* [dcr build](commands/dcr-build.md)
|
|
||||||
* [dcr run](commands/dcr-run.md)
|
|
||||||
* [dcr clean](commands/dcr-clean.md)
|
|
||||||
* [dcr gen](commands/dcr-gen.md)
|
|
||||||
* [dcr test](commands/dcr-test.md)
|
|
||||||
|
|
||||||
## Dependencies & Build
|
|
||||||
|
|
||||||
* [Dependency format](dependencies-and-build/dependency-format.md)
|
|
||||||
* [Local dependencies](dependencies-and-build/local-dependencies.md)
|
|
||||||
* [Versioning & lock file](dependencies-and-build/versioning-and-lock-file.md)
|
|
||||||
* [Target directory](dependencies-and-build/target-directory.md)
|
|
||||||
* [Cross-compilation and targets](dependencies-and-build/cross-compilation.md)
|
|
||||||
* [Compilers & linking](dependencies-and-build/compilers-and-linking.md)
|
|
||||||
|
|
||||||
## Reference & Help
|
|
||||||
|
|
||||||
* [CLI reference](reference-and-help/cli-reference.md)
|
|
||||||
* [Config reference](reference-and-help/config-reference.md)
|
|
||||||
* [Workspace guide](reference-and-help/workspace-guide.md)
|
|
||||||
* [Flags & environment](reference-and-help/flags-and-environment.md)
|
|
||||||
* [Troubleshooting map](reference-and-help/troubleshooting-map.md)
|
|
||||||
* [FAQ](reference-and-help/faq.md)
|
|
||||||
* [Contributing & Bug reports](reference-and-help/contributing-and-bug-reports.md)
|
|
||||||
91
docs/changelog.mdx
Normal file
91
docs/changelog.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`.
|
||||||
42
docs/commands/build-commands.mdx
Normal file
42
docs/commands/build-commands.mdx
Normal file
@@ -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
|
||||||
|
```
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
# dcr add
|
|
||||||
|
|
||||||
Add a dependency to `dcr.toml`.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```bash
|
|
||||||
dcr add <name> <source> [options]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Sources
|
|
||||||
|
|
||||||
- `path:./path/to/lib`: Local directory.
|
|
||||||
- `github:user/repo`: GitHub repository.
|
|
||||||
- `gitlab:user/repo`: GitLab repository.
|
|
||||||
- `git:host.com/user/repo`: Generic Git repository (HTTPS).
|
|
||||||
- `https://...`: Full Git URL.
|
|
||||||
|
|
||||||
## Options
|
|
||||||
|
|
||||||
- `--branch <name>`: Use a specific branch.
|
|
||||||
- `--tag <name>`: Use a specific tag.
|
|
||||||
- `--rev <sha>`: Use a specific commit hash.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```bash
|
|
||||||
dcr add my_lib path:./libs/my_lib
|
|
||||||
dcr add cool_lib github:user/cool_lib
|
|
||||||
dcr add shared_lib gitlab:org/shared --branch develop
|
|
||||||
dcr add custom_lib git:git.internal.com/r/lib --tag v1.0.0
|
|
||||||
```
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
# dcr build
|
|
||||||
|
|
||||||
Builds the project in `debug` or `release` profile.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr build
|
|
||||||
dcr build --debug
|
|
||||||
dcr build --release
|
|
||||||
dcr build --target linux --release
|
|
||||||
dcr build --release --force
|
|
||||||
dcr build --debug --clean
|
|
||||||
```
|
|
||||||
|
|
||||||
## What `build` does
|
|
||||||
|
|
||||||
1. Checks that `dcr.toml` exists and is valid.
|
|
||||||
2. Reads build settings from `[build]`.
|
|
||||||
3. Resolves path dependencies from `[dependencies]`.
|
|
||||||
4. Creates required output directories.
|
|
||||||
5. Recursively compiles sources from `src/`.
|
|
||||||
6. Links final artifact (binary or library).
|
|
||||||
|
|
||||||
## Config values used
|
|
||||||
|
|
||||||
- `package.name`
|
|
||||||
- `build.compiler`
|
|
||||||
- `build.language`
|
|
||||||
- `build.standard`
|
|
||||||
- `build.kind`
|
|
||||||
- `build.target`
|
|
||||||
- `build.platform`
|
|
||||||
- `build.cflags`
|
|
||||||
- `build.ldflags`
|
|
||||||
- `build.debug` / `build.release`
|
|
||||||
- `build.exclude`
|
|
||||||
- `build.include`
|
|
||||||
- `build.pkg_config`
|
|
||||||
- `build.steps`
|
|
||||||
- `build.post_steps`
|
|
||||||
- `build.generated`
|
|
||||||
- `build.expect`
|
|
||||||
- `build.clean`
|
|
||||||
|
|
||||||
## Source selection
|
|
||||||
|
|
||||||
- `language = "c"` -> `*.c`
|
|
||||||
- `language = "c++" | "cpp" | "cxx"` -> `*.cpp`, `*.cxx`, `*.cc`
|
|
||||||
- `language = "asm"` -> `*.s`, `*.S`, `*.asm`
|
|
||||||
- Mixed languages are supported with arrays, for example `language = ["c", "asm"]`.
|
|
||||||
- By default sources are searched in `src/`; use `build.roots` and `build.src_disable` to override.
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- Profile flag (`--debug` / `--release`) can appear in any argument position (duplicates are rejected).
|
|
||||||
- Unknown profile flags return an error.
|
|
||||||
- `--target <triple>` builds for specified target (short names: `linux`, `macos`, `windows`).
|
|
||||||
- If no `--target`, builds for `build.targets` or native.
|
|
||||||
- Incremental rebuild checks source/object mtime and tracked header dependencies.
|
|
||||||
- `--force` skips build cache checks and recompiles.
|
|
||||||
- `--clean` removes `target/<profile>` and `build.clean` paths before building.
|
|
||||||
- Default GCC/Clang profile flags: `debug` -> `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG`, `release` -> `-O3 -DNDEBUG`.
|
|
||||||
- For `language = "asm"` with `compiler = "as"`/`"gas"`, use `.s` files (no preprocessing). For `.S`, use `gcc` or `clang`.
|
|
||||||
- In workspace root, `dcr build` builds all members in dependency order.
|
|
||||||
- `build.exclude` removes paths from source/header collection; `build.include` re-allows matching paths and has priority over `exclude`.
|
|
||||||
- `build.steps` run before compilation; `build.post_steps` run after linking.
|
|
||||||
- `build.generated` is cleaned when `build.steps` need to rerun; `build.expect` is verified after post-steps.
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
# dcr clean
|
|
||||||
|
|
||||||
Removes build artifacts in `target/`.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr clean
|
|
||||||
dcr clean --debug
|
|
||||||
dcr clean --release
|
|
||||||
dcr clean --all
|
|
||||||
dcr clean --release --all
|
|
||||||
```
|
|
||||||
|
|
||||||
## Behavior
|
|
||||||
|
|
||||||
- Without arguments: removes entire `target/`.
|
|
||||||
- With profile: removes only `target/<profile>/`.
|
|
||||||
- With `--all`: also cleans all workspace members.
|
|
||||||
- Additionally removes paths from `build.clean` if configured.
|
|
||||||
- `build.clean` supports `{profile}` and version placeholders.
|
|
||||||
|
|
||||||
## Validation
|
|
||||||
|
|
||||||
- `dcr.toml` must exist.
|
|
||||||
- Unknown flags are treated as error.
|
|
||||||
- If `target` or selected profile directory does not exist, command prints a warning.
|
|
||||||
@@ -1,170 +0,0 @@
|
|||||||
# dcr gen
|
|
||||||
|
|
||||||
Generates IDE and build tool integration files for C/C++ development environments.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr gen project-info
|
|
||||||
dcr gen project-info --release
|
|
||||||
dcr gen compile-commands
|
|
||||||
dcr gen compile-commands --debug
|
|
||||||
dcr gen vscode
|
|
||||||
dcr gen vscode --release
|
|
||||||
dcr gen clion
|
|
||||||
dcr gen clion --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
## Subcommands
|
|
||||||
|
|
||||||
### `dcr gen project-info`
|
|
||||||
|
|
||||||
Outputs project metadata as JSON array.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr gen project-info [--debug | --release]
|
|
||||||
```
|
|
||||||
|
|
||||||
Outputs structured information about the project (root project + all workspace members if present):
|
|
||||||
|
|
||||||
```json
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"name": "my-project",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"root": "/path/to/root",
|
|
||||||
"profile": "debug",
|
|
||||||
"language": "c++",
|
|
||||||
"standard": "c++17",
|
|
||||||
"compiler": "g++",
|
|
||||||
"kind": "bin",
|
|
||||||
"sources": ["/path/to/root/src/main.cpp", ...],
|
|
||||||
"include_dirs": ["/path/to/dep/include", ...],
|
|
||||||
"lib_dirs": ["/path/to/dep/lib", ...],
|
|
||||||
"libs": ["somelib", ...],
|
|
||||||
"cflags": ["-Wall", ...],
|
|
||||||
"ldflags": ["-lm", ...]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
This is useful for integrating DCR projects with custom build tools or scripts.
|
|
||||||
|
|
||||||
### `dcr gen compile-commands`
|
|
||||||
|
|
||||||
Generates `compile_commands.json` for use by `clangd`, `clang-tidy`, and other tools.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr gen compile-commands [--debug | --release]
|
|
||||||
```
|
|
||||||
|
|
||||||
Writes `./compile_commands.json` containing compilation database entries for all source files. This file is recognized by:
|
|
||||||
- LSP servers (`clangd`, `clang-tools-extra`)
|
|
||||||
- Linters (`clang-tidy`)
|
|
||||||
- Format tools (`clang-format`)
|
|
||||||
|
|
||||||
The entries include:
|
|
||||||
- Full compiler command with flags
|
|
||||||
- Source file path
|
|
||||||
- Object file output path
|
|
||||||
- Project root as working directory
|
|
||||||
|
|
||||||
### `dcr gen vscode`
|
|
||||||
|
|
||||||
Generates Visual Studio Code integration files.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr gen vscode [--debug | --release]
|
|
||||||
```
|
|
||||||
|
|
||||||
Creates `.vscode/` directory with:
|
|
||||||
|
|
||||||
- **`launch.json`**: Debug configurations (one per binary target, debug + release variants)
|
|
||||||
- **`tasks.json`**: Build/run/clean tasks using `dcr` commands
|
|
||||||
- **`settings.json`**: Clangd configuration pointing to `compile_commands.json`
|
|
||||||
- **`extensions.json`**: Recommends `clangd`, disables `cpptools`
|
|
||||||
- **`compile_commands.json`**: Compilation database (same as `dcr gen compile-commands`)
|
|
||||||
|
|
||||||
Usage in VSCode:
|
|
||||||
- Open the Command Palette (`Ctrl+Shift+P`) and select **"Debug: Start Debugging"** to run debugger
|
|
||||||
- Press `Ctrl+Shift+B` to run the build task
|
|
||||||
- Clangd will provide IntelliSense and diagnostics based on `compile_commands.json`
|
|
||||||
- Generated `launch.json` uses CodeLLDB (`type: "lldb"`), so install `vadimcn.vscode-lldb`
|
|
||||||
|
|
||||||
### `dcr gen clion`
|
|
||||||
|
|
||||||
Generates JetBrains CLion integration files.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr gen clion [--debug | --release]
|
|
||||||
```
|
|
||||||
|
|
||||||
Creates `.idea/` directory with:
|
|
||||||
|
|
||||||
- **`externalTools.xml`**: Registers DCR build/clean/gen commands as external tools
|
|
||||||
- **`customTargets.xml`**: Defines build targets for debug and release
|
|
||||||
- **`misc.xml`**: Points CLion to `compile_commands.json` for compilation database
|
|
||||||
- **`.idea/.gitignore`**: Ignores auto-generated files
|
|
||||||
- **`runConfigurations/*.xml`**: Debug run configs (one per binary target)
|
|
||||||
- **`compile_commands.json`**: Compilation database (same as `dcr gen compile-commands`)
|
|
||||||
|
|
||||||
Usage in CLion:
|
|
||||||
- Build/clean via **Tools → DCR → Build Debug/Release/Clean**
|
|
||||||
- Run/debug via **Run → Run Configurations** (dropdown) → select generated config
|
|
||||||
- Code completion and diagnostics come from the compilation database
|
|
||||||
|
|
||||||
## Config values used
|
|
||||||
|
|
||||||
- `package.name`
|
|
||||||
- `build.compiler`
|
|
||||||
- `build.language`
|
|
||||||
- `build.standard`
|
|
||||||
- `build.kind`
|
|
||||||
- `build.target`
|
|
||||||
- `build.platform`
|
|
||||||
- `build.cflags`
|
|
||||||
- `build.ldflags`
|
|
||||||
- `build.debug` / `build.release`
|
|
||||||
- `build.exclude`
|
|
||||||
- `build.include`
|
|
||||||
- `build.pkg_config`
|
|
||||||
- `build.roots`
|
|
||||||
- `build.src_disable`
|
|
||||||
- Workspace members (if `[workspace]` is present)
|
|
||||||
|
|
||||||
## Workspace support
|
|
||||||
|
|
||||||
When running `dcr gen` in a workspace root, all commands process both the root project and all workspace members:
|
|
||||||
|
|
||||||
- `project-info` returns an array with entries for each member + root
|
|
||||||
- `compile-commands` includes entries from all members
|
|
||||||
- `vscode` and `clion` generate unified configurations that work across all members
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Clangd not picking up includes
|
|
||||||
|
|
||||||
- Ensure `compile_commands.json` exists in the workspace root
|
|
||||||
- In VSCode settings, verify `clangd.arguments` includes `--compile-commands-dir=<workspace-root>`
|
|
||||||
- Rebuild via `dcr gen compile-commands` if sources or dependencies changed
|
|
||||||
|
|
||||||
### Debug configuration not working
|
|
||||||
|
|
||||||
- Verify binary paths in `launch.json` match actual build output (`target/<profile>/binary-name`)
|
|
||||||
- For workspace projects, each member's debug config uses its own `target/` directory
|
|
||||||
- Ensure GDB/LLDB is installed: `gdb --version` or `lldb --version`
|
|
||||||
- If VSCode reports unsupported debugger type, install the extension that matches `launch.json` type (`vadimcn.vscode-lldb` for `lldb`)
|
|
||||||
|
|
||||||
### CLion not recognizing includes
|
|
||||||
|
|
||||||
- Regenerate via `dcr gen clion --debug`
|
|
||||||
- File → Invalidate Caches → Invalidate and Restart
|
|
||||||
- Verify `.idea/misc.xml` points to correct `compile_commands.json` path
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- Profiles default to `debug` if not specified
|
|
||||||
- Generation does not require the project to be built first
|
|
||||||
- Generated files are safe to commit; they are generated from `dcr.toml` and thus repeatable
|
|
||||||
- IDE configurations may be customized after generation, but changes will be overwritten on next `dcr gen` run
|
|
||||||
- For multi-binary projects, `vscode` and `clion` generate debug configs for all binaries (both debug + release variants)
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
# dcr init/new
|
|
||||||
|
|
||||||
## `dcr new <name>`
|
|
||||||
|
|
||||||
Creates a new project directory and initializes it.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr new hello
|
|
||||||
```
|
|
||||||
|
|
||||||
Behavior:
|
|
||||||
|
|
||||||
1. Validates arguments (`<name>` is required, only one name is allowed).
|
|
||||||
2. Creates `<name>/`.
|
|
||||||
3. Creates `<name>/dcr.toml`.
|
|
||||||
4. Sets `package.name = "<name>"`.
|
|
||||||
5. Creates `<name>/src/main.c` with a Hello World template.
|
|
||||||
|
|
||||||
Errors:
|
|
||||||
|
|
||||||
- Missing project name.
|
|
||||||
- Extra arguments.
|
|
||||||
- Target directory already exists.
|
|
||||||
|
|
||||||
## `dcr init`
|
|
||||||
|
|
||||||
Initializes DCR in the current directory.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr init
|
|
||||||
```
|
|
||||||
|
|
||||||
Behavior:
|
|
||||||
|
|
||||||
1. Requires current directory to be empty.
|
|
||||||
2. Creates `dcr.toml`.
|
|
||||||
3. Sets `package.name` from the current directory name.
|
|
||||||
4. Creates `src/main.c`.
|
|
||||||
|
|
||||||
Errors:
|
|
||||||
|
|
||||||
- Any arguments are treated as invalid.
|
|
||||||
- Non-empty directory is rejected.
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
# dcr run
|
|
||||||
|
|
||||||
Builds the project and runs the resulting binary.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr run
|
|
||||||
dcr run --debug
|
|
||||||
dcr run --release
|
|
||||||
dcr run --target linux --release
|
|
||||||
dcr run --release --force
|
|
||||||
dcr run --debug --clean
|
|
||||||
```
|
|
||||||
|
|
||||||
## Behavior
|
|
||||||
|
|
||||||
1. Validates `dcr.toml`.
|
|
||||||
2. Reads `package.name`, `build.kind`, and optional `build.target`.
|
|
||||||
3. Runs the same build flow as `dcr build`.
|
|
||||||
4. Executes the built artifact path for the selected profile.
|
|
||||||
5. If `[run].cmd` is set, runs that command instead of the built binary.
|
|
||||||
|
|
||||||
## Restrictions
|
|
||||||
|
|
||||||
- If `build.kind = "staticlib"` or `build.kind = "sharedlib"`, `run` exits with error.
|
|
||||||
- The profile is selected from the first argument.
|
|
||||||
- `--target <triple>` runs the binary for specified target (short names: `linux`, `macos`, `windows`).
|
|
||||||
- `--force` skips build cache checks and recompiles.
|
|
||||||
- `--clean` removes `target/<profile>` and `build.clean` paths before building.
|
|
||||||
|
|
||||||
## `run.cmd` variables
|
|
||||||
|
|
||||||
`run.cmd` supports the same variables as build steps: `{profile}`, `{version}`, `{version_major}`,
|
|
||||||
`{version_minor}`, `{version_patch}`, `{version_suffix}`, `{version_suffix_dash}`.
|
|
||||||
The command runs via `sh -c` on Unix and `cmd /C` on Windows.
|
|
||||||
|
|
||||||
## On build failure
|
|
||||||
|
|
||||||
`dcr run` attempts to launch an existing binary from the same profile if present; otherwise it reports that code errors must be fixed.
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
# dcr test
|
|
||||||
|
|
||||||
Runs the project's test suite.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr test
|
|
||||||
dcr test --release
|
|
||||||
dcr test --target linux
|
|
||||||
dcr test --init
|
|
||||||
```
|
|
||||||
|
|
||||||
## What `test` does
|
|
||||||
|
|
||||||
1. Builds the project with the specified profile/target.
|
|
||||||
2. Compiles test files in `tests/` (e.g., `tests/test.c`) into a test binary.
|
|
||||||
3. Runs the test binary and parses output for PASS/SKIP/FAIL results.
|
|
||||||
4. Reports summary with colored output.
|
|
||||||
|
|
||||||
## Test Structure
|
|
||||||
|
|
||||||
DCR uses a simple test framework:
|
|
||||||
|
|
||||||
- Header: `tests/dcr_test.h` (generated by `dcr test --init`)
|
|
||||||
- Test file: `tests/test.c` (template generated by `dcr test --init`)
|
|
||||||
- Macros: `TEST(name)`, `TEST_CASE(name)`, `EXPECT(condition)`, `SKIP(reason)`
|
|
||||||
- Output: `[PASS] test_name`, `[FAIL] test_name`, or `[SKIP] test_name`
|
|
||||||
|
|
||||||
## Config values used
|
|
||||||
|
|
||||||
- `package.name`
|
|
||||||
- `build.compiler`, `build.language`, `build.standard`
|
|
||||||
- `build.cflags`, `build.ldflags`
|
|
||||||
- `build.debug` / `build.release`
|
|
||||||
- `build.targets` (if specified)
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- Test binary is linked with the main project (for lib projects) or standalone.
|
|
||||||
- `--init` creates `tests/dcr_test.h` and `tests/test.c` if missing.
|
|
||||||
- Tests run in release mode by default for performance.
|
|
||||||
- Custom test logic can be added by editing `tests/test.c`.
|
|
||||||
- Fails if no `tests/test.c` exists (run `dcr test --init` first).
|
|
||||||
51
docs/commands/dependency-commands.mdx
Normal file
51
docs/commands/dependency-commands.mdx
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
---
|
||||||
|
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`).
|
||||||
71
docs/commands/gen-commands.mdx
Normal file
71
docs/commands/gen-commands.mdx
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
---
|
||||||
|
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": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
# Global options
|
|
||||||
|
|
||||||
## `dcr --help`
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr --help
|
|
||||||
```
|
|
||||||
|
|
||||||
Prints top-level CLI usage, commands, flags, and examples.
|
|
||||||
|
|
||||||
## `dcr --version`
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr --version
|
|
||||||
```
|
|
||||||
|
|
||||||
Prints:
|
|
||||||
|
|
||||||
```text
|
|
||||||
dcr <version> (<target>)
|
|
||||||
```
|
|
||||||
|
|
||||||
## `dcr --update`
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr --update
|
|
||||||
```
|
|
||||||
|
|
||||||
Update flow:
|
|
||||||
|
|
||||||
1. Requests latest release from GitHub API.
|
|
||||||
2. Finds asset matching current `DCR_TARGET`.
|
|
||||||
3. Downloads replacement binary.
|
|
||||||
4. Replaces current executable via `self-replace`.
|
|
||||||
|
|
||||||
Limitations and behavior:
|
|
||||||
|
|
||||||
- No extra arguments are accepted.
|
|
||||||
- Requires network access to GitHub API/assets.
|
|
||||||
- On Linux, if binary is owned by pacman, DCR prints package-manager update instructions instead of self-updating.
|
|
||||||
|
|
||||||
## Running without command
|
|
||||||
|
|
||||||
Running plain `dcr` (without arguments) shows help output.
|
|
||||||
30
docs/commands/project-commands.mdx
Normal file
30
docs/commands/project-commands.mdx
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
mkdir app && cd app
|
||||||
|
dcr init
|
||||||
|
```
|
||||||
|
|
||||||
|
The project name is taken from the current directory name. The directory name must follow the same naming rules as `dcr new`.
|
||||||
59
docs/commands/quality-commands.mdx
Normal file
59
docs/commands/quality-commands.mdx
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
---
|
||||||
|
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.
|
||||||
50
docs/commands/system-commands.mdx
Normal file
50
docs/commands/system-commands.mdx
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
---
|
||||||
|
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]]
|
||||||
|
name = "default"
|
||||||
|
url = "https://index.dcr.pm"
|
||||||
|
```
|
||||||
|
|
||||||
|
## `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
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
# Build profiles
|
|
||||||
|
|
||||||
DCR supports two profiles:
|
|
||||||
|
|
||||||
- `debug` (default)
|
|
||||||
- `release`
|
|
||||||
|
|
||||||
## How to select
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr build --debug
|
|
||||||
dcr build --release
|
|
||||||
dcr run --release
|
|
||||||
dcr clean --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also add `--force` or `--clean` to `build`/`run`.
|
|
||||||
|
|
||||||
## Default profile flags
|
|
||||||
|
|
||||||
### GCC/Clang-like toolchains
|
|
||||||
|
|
||||||
- `debug`: `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG`
|
|
||||||
- `release`: `-O3 -DNDEBUG`
|
|
||||||
|
|
||||||
### MSVC toolchain
|
|
||||||
|
|
||||||
- `debug`: `/Od /Zi /W4 /DDCR_DEBUG /Oy-`
|
|
||||||
- `release`: `/O2 /DNDEBUG`
|
|
||||||
|
|
||||||
## Artifacts
|
|
||||||
|
|
||||||
By default:
|
|
||||||
|
|
||||||
- `target/debug/<name>` (or `.exe` on Windows)
|
|
||||||
- `target/release/<name>` (or `.exe` on Windows)
|
|
||||||
|
|
||||||
Default compiler flags:
|
|
||||||
|
|
||||||
GCC/Clang:
|
|
||||||
|
|
||||||
- `debug`: `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG`
|
|
||||||
- `release`: `-O3 -DNDEBUG`
|
|
||||||
|
|
||||||
MSVC:
|
|
||||||
|
|
||||||
- `debug`: `/Od /Zi /W4 /DDCR_DEBUG /Oy-`
|
|
||||||
- `release`: `/O2 /DNDEBUG`
|
|
||||||
|
|
||||||
Static library mode (`kind = "staticlib"`):
|
|
||||||
|
|
||||||
- Linux/macOS: `lib<name>.a`
|
|
||||||
- Windows: `<name>.lib`
|
|
||||||
|
|
||||||
Shared library mode (`kind = "sharedlib"`):
|
|
||||||
|
|
||||||
- Linux: `lib<name>.so`
|
|
||||||
- macOS: `lib<name>.dylib`
|
|
||||||
- Windows: `<name>.dll`
|
|
||||||
|
|
||||||
## Profile overrides
|
|
||||||
|
|
||||||
Use `[build.debug]` and `[build.release]` to override build settings per profile.
|
|
||||||
All values inherit from `[build]`. If a field is present in the profile table, it replaces the base value.
|
|
||||||
For arrays (like `cflags`/`ldflags`), the profile value is appended to the base array.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build.debug]
|
|
||||||
cflags = ["-g3"]
|
|
||||||
|
|
||||||
[build.release]
|
|
||||||
cflags = ["-O3"]
|
|
||||||
ldflags = ["-s"]
|
|
||||||
```
|
|
||||||
@@ -1,148 +0,0 @@
|
|||||||
# Build section
|
|
||||||
|
|
||||||
## Schema
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build]
|
|
||||||
language = "c"
|
|
||||||
standard = "c11"
|
|
||||||
compiler = "clang"
|
|
||||||
kind = "bin"
|
|
||||||
# optional:
|
|
||||||
# inherit = true # Inherit from base (default true)
|
|
||||||
# targets = ["linux", "macos"] # Multiple targets to build
|
|
||||||
# target = "./dist"
|
|
||||||
# platform = "x86_64"
|
|
||||||
# cflags = ["-Wall"]
|
|
||||||
# ldflags = ["-lm"]
|
|
||||||
# exclude = ["src/vendor", "src/legacy/**"]
|
|
||||||
# include = ["src/legacy/boot/**"]
|
|
||||||
# roots = ["kernel", "drivers"]
|
|
||||||
# src_disable = true
|
|
||||||
# pkg_config = ["Qt6Core", "Qt6Widgets"]
|
|
||||||
# generated = ["src/ui/*.h"]
|
|
||||||
# expect = ["./target/{profile}/boot/*.bin"]
|
|
||||||
# clean = ["./target/{profile}/boot", "/tmp/image/*.img"]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
- `language` (string or array, required): `c`, `c++`, `cpp`, `cxx`, or `asm`.
|
|
||||||
Mixed languages can be specified as an array, for example `["c", "c++", "asm"]`.
|
|
||||||
- `standard` (string, required): language standard passed to compiler.
|
|
||||||
- `compiler` (string, required): compiler command (for example `clang`, `gcc`, `cl`).
|
|
||||||
- `kind` (string, required): `bin`, `staticlib`, or `sharedlib`.
|
|
||||||
- `inherit` (bool, optional): inherit settings from base `[build]` (default `true`). If `false`, only use target/profile specific settings.
|
|
||||||
- `targets` (string array, optional): list of targets to build simultaneously. Supports short names (`linux`, `macos`, `windows`).
|
|
||||||
- `target` (string, optional): custom output directory for final artifact.
|
|
||||||
- `platform` (string, optional): architecture hint for compiler (used for `-march` or `/arch`).
|
|
||||||
- `cflags` (string array, optional): extra compile flags.
|
|
||||||
- `ldflags` (string array, optional): extra link flags.
|
|
||||||
- `exclude` (string array, optional): paths or glob patterns to skip during source/header collection.
|
|
||||||
- `include` (string array, optional): allowlist paths or globs that override `exclude`.
|
|
||||||
- `include` directory entries (non-glob) are also passed to the compiler as `-I` include paths.
|
|
||||||
- `roots` (string array, optional): additional source roots to scan instead of `src/`.
|
|
||||||
- `src_disable` (bool, optional): disables default `src/` root when true.
|
|
||||||
- `pkg_config` (string array, optional): packages used to append `pkg-config --cflags/--libs`.
|
|
||||||
- `generated` (string array, optional): generated files to delete when build steps rerun.
|
|
||||||
- `expect` (string array, optional): artifacts that must exist after build/post-steps.
|
|
||||||
- `clean` (string array, optional): additional paths removed by `dcr clean` and `--clean`.
|
|
||||||
|
|
||||||
Notes for `exclude`/`include`:
|
|
||||||
- Supports `*` and `**` glob patterns.
|
|
||||||
- If `include` is set, it has priority over `exclude`.
|
|
||||||
- Use `include` to re-allow nested paths, for example exclude `src/boot` but allow `src/boot/arch/**`.
|
|
||||||
When using glob patterns in `exclude`, DCR converts them internally, so `exclude` globs still work as expected.
|
|
||||||
|
|
||||||
### Build steps
|
|
||||||
|
|
||||||
Build steps run shell commands before compilation. Post steps run after linking.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[[build.steps]]
|
|
||||||
name = "uic"
|
|
||||||
in = "src/ui/*.ui"
|
|
||||||
out = "src/ui/{stem}.h"
|
|
||||||
cmd = "{uic} {in} -o {out}"
|
|
||||||
|
|
||||||
[[build.post_steps]]
|
|
||||||
name = "image"
|
|
||||||
in = "target/{profile}/boot/*.bin"
|
|
||||||
out = "/tmp/image/os-{version}.img"
|
|
||||||
cmd = "dd if=/dev/zero of={out} bs=1M count=8"
|
|
||||||
```
|
|
||||||
|
|
||||||
Step notes:
|
|
||||||
- `in` supports glob patterns.
|
|
||||||
- If `in` expands to multiple files, `out` must include `{stem}`.
|
|
||||||
- Steps run only when inputs are newer than outputs.
|
|
||||||
- Variables: `{in}`, `{out}`, `{stem}`, `{cflags}`, `{uic}`, `{moc}`, `{rcc}`, `{profile}`,
|
|
||||||
`{version}`, `{version_major}`, `{version_minor}`, `{version_patch}`, `{version_suffix}`, `{version_suffix_dash}`.
|
|
||||||
|
|
||||||
`build.clean` supports `{profile}` and version placeholders (`{version}`, `{version_major}`, ...).
|
|
||||||
|
|
||||||
### Profile overrides
|
|
||||||
|
|
||||||
Profile tables inherit all values from `[build]`. Any field present in the profile table replaces the base value.
|
|
||||||
Array fields (like `cflags`/`ldflags`) are appended to the base array.
|
|
||||||
|
|
||||||
Target tables override profile and base settings for specific targets. Full inheritance order:
|
|
||||||
1. `[build.<target>.<profile>]`
|
|
||||||
2. `[build.<profile>.<target>]`
|
|
||||||
3. `[build.<target>]`
|
|
||||||
4. `[build.<profile>]`
|
|
||||||
5. `[build]`
|
|
||||||
|
|
||||||
If custom `cflags` are set (non-empty), default compiler flags are disabled.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build.debug]
|
|
||||||
cflags = ["-g3"]
|
|
||||||
|
|
||||||
[build.release]
|
|
||||||
cflags = ["-O3"]
|
|
||||||
ldflags = ["-s"]
|
|
||||||
|
|
||||||
# Target-specific overrides (applied after profile)
|
|
||||||
[build.linux]
|
|
||||||
compiler = "gcc"
|
|
||||||
cflags = ["-march=x86_64"]
|
|
||||||
|
|
||||||
[build.macos]
|
|
||||||
compiler = "clang"
|
|
||||||
cflags = ["-arch", "x86_64"]
|
|
||||||
|
|
||||||
# Full inheritance example
|
|
||||||
[build.linux.release]
|
|
||||||
cflags = ["-O3", "-march=native"] # Overrides profile and base
|
|
||||||
|
|
||||||
[build.release.linux]
|
|
||||||
ldflags = ["-static"] # Alternative order
|
|
||||||
|
|
||||||
[build.windows.debug]
|
|
||||||
compiler = "x86_64-w64-mingw32-gcc"
|
|
||||||
cflags = [] # Empty to disable defaults
|
|
||||||
|
|
||||||
[build.release]
|
|
||||||
inherit = false # No inheritance, only explicit settings
|
|
||||||
```
|
|
||||||
|
|
||||||
## Toolchain section
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[toolchain]
|
|
||||||
cc = "clang"
|
|
||||||
cxx = "clang++"
|
|
||||||
as = "as"
|
|
||||||
ar = "ar"
|
|
||||||
ld = "ld"
|
|
||||||
uic = "uic"
|
|
||||||
moc = "moc"
|
|
||||||
rcc = "rcc"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Behavior notes
|
|
||||||
|
|
||||||
- Compiler backend is selected by compiler string (`gcc`, `clang`, `cl`, `clang-cl`).
|
|
||||||
- Empty or unknown compiler value falls back to clang-like build path.
|
|
||||||
- `run` is not allowed for library kinds (`staticlib`, `sharedlib`).
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
# dcr.toml overview
|
|
||||||
|
|
||||||
`dcr.toml` is the main project file used by DCR.
|
|
||||||
|
|
||||||
## Minimal generated template
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[package]
|
|
||||||
name = "hello"
|
|
||||||
version = "0.1.0"
|
|
||||||
|
|
||||||
[build]
|
|
||||||
language = "c"
|
|
||||||
standard = "c11"
|
|
||||||
compiler = "clang"
|
|
||||||
kind = "bin"
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
```
|
|
||||||
|
|
||||||
`dcr new` and `dcr init` generate this structure automatically.
|
|
||||||
|
|
||||||
## Required sections
|
|
||||||
|
|
||||||
- `[package]`
|
|
||||||
- `[build]`
|
|
||||||
- `[dependencies]`
|
|
||||||
|
|
||||||
Workspace-only root:
|
|
||||||
- `[workspace]` can be added to a normal root config to define members and dependency order.
|
|
||||||
- Root config still requires `[package]`, `[build]`, and `[dependencies]`.
|
|
||||||
|
|
||||||
## Required keys
|
|
||||||
|
|
||||||
- `package.name`
|
|
||||||
- `package.version`
|
|
||||||
- `build.language`
|
|
||||||
- `build.standard`
|
|
||||||
- `build.compiler`
|
|
||||||
- `build.kind`
|
|
||||||
|
|
||||||
`build.kind` must be either `bin`, `staticlib`, or `sharedlib`.
|
|
||||||
|
|
||||||
## Optional keys
|
|
||||||
|
|
||||||
- `build.inherit`
|
|
||||||
- `build.targets`
|
|
||||||
- `build.target`
|
|
||||||
- `build.platform`
|
|
||||||
- `build.cflags`
|
|
||||||
- `build.ldflags`
|
|
||||||
- `build.exclude`
|
|
||||||
- `build.include`
|
|
||||||
- `build.roots`
|
|
||||||
- `build.src_disable`
|
|
||||||
- `build.pkg_config`
|
|
||||||
- `build.steps`
|
|
||||||
- `build.post_steps`
|
|
||||||
- `build.generated`
|
|
||||||
- `build.expect`
|
|
||||||
- `build.clean`
|
|
||||||
- `build.debug`
|
|
||||||
- `build.release`
|
|
||||||
- `build.<target>` (target-specific overrides)
|
|
||||||
- dependency fields (`include`, `lib`, `libs`, `system`)
|
|
||||||
- `[toolchain]` overrides (`cc`, `cxx`, `as`, `ar`, `ld`, `uic`, `moc`, `rcc`)
|
|
||||||
- `[toolchain.<target>]` (target-specific toolchain)
|
|
||||||
- `[workspace]` members
|
|
||||||
- `[workspace.<target>]` (target-specific workspace)
|
|
||||||
- `[run]` overrides (`cmd`)
|
|
||||||
- `[run.<target>]` (target-specific run)
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
# Dependencies section
|
|
||||||
|
|
||||||
DCR currently supports path dependencies.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[dependencies]
|
|
||||||
frecli = { path = "./lib/frecli", include = ["."], lib = ["."], libs = ["frecli"] }
|
|
||||||
```
|
|
||||||
|
|
||||||
## Supported fields per dependency
|
|
||||||
|
|
||||||
- `path` (string, required): absolute path or path relative to project root.
|
|
||||||
- `include` (string array, optional): include directories inside dependency.
|
|
||||||
- `lib` (string array, optional): library directories inside dependency.
|
|
||||||
- `libs` (string array, optional): library names for linker.
|
|
||||||
- `system` (bool, optional): currently `system = true` is rejected.
|
|
||||||
|
|
||||||
## Defaults
|
|
||||||
|
|
||||||
- If `include` is omitted, DCR tries `<dep>/include`.
|
|
||||||
- If `lib` is omitted, DCR tries `<dep>/lib`, then `<dep>/lib64`.
|
|
||||||
- If `libs` is omitted, dependency key name is used.
|
|
||||||
|
|
||||||
## Validation
|
|
||||||
|
|
||||||
- Dependency value must be a TOML table.
|
|
||||||
- `path` is mandatory.
|
|
||||||
- `include`/`lib`/`libs` must be arrays of strings if provided.
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# Package section
|
|
||||||
|
|
||||||
## Schema
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[package]
|
|
||||||
name = "my-app"
|
|
||||||
version = "0.1.0"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
- `name` (string, required): used as output artifact base name.
|
|
||||||
- `version` (string, required): used in `dcr.lock` project entry.
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- Empty `name` or `version` makes config invalid.
|
|
||||||
- `dcr new` sets `name` from the passed project name.
|
|
||||||
- `dcr init` sets `name` from current directory name.
|
|
||||||
50
docs/contributing.mdx
Normal file
50
docs/contributing.mdx
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
---
|
||||||
|
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
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
# Compilers & linking
|
|
||||||
|
|
||||||
## Compiler backend selection
|
|
||||||
|
|
||||||
DCR picks a backend from `build.compiler`:
|
|
||||||
|
|
||||||
- contains `clang-cl` -> MSVC backend
|
|
||||||
- equals `as` or contains `gas` -> GAS backend (standalone assembler)
|
|
||||||
- contains `gcc` or `g++` -> GCC backend
|
|
||||||
- contains `clang` or `clang++` -> Clang backend
|
|
||||||
- equals `cl` or contains `msvc` -> MSVC backend
|
|
||||||
- contains `nasm` -> NASM backend
|
|
||||||
- otherwise -> Clang backend fallback
|
|
||||||
|
|
||||||
## Compilation model
|
|
||||||
|
|
||||||
- Source files are found recursively in `src/` based on `build.language`.
|
|
||||||
- `build.roots` and `build.src_disable` can replace the default `src/` root.
|
|
||||||
- Mixed language builds use arrays, for example `build.language = ["c", "asm"]`.
|
|
||||||
- Each source is compiled to `target/<target>/<profile>/obj/<relative-path>.o` (`.obj` on MSVC, where `<target>` is `native` or target triple).
|
|
||||||
- Recompile happens when source mtime is newer than object mtime.
|
|
||||||
- `build.exclude` removes paths from source/header collection; `build.include` re-allows matching paths and has priority over `exclude`.
|
|
||||||
|
|
||||||
## Default build flags
|
|
||||||
|
|
||||||
These flags are applied automatically based on profile and compiler backend.
|
|
||||||
|
|
||||||
GCC/Clang:
|
|
||||||
|
|
||||||
- `debug`: `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG`
|
|
||||||
- `release`: `-O3 -DNDEBUG`
|
|
||||||
|
|
||||||
MSVC:
|
|
||||||
|
|
||||||
- `debug`: `/Od /Zi /W4 /DDCR_DEBUG /Oy-`
|
|
||||||
- `release`: `/O2 /DNDEBUG`
|
|
||||||
|
|
||||||
Note: If custom `cflags` are set in `dcr.toml`, default profile flags are disabled to allow full control.
|
|
||||||
|
|
||||||
## Platform hint
|
|
||||||
|
|
||||||
If `build.platform` is set, DCR passes it as an architecture hint:
|
|
||||||
|
|
||||||
- GCC/Clang: `-march=<platform>`
|
|
||||||
- MSVC: maps to `/arch:*` for known values (`x86`, `i386`, `i486`, `i586`, `i686`, `sse2`, `avx`, `avx2`)
|
|
||||||
|
|
||||||
## Toolchain overrides
|
|
||||||
|
|
||||||
If `[toolchain]` is set, DCR uses its values to override compiler/linker tools:
|
|
||||||
|
|
||||||
- `cc`, `cxx`, `as` override compilers for C/C++/ASM
|
|
||||||
- `ar` overrides the archiver (used for `staticlib`)
|
|
||||||
- `ld` overrides the linker (used by GCC/Clang/NASM/GAS backends)
|
|
||||||
- `uic`, `moc`, `rcc` override Qt tools used in `build.steps`
|
|
||||||
|
|
||||||
Environment overrides (highest priority):
|
|
||||||
- `DCR_COMPILER` (all languages)
|
|
||||||
- `DCR_CC`, `DCR_CXX`, `DCR_AS`, `DCR_AR`, `DCR_LD`
|
|
||||||
- `DCR_DEBUG` enables verbose build logging
|
|
||||||
|
|
||||||
## Linking
|
|
||||||
|
|
||||||
For `kind = "bin"`:
|
|
||||||
|
|
||||||
- Object files are linked into executable artifact.
|
|
||||||
- Dependency lib dirs and library names are passed to linker.
|
|
||||||
- `build.ldflags` are appended to link command.
|
|
||||||
|
|
||||||
For `kind = "staticlib"`:
|
|
||||||
|
|
||||||
- Linux/macOS (GCC/Clang): `ar rcs` creates `.a` archive.
|
|
||||||
- Windows (MSVC): `lib` creates `.lib` archive.
|
|
||||||
|
|
||||||
For `kind = "sharedlib"`:
|
|
||||||
|
|
||||||
- Linux (GCC/Clang): `-shared` with output `.so`.
|
|
||||||
- macOS (Clang): `-dynamiclib` with output `.dylib`.
|
|
||||||
- Windows (MSVC): `/LD` with output `.dll`.
|
|
||||||
@@ -1,201 +0,0 @@
|
|||||||
# Cross-compilation and Targets
|
|
||||||
|
|
||||||
DCR supports cross-compilation to different platforms using the `--target` flag. This allows building your project for architectures and operating systems different from the host.
|
|
||||||
|
|
||||||
## Basic Usage
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Build for a specific target
|
|
||||||
dcr build --target x86_64-unknown-linux-gnu --release
|
|
||||||
|
|
||||||
# Short names for common platforms
|
|
||||||
dcr build --target linux --release # x86_64-unknown-linux-gnu
|
|
||||||
dcr build --target macos --release # x86_64-apple-darwin
|
|
||||||
dcr build --target windows --release # x86_64-pc-windows-msvc
|
|
||||||
|
|
||||||
# Run for a specific target
|
|
||||||
dcr run --target linux --release
|
|
||||||
```
|
|
||||||
|
|
||||||
## Supported Targets
|
|
||||||
|
|
||||||
### Short Names
|
|
||||||
- `linux` → `x86_64-unknown-linux-gnu`
|
|
||||||
- `macos` → `x86_64-apple-darwin`
|
|
||||||
- `windows` → `x86_64-pc-windows-msvc`
|
|
||||||
|
|
||||||
### Full Target Triples
|
|
||||||
DCR supports any valid target triple in the format `<arch>-<vendor>-<os>-<abi>`. Common examples:
|
|
||||||
- `x86_64-unknown-linux-gnu`
|
|
||||||
- `aarch64-linux-gnu`
|
|
||||||
- `x86_64-apple-darwin`
|
|
||||||
- `aarch64-apple-darwin`
|
|
||||||
- `x86_64-pc-windows-msvc`
|
|
||||||
- `i686-pc-windows-gnu`
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
### Multiple Targets
|
|
||||||
|
|
||||||
Configure multiple targets to build simultaneously:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build.targets]
|
|
||||||
targets = ["linux", "macos", "windows"]
|
|
||||||
|
|
||||||
# Or per profile
|
|
||||||
[build.release.targets]
|
|
||||||
targets = ["linux", "macos"]
|
|
||||||
```
|
|
||||||
|
|
||||||
If no `--target` is specified, DCR builds for all targets in `build.targets` (or native if empty).
|
|
||||||
|
|
||||||
### Target-Specific Settings
|
|
||||||
|
|
||||||
Override settings for specific targets:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build.linux]
|
|
||||||
compiler = "gcc"
|
|
||||||
cflags = ["-Wall", "-O2"]
|
|
||||||
|
|
||||||
[build.macos]
|
|
||||||
compiler = "clang"
|
|
||||||
cflags = ["-Wall", "-O2", "-arch", "x86_64"]
|
|
||||||
|
|
||||||
[build.windows]
|
|
||||||
compiler = "x86_64-w64-mingw32-gcc"
|
|
||||||
ldflags = ["-static"]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Target-Specific Toolchain
|
|
||||||
|
|
||||||
Configure toolchain per target:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[toolchain.linux]
|
|
||||||
cc = "gcc"
|
|
||||||
ld = "ld"
|
|
||||||
|
|
||||||
[toolchain.macos]
|
|
||||||
cc = "clang"
|
|
||||||
ld = "ld"
|
|
||||||
|
|
||||||
[toolchain.windows]
|
|
||||||
cc = "x86_64-w64-mingw32-gcc"
|
|
||||||
ld = "x86_64-w64-mingw32-ld"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Target-Specific Run Commands
|
|
||||||
|
|
||||||
Use custom run commands per target:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[run.linux]
|
|
||||||
cmd = "./target/linux/release/myapp"
|
|
||||||
|
|
||||||
[run.macos]
|
|
||||||
cmd = "open ./target/macos/release/myapp.app"
|
|
||||||
|
|
||||||
[run.windows]
|
|
||||||
cmd = "wine ./target/windows/release/myapp.exe"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Workspace and Dependencies Inheritance
|
|
||||||
|
|
||||||
Workspace and dependencies sections also support target/profile inheritance:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[workspace.linux]
|
|
||||||
members = [
|
|
||||||
{ name = "lib1", path = "libs/lib1" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[dependencies.linux]
|
|
||||||
sdl2 = { system = true, include = ["/usr/include/SDL2"] }
|
|
||||||
|
|
||||||
[dependencies.windows]
|
|
||||||
sdl2 = { system = true, include = ["C:/SDL2/include"] }
|
|
||||||
```
|
|
||||||
|
|
||||||
Order: `workspace.target.profile` → `workspace.profile.target` → `workspace.target` → `workspace.profile` → `workspace`.
|
|
||||||
|
|
||||||
Add `inherit = false` to disable inheritance in any section.
|
|
||||||
|
|
||||||
Settings are applied in order:
|
|
||||||
1. `[build.<target>]`
|
|
||||||
2. `[build.<profile>]`
|
|
||||||
3. `[build]`
|
|
||||||
|
|
||||||
### Toolchain Configuration
|
|
||||||
|
|
||||||
For cross-compilation, configure toolchains:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[toolchain]
|
|
||||||
cc = "aarch64-linux-gnu-gcc"
|
|
||||||
cxx = "aarch64-linux-gnu-g++"
|
|
||||||
ar = "aarch64-linux-gnu-ar"
|
|
||||||
ld = "aarch64-linux-gnu-ld"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Output Structure
|
|
||||||
|
|
||||||
Build outputs are organized by target:
|
|
||||||
|
|
||||||
```
|
|
||||||
target/
|
|
||||||
├── native/
|
|
||||||
│ ├── debug/
|
|
||||||
│ └── release/
|
|
||||||
├── x86_64-unknown-linux-gnu/
|
|
||||||
│ ├── debug/
|
|
||||||
│ └── release/
|
|
||||||
└── aarch64-linux-gnu/
|
|
||||||
├── debug/
|
|
||||||
└── release/
|
|
||||||
```
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
- Cross-compilation requires appropriate toolchains installed (e.g., `aarch64-linux-gnu-gcc` on Arch Linux).
|
|
||||||
- For Windows targets on Linux, install MinGW: `pacman -S mingw-w64-gcc`.
|
|
||||||
- For macOS targets on Linux, use `osxcross` or similar.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### ARM Linux Build
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install toolchain (Arch Linux)
|
|
||||||
pacman -S aarch64-linux-gnu-gcc
|
|
||||||
|
|
||||||
# Configure
|
|
||||||
echo '[build.aarch64-linux-gnu]
|
|
||||||
compiler = "aarch64-linux-gnu-gcc"' >> dcr.toml
|
|
||||||
|
|
||||||
# Build
|
|
||||||
dcr build --target aarch64-linux-gnu --release
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows Build on Linux
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install toolchain (Arch Linux)
|
|
||||||
pacman -S mingw-w64-gcc
|
|
||||||
|
|
||||||
# Configure
|
|
||||||
echo '[build.windows]
|
|
||||||
compiler = "x86_64-w64-mingw32-gcc"' >> dcr.toml
|
|
||||||
|
|
||||||
# Build
|
|
||||||
dcr build --target windows --release
|
|
||||||
```
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
- **Toolchain not found**: Ensure the compiler is installed and in PATH, or configure `[toolchain]` in `dcr.toml`. For Arch Linux: `pacman -S aarch64-linux-gnu-gcc` for ARM, `pacman -S mingw-w64-gcc` for Windows cross-compilation.
|
|
||||||
- **Linking errors**: Check `ldflags` and library paths for cross-compilation.
|
|
||||||
- **Header issues**: Include paths may differ; use target-specific `cflags`.
|
|
||||||
|
|
||||||
For more help, see [Troubleshooting map](troubleshooting-map.md).
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
# Dependency format
|
|
||||||
|
|
||||||
Dependencies are defined in `dcr.toml` under `[dependencies]`.
|
|
||||||
|
|
||||||
## Full example (Path)
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[dependencies]
|
|
||||||
fmt = { path = "./third_party/fmt", include = ["include"], lib = ["lib"], libs = ["fmt"] }
|
|
||||||
```
|
|
||||||
|
|
||||||
## Full example (Git)
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[dependencies]
|
|
||||||
json = { git = "https://github.com/nlohmann/json", tag = "v3.11.2" }
|
|
||||||
```
|
|
||||||
|
|
||||||
## Field reference
|
|
||||||
|
|
||||||
- `path`: local path to dependency root.
|
|
||||||
- `git`: URL of Git repository.
|
|
||||||
- `branch`: Git branch name.
|
|
||||||
- `tag`: Git tag name.
|
|
||||||
- `rev`: Git commit SHA.
|
|
||||||
- `include`: optional include subpaths (absolute or relative to dep root).
|
|
||||||
- `lib`: optional library subpaths (absolute or relative to dep root).
|
|
||||||
- `libs`: optional linker library names.
|
|
||||||
|
|
||||||
## Common valid compact forms
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[dependencies]
|
|
||||||
mylib = { path = "./libs/mylib" }
|
|
||||||
gitlib = { git = "https://github.com/user/repo" }
|
|
||||||
# Shortest form for path
|
|
||||||
simple = "./libs/simple"
|
|
||||||
```
|
|
||||||
|
|
||||||
In these forms DCR will try defaults for include/lib dirs and use the dependency name as the linker library name.
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
# Local dependencies
|
|
||||||
|
|
||||||
## Resolution flow during build
|
|
||||||
|
|
||||||
For each dependency in `[dependencies]`, DCR:
|
|
||||||
|
|
||||||
1. Resolves `path` (absolute or project-relative).
|
|
||||||
2. Resolves include dirs (`include` or default `include`).
|
|
||||||
3. Resolves lib dirs (`lib` or defaults `lib`, `lib64`).
|
|
||||||
4. Resolves link libs (`libs` or dependency name).
|
|
||||||
5. Synchronizes dependency files to `target/<profile>/deps/<dep-name>/`.
|
|
||||||
6. Adds include/lib/link options to compile/link commands.
|
|
||||||
|
|
||||||
### Profile placeholders
|
|
||||||
|
|
||||||
`path`, `include`, and `lib` entries may use `{profile}` which expands to the active profile
|
|
||||||
(`debug` or `release`).
|
|
||||||
|
|
||||||
## Failure cases
|
|
||||||
|
|
||||||
- Dependency path is missing or not a directory.
|
|
||||||
- No valid include/lib directories were found.
|
|
||||||
- Any configured include/lib path does not exist.
|
|
||||||
- Invalid field types in dependency config.
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# Target directory
|
|
||||||
|
|
||||||
By default, DCR writes final artifacts to `target/<target>/<profile>/` (where `<target>` is `native` or target triple).
|
|
||||||
|
|
||||||
You can override this with `build.target`:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build]
|
|
||||||
target = "./dist"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Behavior
|
|
||||||
|
|
||||||
- Binary mode:
|
|
||||||
- Linux/macOS: `<target>/<name>`
|
|
||||||
- Windows: `<target>/<name>.exe`
|
|
||||||
- Static library mode:
|
|
||||||
- Linux/macOS: `<target>/lib<name>.a`
|
|
||||||
- Windows: `<target>/<name>.lib`
|
|
||||||
|
|
||||||
## Important detail
|
|
||||||
|
|
||||||
`build.target` changes only the final artifact location. Object cache and dependency sync directories still use `target/<target>/<profile>/...`.
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
# Versioning & lock file
|
|
||||||
|
|
||||||
DCR generates `dcr.lock` when dependency resolution succeeds and at least one dependency exists.
|
|
||||||
|
|
||||||
## What is stored
|
|
||||||
|
|
||||||
- Project entry (`name`, `version`, dependency names).
|
|
||||||
- One entry per resolved dependency:
|
|
||||||
- `name`
|
|
||||||
- `version` (from dependency `dcr.toml`, fallback `0.0.0`)
|
|
||||||
- `source` (`path+...`)
|
|
||||||
- `checksum` (SHA-256 over dependency files, excluding nested `target/`).
|
|
||||||
|
|
||||||
## Example shape
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[[package]]
|
|
||||||
name = "my-app"
|
|
||||||
version = "0.1.0"
|
|
||||||
dependencies = ["fmt"]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "fmt"
|
|
||||||
version = "1.2.3"
|
|
||||||
source = "path+./third_party/fmt"
|
|
||||||
checksum = "..."
|
|
||||||
```
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- `dcr.lock` is rewritten on successful dependency resolution.
|
|
||||||
- If `[dependencies]` is empty, lock generation is skipped.
|
|
||||||
81
docs/faq.mdx
Normal file
81
docs/faq.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]]
|
||||||
|
name = "default"
|
||||||
|
url = "https://index.dcr.pm"
|
||||||
|
```
|
||||||
|
|
||||||
|
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`.
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
# Build and run
|
|
||||||
|
|
||||||
## Build
|
|
||||||
|
|
||||||
Debug (default):
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr build
|
|
||||||
# or
|
|
||||||
dcr build --debug
|
|
||||||
dcr build --target linux --debug
|
|
||||||
dcr build --debug --clean
|
|
||||||
```
|
|
||||||
|
|
||||||
Release:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr build --release
|
|
||||||
dcr build --target windows --release
|
|
||||||
```
|
|
||||||
|
|
||||||
## Run
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr run
|
|
||||||
# or
|
|
||||||
dcr run --target macos
|
|
||||||
dcr run --release
|
|
||||||
dcr run --target linux --release
|
|
||||||
dcr run --release --force
|
|
||||||
```
|
|
||||||
|
|
||||||
`dcr run` first builds, then launches the produced binary.
|
|
||||||
|
|
||||||
## Clean artifacts
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr clean
|
|
||||||
```
|
|
||||||
|
|
||||||
Profile-only cleanup:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr clean --debug
|
|
||||||
dcr clean --release
|
|
||||||
dcr clean --all
|
|
||||||
dcr clean --release --all
|
|
||||||
```
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- `run` is unavailable for `build.kind = "staticlib"` and `build.kind = "sharedlib"`.
|
|
||||||
- Build profile flag (`--debug` / `--release`) can be passed in any argument position.
|
|
||||||
- Unknown profile flags produce an error.
|
|
||||||
- In workspace root, `clean --all` cleans all member projects.
|
|
||||||
- `--target` builds/runs for specified target (short names: `linux`, `macos`, `windows`).
|
|
||||||
- `--clean` for `build`/`run` removes `target/<target>/<profile>` and paths from `build.clean`.
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
# Create your first project
|
|
||||||
|
|
||||||
## Create in a new folder
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr new hello
|
|
||||||
cd hello
|
|
||||||
```
|
|
||||||
|
|
||||||
This creates:
|
|
||||||
|
|
||||||
```text
|
|
||||||
hello/
|
|
||||||
- dcr.toml
|
|
||||||
- src/
|
|
||||||
- - main.c
|
|
||||||
```
|
|
||||||
|
|
||||||
## Or initialize current folder
|
|
||||||
|
|
||||||
```sh
|
|
||||||
mkdir hello
|
|
||||||
cd hello
|
|
||||||
dcr init
|
|
||||||
```
|
|
||||||
|
|
||||||
`dcr init` requires the current directory to be empty.
|
|
||||||
|
|
||||||
## Next steps
|
|
||||||
|
|
||||||
Build and run:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr run
|
|
||||||
```
|
|
||||||
|
|
||||||
Release build/run:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr run --release
|
|
||||||
```
|
|
||||||
70
docs/getting-started/first-steps.mdx
Normal file
70
docs/getting-started/first-steps.mdx
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
---
|
||||||
|
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
|
||||||
|
```
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
# Installation
|
|
||||||
|
|
||||||
## Option 1: Install via script
|
|
||||||
|
|
||||||
### Linux/macOS
|
|
||||||
|
|
||||||
```sh
|
|
||||||
curl -fsSL https://dcr.dexoron.su/install.sh | bash
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternative with `wget`:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
wget -qO- https://dcr.dexoron.su/install.sh | bash
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows (PowerShell)
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
powershell -ExecutionPolicy ByPass -c "irm https://dcr.dexoron.su/install.ps1 | iex"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Option 2: Build from source
|
|
||||||
|
|
||||||
```sh
|
|
||||||
git clone https://github.com/dexoron/dcr.git
|
|
||||||
cd dcr
|
|
||||||
cargo build --release
|
|
||||||
mkdir -p ~/.local/bin
|
|
||||||
ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
|
|
||||||
```
|
|
||||||
|
|
||||||
## Option 3: Arch Linux (AUR)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
yay -S dcr
|
|
||||||
```
|
|
||||||
|
|
||||||
(You can also use `paru` or other AUR helpers.)
|
|
||||||
|
|
||||||
## Verify installation
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dcr --version
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected format:
|
|
||||||
|
|
||||||
```text
|
|
||||||
dcr <version> (<target>)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Update policy
|
|
||||||
|
|
||||||
- If DCR was installed from GitHub releases, scripts, or manual build: use `dcr --update`.
|
|
||||||
- If DCR is managed by `pacman/AUR`: update via package manager. On Linux, `dcr --update` detects pacman-owned binaries and prints a package-manager hint.
|
|
||||||
106
docs/getting-started/installation.mdx
Normal file
106
docs/getting-started/installation.mdx
Normal file
@@ -0,0 +1,106 @@
|
|||||||
|
---
|
||||||
|
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]]
|
||||||
|
name = "default"
|
||||||
|
url = "https://index.dcr.pm"
|
||||||
|
```
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
# Project structure
|
|
||||||
|
|
||||||
## Minimal project
|
|
||||||
|
|
||||||
```text
|
|
||||||
project/
|
|
||||||
- dcr.toml
|
|
||||||
- src/
|
|
||||||
- - main.c
|
|
||||||
```
|
|
||||||
|
|
||||||
## Typical generated/optional files
|
|
||||||
|
|
||||||
```text
|
|
||||||
project/
|
|
||||||
- dcr.toml
|
|
||||||
- dcr.lock
|
|
||||||
- src/
|
|
||||||
- - ... source files ...
|
|
||||||
- target/
|
|
||||||
- - debug/
|
|
||||||
- - - obj/
|
|
||||||
- - - deps/
|
|
||||||
- - release/
|
|
||||||
- - - obj/
|
|
||||||
- - - deps/
|
|
||||||
```
|
|
||||||
|
|
||||||
## Meaning
|
|
||||||
|
|
||||||
- `dcr.toml`: main project configuration.
|
|
||||||
- `dcr.lock`: generated lock file for resolved path dependencies.
|
|
||||||
- `src/`: recursively scanned source directory.
|
|
||||||
- `target/<target>/<profile>/obj/`: cached object files for incremental rebuild (where `<target>` is `native` or target triple).
|
|
||||||
- `target/<target>/<profile>/deps/`: synchronized copies of path dependencies.
|
|
||||||
- `target/<target>/<profile>/<name>` (or `.exe` on Windows): output for `kind = "bin"`.
|
|
||||||
- `target/<target>/<profile>/lib<name>.a` (or `<name>.lib` on Windows): output for `kind = "staticlib"`.
|
|
||||||
- `target/<target>/<profile>/lib<name>.so` (or `.dylib` on macOS, `<name>.dll` on Windows): output for `kind = "sharedlib"`.
|
|
||||||
|
|
||||||
If `build.target` is set, the final artifact is written to that custom directory, while object cache still stays in `target/<target>/<profile>/obj`.
|
|
||||||
51
docs/ide-integration.mdx
Normal file
51
docs/ide-integration.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)).
|
||||||
46
docs/license.mdx
Normal file
46
docs/license.mdx
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
---
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Vendored libraries
|
||||||
|
|
||||||
|
DCR statically links the following C libraries through its vendored Rust dependencies:
|
||||||
|
|
||||||
|
| Library | License | Bundled by |
|
||||||
|
|---|---|---|
|
||||||
|
| [libgit2](https://libgit2.org) | MIT OR Apache-2.0 | `git2` / `libgit2-sys` |
|
||||||
|
| [libssh2](https://libssh2.org) | MIT OR Apache-2.0 | `libgit2-sys` |
|
||||||
|
| [zlib](https://zlib.net) | MIT OR Apache-2.0 | `libgit2-sys` |
|
||||||
|
| [OpenSSL](https://openssl.org) | Apache-2.0 | `openssl-sys` / `openssl-src` |
|
||||||
|
| [ring](https://github.com/briansmith/ring) | Apache-2.0 AND ISC | `rustls` |
|
||||||
|
|
||||||
|
## Rust dependencies
|
||||||
|
|
||||||
|
DCR is written in Rust. The following notable Rust crates are statically linked:
|
||||||
|
|
||||||
|
| Crate | License |
|
||||||
|
|---|---|
|
||||||
|
| [`reqwest`](https://crates.io/crates/reqwest) | MIT OR Apache-2.0 |
|
||||||
|
| [`rustls`](https://crates.io/crates/rustls) | Apache-2.0 OR ISC OR MIT |
|
||||||
|
| [`serde`](https://crates.io/crates/serde) | MIT OR Apache-2.0 |
|
||||||
|
| [`toml`](https://crates.io/crates/toml) | MIT OR Apache-2.0 |
|
||||||
|
| [`sha2`](https://crates.io/crates/sha2) | MIT OR Apache-2.0 |
|
||||||
|
| [`git2`](https://crates.io/crates/git2) | MIT OR Apache-2.0 |
|
||||||
|
| [`openssl`](https://crates.io/crates/openssl) | Apache-2.0 |
|
||||||
|
| [`tokio`](https://crates.io/crates/tokio) | MIT |
|
||||||
|
| [`hyper`](https://crates.io/crates/hyper) | MIT |
|
||||||
|
| [`ctrlc`](https://crates.io/crates/ctrlc) | MIT OR Apache-2.0 |
|
||||||
|
|
||||||
|
Full dependency tree (143 packages) 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/).
|
||||||
49
docs/recipes/cross-to-windows.mdx
Normal file
49
docs/recipes/cross-to-windows.mdx
Normal file
@@ -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++"
|
||||||
|
```
|
||||||
65
docs/recipes/library-project.mdx
Normal file
65
docs/recipes/library-project.mdx
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
---
|
||||||
|
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`
|
||||||
98
docs/recipes/multi-package-workspace.mdx
Normal file
98
docs/recipes/multi-package-workspace.mdx
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
---
|
||||||
|
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.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)
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
# CLI reference
|
|
||||||
|
|
||||||
## Command list
|
|
||||||
|
|
||||||
```text
|
|
||||||
dcr new <name>
|
|
||||||
dcr init
|
|
||||||
dcr build [--debug|--release]
|
|
||||||
dcr run [--debug|--release]
|
|
||||||
dcr clean [--debug|--release] [--all]
|
|
||||||
dcr gen <subcommand>
|
|
||||||
dcr --help
|
|
||||||
dcr --version
|
|
||||||
dcr --update
|
|
||||||
```
|
|
||||||
|
|
||||||
## Notes on argument parsing
|
|
||||||
|
|
||||||
- `build`/`run` parse flags in any order (`--debug|--release`, `--force`, `--clean`) and reject duplicates.
|
|
||||||
- `new` requires exactly one argument.
|
|
||||||
- `init` and `--update` do not accept extra arguments.
|
|
||||||
- `clean` accepts `--debug|--release` and optional `--all`.
|
|
||||||
- `gen` supports `project-info`, `compile-commands`, `vscode`, `clion`.
|
|
||||||
|
|
||||||
## Exit behavior overview
|
|
||||||
|
|
||||||
- Successful command execution returns `0`.
|
|
||||||
- Validation/build/runtime failures return non-zero status.
|
|
||||||
@@ -1,103 +0,0 @@
|
|||||||
# Config reference
|
|
||||||
|
|
||||||
## Full schema
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[package]
|
|
||||||
name = "string" # required
|
|
||||||
version = "string" # required
|
|
||||||
|
|
||||||
[build]
|
|
||||||
language = "c|c++|cpp|cxx|asm" # required (string or array)
|
|
||||||
standard = "string" # required
|
|
||||||
compiler = "string" # required
|
|
||||||
kind = "bin|staticlib|sharedlib" # required
|
|
||||||
target = "string" # optional
|
|
||||||
platform = "string" # optional
|
|
||||||
cflags = ["string", "..."] # optional
|
|
||||||
ldflags = ["string", "..."] # optional
|
|
||||||
exclude = ["string", "..."] # optional
|
|
||||||
include = ["string", "..."] # optional
|
|
||||||
roots = ["string", "..."] # optional
|
|
||||||
src_disable = false # optional
|
|
||||||
pkg_config = ["string", "..."] # optional
|
|
||||||
generated = ["string", "..."] # optional
|
|
||||||
expect = ["string", "..."] # optional
|
|
||||||
clean = ["string", "..."] # optional
|
|
||||||
|
|
||||||
[[build.steps]]
|
|
||||||
name = "string"
|
|
||||||
in = "glob"
|
|
||||||
out = "path or glob"
|
|
||||||
cmd = "string"
|
|
||||||
|
|
||||||
[[build.post_steps]]
|
|
||||||
name = "string"
|
|
||||||
in = "glob"
|
|
||||||
out = "path or glob"
|
|
||||||
cmd = "string"
|
|
||||||
|
|
||||||
# Inline array form (equivalent to [[build.steps]] / [[build.post_steps]])
|
|
||||||
steps = [
|
|
||||||
{ name = "string", in = "glob", out = "path or glob", cmd = "string" },
|
|
||||||
]
|
|
||||||
post_steps = [
|
|
||||||
{ name = "string", in = "glob", out = "path or glob", cmd = "string" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[build.debug]
|
|
||||||
cflags = ["string", "..."] # optional
|
|
||||||
ldflags = ["string", "..."] # optional
|
|
||||||
|
|
||||||
[build.release]
|
|
||||||
cflags = ["string", "..."] # optional
|
|
||||||
ldflags = ["string", "..."] # optional
|
|
||||||
|
|
||||||
[toolchain]
|
|
||||||
cc = "string" # optional
|
|
||||||
cxx = "string" # optional
|
|
||||||
as = "string" # optional
|
|
||||||
ar = "string" # optional
|
|
||||||
ld = "string" # optional
|
|
||||||
uic = "string" # optional
|
|
||||||
moc = "string" # optional
|
|
||||||
rcc = "string" # optional
|
|
||||||
|
|
||||||
[run]
|
|
||||||
cmd = "string" # optional
|
|
||||||
|
|
||||||
[workspace]
|
|
||||||
name = { path = "string", deps = ["string", "..."] }
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
name = {
|
|
||||||
path = "string", # required for each dependency
|
|
||||||
include = ["string", "..."], # optional
|
|
||||||
lib = ["string", "..."], # optional
|
|
||||||
libs = ["string", "..."], # optional
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Validation rules
|
|
||||||
|
|
||||||
- `[package]`, `[build]`, `[dependencies]` must exist.
|
|
||||||
- Required string fields must be non-empty.
|
|
||||||
- `build.kind` must be `bin`, `staticlib`, or `sharedlib`.
|
|
||||||
- Dependency fields `include/lib/libs` must be string arrays when provided.
|
|
||||||
- `build.exclude`/`build.include` must be string arrays when provided.
|
|
||||||
- `build.roots` must be a string array when provided.
|
|
||||||
- `build.src_disable` must be boolean when provided.
|
|
||||||
- `build.clean`/`build.generated`/`build.pkg_config`/`build.expect` must be string arrays when provided.
|
|
||||||
- `build.debug`/`build.release` must be tables; their `cflags`/`ldflags` must be string arrays.
|
|
||||||
- `build.steps`/`build.post_steps` entries must include `name`, `in`, `out`, `cmd`.
|
|
||||||
- `build.language` may be a string or array (for example `["c", "c++", "asm"]`).
|
|
||||||
- `[build.<profile>]` tables inherit all base values and override any fields they specify.
|
|
||||||
Array fields (like `cflags`/`ldflags`) are appended to the base array.
|
|
||||||
|
|
||||||
## Generated defaults (`dcr new` / `dcr init`)
|
|
||||||
|
|
||||||
- `package.version = "0.1.0"`
|
|
||||||
- `build.language = "c"`
|
|
||||||
- `build.standard = "c11"`
|
|
||||||
- `build.compiler = "clang"`
|
|
||||||
- `build.kind = "bin"`
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
# Contributing & Bug reports
|
|
||||||
|
|
||||||
## Contribution workflow
|
|
||||||
|
|
||||||
1. Fork `dexoron/dcr` (and `dexoron/dcr-site` if docs website changes are needed).
|
|
||||||
2. Make focused changes.
|
|
||||||
3. Run checks locally:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cargo fmt --all
|
|
||||||
cargo clippy --all-targets --all-features -- -D warnings
|
|
||||||
cargo check
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Open a PR with short rationale and behavior impact.
|
|
||||||
5. Update docs when CLI behavior changes.
|
|
||||||
|
|
||||||
## Bug report checklist
|
|
||||||
|
|
||||||
Include:
|
|
||||||
|
|
||||||
1. DCR version (`dcr --version`).
|
|
||||||
2. OS and compiler/toolchain version.
|
|
||||||
3. Reproduction steps.
|
|
||||||
4. Expected result.
|
|
||||||
5. Actual result and full error output.
|
|
||||||
6. Minimal reproducible project.
|
|
||||||
|
|
||||||
## Where to report
|
|
||||||
|
|
||||||
Use GitHub Issues in the relevant repository:
|
|
||||||
|
|
||||||
- <https://github.com/dexoron/dcr>
|
|
||||||
- <https://github.com/dexoron/dcr-site>
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# FAQ
|
|
||||||
|
|
||||||
## What commands are available?
|
|
||||||
|
|
||||||
`new`, `init`, `build`, `run`, `clean`, `gen`, `--help`, `--version`, `--update`.
|
|
||||||
|
|
||||||
## Is `dcr.toml` mandatory?
|
|
||||||
|
|
||||||
Yes, for `build`, `run`, and `clean`.
|
|
||||||
|
|
||||||
## What source files are compiled?
|
|
||||||
|
|
||||||
DCR scans `src/` recursively:
|
|
||||||
|
|
||||||
- for C: `*.c`
|
|
||||||
- for C++: `*.cpp`, `*.cxx`, `*.cc`
|
|
||||||
|
|
||||||
## Can I switch compiler?
|
|
||||||
|
|
||||||
Yes. Set `build.compiler` in `dcr.toml` (for example `gcc`, `clang`, `cl`, `clang-cl`).
|
|
||||||
|
|
||||||
## How does incremental rebuild work?
|
|
||||||
|
|
||||||
It compares source file mtime with object file mtime.
|
|
||||||
Header dependencies are tracked too: if an included header changes (or disappears), rebuild is triggered.
|
|
||||||
|
|
||||||
## What does `dcr run` do if build fails?
|
|
||||||
|
|
||||||
It tries to run an existing binary from the selected profile; if none exists, it reports an error.
|
|
||||||
|
|
||||||
## How do I update DCR?
|
|
||||||
|
|
||||||
Use `dcr --update` for non-package-managed installs.
|
|
||||||
|
|
||||||
If installed through pacman/AUR, update via package manager.
|
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
# Flags & environment
|
|
||||||
|
|
||||||
This page summarizes runtime flags and environment variables that affect DCR behavior.
|
|
||||||
|
|
||||||
## Build/run flags
|
|
||||||
|
|
||||||
Used with `dcr build` and `dcr run`:
|
|
||||||
|
|
||||||
- `--debug`: select debug profile.
|
|
||||||
- `--release`: select release profile.
|
|
||||||
- `--force`: ignore incremental cache checks and rebuild.
|
|
||||||
- `--clean`: remove `target/<profile>` and `build.clean` paths before build.
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
|
|
||||||
- Flags can be passed in any order.
|
|
||||||
- Duplicate profile flags are rejected.
|
|
||||||
|
|
||||||
## Clean flags
|
|
||||||
|
|
||||||
Used with `dcr clean`:
|
|
||||||
|
|
||||||
- `--debug` / `--release`: clean only selected profile directory.
|
|
||||||
- `--all`: in workspace root, also clean all members.
|
|
||||||
|
|
||||||
## Environment variables
|
|
||||||
|
|
||||||
Tool selection overrides:
|
|
||||||
|
|
||||||
- `DCR_COMPILER` (all languages)
|
|
||||||
- `DCR_CC`, `DCR_CXX`, `DCR_AS`, `DCR_AR`, `DCR_LD`
|
|
||||||
|
|
||||||
Diagnostics:
|
|
||||||
|
|
||||||
- `DCR_DEBUG=1` enables verbose build logging.
|
|
||||||
|
|
||||||
## Quick examples
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# Force full release rebuild
|
|
||||||
dcr build --release --force
|
|
||||||
|
|
||||||
# Clean before debug run
|
|
||||||
dcr run --clean --debug
|
|
||||||
|
|
||||||
# Use custom compiler from env
|
|
||||||
DCR_CC=clang-18 dcr build --debug
|
|
||||||
```
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
# Troubleshooting map
|
|
||||||
|
|
||||||
Fast mapping from symptom to likely cause and first action.
|
|
||||||
|
|
||||||
## `dcr.toml file not found`
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
- you are outside project root (or member root).
|
|
||||||
|
|
||||||
First action:
|
|
||||||
```sh
|
|
||||||
pwd
|
|
||||||
ls
|
|
||||||
```
|
|
||||||
Run DCR from directory that contains `dcr.toml`.
|
|
||||||
|
|
||||||
## `Invalid config: missing [package]` / `missing [build]`
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
- incomplete config in root project.
|
|
||||||
|
|
||||||
First action:
|
|
||||||
- ensure root `dcr.toml` includes `[package]`, `[build]`, and `[dependencies]`.
|
|
||||||
- for workspace setups, keep these sections in root and add `[workspace]` additionally.
|
|
||||||
|
|
||||||
## `Unknown build flag` or profile-flag errors
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
- typo in flag or duplicate profile flag.
|
|
||||||
|
|
||||||
First action:
|
|
||||||
```sh
|
|
||||||
dcr --help
|
|
||||||
```
|
|
||||||
Use only supported flags and at most one of `--debug` / `--release`.
|
|
||||||
|
|
||||||
## Dependency include/lib path errors
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
- path in `[dependencies]` does not exist.
|
|
||||||
|
|
||||||
First action:
|
|
||||||
- verify `path`, `include`, `lib` values.
|
|
||||||
- if using profile placeholders, confirm expanded paths exist for selected profile.
|
|
||||||
|
|
||||||
## `Cannot run library build`
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
- `build.kind` is `staticlib` or `sharedlib`.
|
|
||||||
|
|
||||||
First action:
|
|
||||||
- switch `build.kind` to `bin`, or set `[run].cmd` if you intentionally need custom run command.
|
|
||||||
|
|
||||||
## Build succeeds but output is stale
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
- stale artifacts or generated files from previous runs.
|
|
||||||
|
|
||||||
First action:
|
|
||||||
```sh
|
|
||||||
dcr clean --all
|
|
||||||
dcr build --force
|
|
||||||
```
|
|
||||||
|
|
||||||
## `dcr --update` suggests package manager update
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
- DCR binary is managed by pacman/AUR.
|
|
||||||
|
|
||||||
First action:
|
|
||||||
```sh
|
|
||||||
yay -Syu dcr
|
|
||||||
# or
|
|
||||||
paru -Syu dcr
|
|
||||||
```
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
# Workspace guide
|
|
||||||
|
|
||||||
`[workspace]` lets you build related DCR projects in dependency order from one root.
|
|
||||||
|
|
||||||
## Important rule
|
|
||||||
|
|
||||||
Workspace root still needs a valid root project config:
|
|
||||||
|
|
||||||
- `[package]`
|
|
||||||
- `[build]`
|
|
||||||
- `[dependencies]`
|
|
||||||
|
|
||||||
`[workspace]` augments that root config; it does not replace required root sections.
|
|
||||||
|
|
||||||
## Minimal example
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[package]
|
|
||||||
name = "root-app"
|
|
||||||
version = "0.1.0"
|
|
||||||
|
|
||||||
[build]
|
|
||||||
language = "c"
|
|
||||||
standard = "c11"
|
|
||||||
compiler = "clang"
|
|
||||||
kind = "bin"
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
|
|
||||||
[workspace]
|
|
||||||
core = { path = "./modules/core", deps = [] }
|
|
||||||
net = { path = "./modules/net", deps = ["core"] }
|
|
||||||
app = { path = "./modules/app", deps = ["core", "net"] }
|
|
||||||
```
|
|
||||||
|
|
||||||
Each member path must point to a directory containing its own `dcr.toml`.
|
|
||||||
|
|
||||||
## Build behavior
|
|
||||||
|
|
||||||
- Running `dcr build` in workspace root builds members in topological dependency order, then builds the root project.
|
|
||||||
|
|
||||||
- Running `dcr clean --all` in workspace root cleans all members too.
|
|
||||||
|
|
||||||
- `dcr gen` in workspace root includes root + members in generated outputs.
|
|
||||||
|
|
||||||
## Common errors
|
|
||||||
|
|
||||||
- `workspace.<name>.path does not contain dcr.toml`:
|
|
||||||
member path is wrong or config is missing.
|
|
||||||
- `workspace dependency '<name>' not found`:
|
|
||||||
`deps` references unknown member.
|
|
||||||
- `workspace dependency cycle at <name>`:
|
|
||||||
cyclic dependencies in member graph.
|
|
||||||
81
docs/reference/build-profiles.mdx
Normal file
81
docs/reference/build-profiles.mdx
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
---
|
||||||
|
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/reference/build-system.mdx
Normal file
131
docs/reference/build-system.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 |
|
||||||
70
docs/reference/cross-compilation.mdx
Normal file
70
docs/reference/cross-compilation.mdx
Normal file
@@ -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>/
|
||||||
|
```
|
||||||
150
docs/reference/dcr-toml.mdx
Normal file
150
docs/reference/dcr-toml.mdx
Normal file
@@ -0,0 +1,150 @@
|
|||||||
|
---
|
||||||
|
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` | yes | `app`, `lib`, `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"` |
|
||||||
|
| `standard` | `"c11"` | C standard (`c11`, `c17`, `c23`) |
|
||||||
|
| `cxx_standard` | `"c++20"` | C++ standard (`c++17`, `c++20`, `c++23`) |
|
||||||
|
| `compiler` | `"clang"` | Preferred compiler |
|
||||||
|
| `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 |
|
||||||
|
| `freestanding` | `false` | Compile in freestanding mode (`-ffreestanding` + `-nostdlib -static`) |
|
||||||
|
| `opt_level` | `"0"` (debug) / `"3"` (release) | Optimization level: `0`-`3`, `"s"`, `"z"` |
|
||||||
|
| `debug` | `true` (debug) / `false` (release) | Emit debug symbols (`-g`) |
|
||||||
|
| `lto` | `false` | Link-time optimization (`-flto` for both compiler and linker) |
|
||||||
|
| `strip` | `false` | Strip symbols from output (`-s` in ldflags) |
|
||||||
|
| `warnings` | `["all", "extra"]` (debug) / `[]` (release) | Warning flags (e.g. `"all"`, `"extra"`, `"pedantic"`) |
|
||||||
|
| `panic` | `""` | Panic strategy: `"abort"` disables exceptions and unwind tables |
|
||||||
|
| `codegen-units` | `""` | Max parallel compilation jobs (`"0"` = auto) |
|
||||||
|
| `qt` | `false` | Enable automatic Qt meta-object handling (MOC, UIC, RCC) |
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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).
|
||||||
84
docs/reference/dependencies.mdx
Normal file
84
docs/reference/dependencies.mdx
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
---
|
||||||
|
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]]
|
||||||
|
name = "default"
|
||||||
|
url = "https://index.dcr.pm"
|
||||||
|
```
|
||||||
|
|
||||||
|
Registry priority: order in `config.toml`. The `DCR_INDEX_PATH` variable overrides the path to `index.json`.
|
||||||
|
|
||||||
|
## Git dependencies
|
||||||
|
|
||||||
|
DCR clones git repositories via `git2`:
|
||||||
|
|
||||||
|
- `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)
|
||||||
|
|
||||||
|
Cache path: `~/.dcr/git/<hash>/`.
|
||||||
|
|
||||||
|
## 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
|
||||||
59
docs/reference/environment-variables.mdx
Normal file
59
docs/reference/environment-variables.mdx
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
---
|
||||||
|
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`.
|
||||||
51
docs/reference/platform-support.mdx
Normal file
51
docs/reference/platform-support.mdx
Normal file
@@ -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.
|
||||||
67
docs/reference/workspaces.mdx
Normal file
67
docs/reference/workspaces.mdx
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
---
|
||||||
|
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
|
||||||
|
```
|
||||||
46
docs/self-update.mdx
Normal file
46
docs/self-update.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/testing/running-tests.mdx
Normal file
45
docs/testing/running-tests.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"`
|
||||||
68
docs/testing/test-framework.mdx
Normal file
68
docs/testing/test-framework.mdx
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
---
|
||||||
|
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).
|
||||||
135
flake.lock
generated
Normal file
135
flake.lock
generated
Normal file
@@ -0,0 +1,135 @@
|
|||||||
|
{
|
||||||
|
"nodes": {
|
||||||
|
"fenix": {
|
||||||
|
"inputs": {
|
||||||
|
"nixpkgs": [
|
||||||
|
"nixpkgs"
|
||||||
|
],
|
||||||
|
"rust-analyzer-src": "rust-analyzer-src"
|
||||||
|
},
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1780218205,
|
||||||
|
"narHash": "sha256-c4MSlBQw5MIDRkad9UNUUnBaOHAHnhuCXrDt90FDVrg=",
|
||||||
|
"owner": "nix-community",
|
||||||
|
"repo": "fenix",
|
||||||
|
"rev": "96e0fc9f1a9b37f6477fa11c3fd48575354773ed",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nix-community",
|
||||||
|
"repo": "fenix",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"flake-utils": {
|
||||||
|
"inputs": {
|
||||||
|
"systems": "systems"
|
||||||
|
},
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1731533236,
|
||||||
|
"narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"nixpkgs": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1779560665,
|
||||||
|
"narHash": "sha256-tpyBcxPpcQb8ukyNF7DoCwfSY3VPsxHoYwj00Cayv5o=",
|
||||||
|
"owner": "NixOS",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "64c08a7ca051951c8eae34e3e3cb1e202fe36786",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "NixOS",
|
||||||
|
"ref": "nixos-unstable",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"nixpkgs_2": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1770107345,
|
||||||
|
"narHash": "sha256-tbS0Ebx2PiA1FRW8mt8oejR0qMXmziJmPaU1d4kYY9g=",
|
||||||
|
"owner": "nixos",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "4533d9293756b63904b7238acb84ac8fe4c8c2c4",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nixos",
|
||||||
|
"ref": "nixpkgs-unstable",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": {
|
||||||
|
"inputs": {
|
||||||
|
"fenix": "fenix",
|
||||||
|
"flake-utils": "flake-utils",
|
||||||
|
"nixpkgs": "nixpkgs",
|
||||||
|
"treefmt-nix": "treefmt-nix"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rust-analyzer-src": {
|
||||||
|
"flake": false,
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1780179631,
|
||||||
|
"narHash": "sha256-61A3gj4V1DyPP6lVHTdui4+dvG66pkMZSMd1Kke3Rz8=",
|
||||||
|
"owner": "rust-lang",
|
||||||
|
"repo": "rust-analyzer",
|
||||||
|
"rev": "cce33f2f1565958787bb763ae751a6a5f56b95e3",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "rust-lang",
|
||||||
|
"ref": "nightly",
|
||||||
|
"repo": "rust-analyzer",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"systems": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1681028828,
|
||||||
|
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"treefmt-nix": {
|
||||||
|
"inputs": {
|
||||||
|
"nixpkgs": "nixpkgs_2"
|
||||||
|
},
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1780220602,
|
||||||
|
"narHash": "sha256-eynAfOmbmxJnkp7YewvCEbShNnnYJ9gLLqkzsYtBPeM=",
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "treefmt-nix",
|
||||||
|
"rev": "db947814a175b7ca6ded66e21383d938df01c227",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "treefmt-nix",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": "root",
|
||||||
|
"version": 7
|
||||||
|
}
|
||||||
115
flake.nix
Normal file
115
flake.nix
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
{
|
||||||
|
description = "DCR — Cargo-like utility for managing C/C++ projects";
|
||||||
|
|
||||||
|
inputs = {
|
||||||
|
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||||
|
|
||||||
|
flake-utils.url = "github:numtide/flake-utils";
|
||||||
|
|
||||||
|
treefmt-nix.url = "github:numtide/treefmt-nix";
|
||||||
|
|
||||||
|
fenix = {
|
||||||
|
url = "github:nix-community/fenix";
|
||||||
|
inputs.nixpkgs.follows = "nixpkgs";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
outputs = {
|
||||||
|
self,
|
||||||
|
nixpkgs,
|
||||||
|
flake-utils,
|
||||||
|
treefmt-nix,
|
||||||
|
fenix,
|
||||||
|
}:
|
||||||
|
flake-utils.lib.eachDefaultSystem (system: let
|
||||||
|
pkgs = import nixpkgs {
|
||||||
|
inherit system;
|
||||||
|
};
|
||||||
|
|
||||||
|
cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml);
|
||||||
|
packageName = cargoToml.package.name;
|
||||||
|
packageVersion = cargoToml.package.version;
|
||||||
|
|
||||||
|
rustToolchain = fenix.packages.${system}.stable.toolchain;
|
||||||
|
|
||||||
|
rustPlatform = pkgs.makeRustPlatform {
|
||||||
|
cargo = rustToolchain;
|
||||||
|
rustc = rustToolchain;
|
||||||
|
};
|
||||||
|
|
||||||
|
treefmtEval = treefmt-nix.lib.evalModule pkgs {
|
||||||
|
projectRootFile = "flake.nix";
|
||||||
|
|
||||||
|
programs.alejandra.enable = true;
|
||||||
|
programs.rustfmt.enable = true;
|
||||||
|
programs.taplo.enable = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
app = rustPlatform.buildRustPackage {
|
||||||
|
pname = packageName;
|
||||||
|
version = packageVersion;
|
||||||
|
|
||||||
|
src = ./.;
|
||||||
|
|
||||||
|
cargoLock.lockFile = ./Cargo.lock;
|
||||||
|
|
||||||
|
nativeBuildInputs = [
|
||||||
|
pkgs.pkg-config
|
||||||
|
pkgs.cmake
|
||||||
|
pkgs.perl
|
||||||
|
];
|
||||||
|
|
||||||
|
buildInputs = pkgs.lib.optionals pkgs.stdenv.isDarwin [
|
||||||
|
pkgs.darwin.apple_sdk.frameworks.Security
|
||||||
|
pkgs.darwin.apple_sdk.frameworks.SystemConfiguration
|
||||||
|
];
|
||||||
|
|
||||||
|
postInstall = ''
|
||||||
|
install -Dm644 man/man1/*.1 -t $out/share/man/man1/
|
||||||
|
'';
|
||||||
|
|
||||||
|
# Tests require external services; run separately.
|
||||||
|
doCheck = false;
|
||||||
|
};
|
||||||
|
in {
|
||||||
|
packages = {
|
||||||
|
default = app;
|
||||||
|
dcr = app;
|
||||||
|
};
|
||||||
|
|
||||||
|
apps = let
|
||||||
|
defaultApp =
|
||||||
|
(flake-utils.lib.mkApp {
|
||||||
|
drv = app;
|
||||||
|
})
|
||||||
|
// {
|
||||||
|
meta.description = "Run ${packageName}";
|
||||||
|
};
|
||||||
|
in {
|
||||||
|
default = defaultApp;
|
||||||
|
dcr = defaultApp;
|
||||||
|
};
|
||||||
|
|
||||||
|
checks = {
|
||||||
|
dcr = app;
|
||||||
|
formatting = treefmtEval.config.build.check self;
|
||||||
|
};
|
||||||
|
|
||||||
|
formatter = treefmtEval.config.build.wrapper;
|
||||||
|
|
||||||
|
devShells.default = pkgs.mkShell {
|
||||||
|
inputsFrom = [app];
|
||||||
|
|
||||||
|
packages = [
|
||||||
|
rustToolchain
|
||||||
|
pkgs.rust-analyzer
|
||||||
|
|
||||||
|
treefmtEval.config.build.wrapper
|
||||||
|
];
|
||||||
|
|
||||||
|
shellHook = ''
|
||||||
|
export RUST_SRC_PATH="${rustToolchain}/lib/rustlib/src/rust/library"
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
});
|
||||||
|
}
|
||||||
95
install.ps1
95
install.ps1
@@ -1,15 +1,16 @@
|
|||||||
$ErrorActionPreference = 'Stop'
|
$ErrorActionPreference = 'Stop'
|
||||||
|
|
||||||
$RepoUrl = 'https://github.com/dexoron/dcr'
|
$RepoUrl = 'https://github.com/dexoron/dcr'
|
||||||
$ApiUrl = 'https://api.github.com/repos/dexoron/dcr/releases/latest'
|
$ApiLatest = 'https://api.github.com/repos/dexoron/dcr/releases/latest'
|
||||||
|
$ApiAll = 'https://api.github.com/repos/dexoron/dcr/releases'
|
||||||
$InstallPath = Join-Path $env:LOCALAPPDATA 'dcr'
|
$InstallPath = Join-Path $env:LOCALAPPDATA 'dcr'
|
||||||
$BinPath = Join-Path $env:USERPROFILE '.local\bin'
|
$BinPath = Join-Path $env:USERPROFILE '.local\bin'
|
||||||
$BinaryPath = Join-Path $InstallPath 'dcr.exe'
|
$BinaryPath = Join-Path $InstallPath 'dcr.exe'
|
||||||
|
|
||||||
function Info($msg) { Write-Host "[INFO] $msg" -ForegroundColor Cyan }
|
function Info($msg) { Write-Host "[INFO] $msg" -ForegroundColor Cyan }
|
||||||
function Ok($msg) { Write-Host "[OK] $msg" -ForegroundColor Green }
|
function Ok($msg) { Write-Host "[OK] $msg" -ForegroundColor Green }
|
||||||
function Warn($msg) { Write-Host "[WARN] $msg" -ForegroundColor Yellow }
|
function Warn($msg) { Write-Host "[WARN] $msg" -ForegroundColor Yellow }
|
||||||
function Fail($msg) { Write-Host "[ERROR] $msg" -ForegroundColor Red; exit 1 }
|
function Fail($msg) { Write-Host "[ERROR] $msg" -ForegroundColor Red; exit 1 }
|
||||||
|
|
||||||
function Require-Cmd($name) {
|
function Require-Cmd($name) {
|
||||||
if (-not (Get-Command $name -ErrorAction SilentlyContinue)) {
|
if (-not (Get-Command $name -ErrorAction SilentlyContinue)) {
|
||||||
@@ -17,6 +18,20 @@ function Require-Cmd($name) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function Select-Channel {
|
||||||
|
Write-Host "Choose channel:"
|
||||||
|
Write-Host " 1) Latest stable release (default)"
|
||||||
|
Write-Host " 2) Latest dev (pre-release)"
|
||||||
|
$choice = Read-Host "Enter 1 or 2 [1]"
|
||||||
|
if ([string]::IsNullOrWhiteSpace($choice)) { $choice = '1' }
|
||||||
|
|
||||||
|
switch ($choice) {
|
||||||
|
'1' { return 'stable' }
|
||||||
|
'2' { return 'dev' }
|
||||||
|
default { Fail 'Unknown option' }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function Select-Mode {
|
function Select-Mode {
|
||||||
Write-Host "Choose installation mode:"
|
Write-Host "Choose installation mode:"
|
||||||
Write-Host " 1) Download prebuilt binary from GitHub Release (recommended)"
|
Write-Host " 1) Download prebuilt binary from GitHub Release (recommended)"
|
||||||
@@ -26,30 +41,53 @@ function Select-Mode {
|
|||||||
|
|
||||||
switch ($choice) {
|
switch ($choice) {
|
||||||
'1' { return 'release' }
|
'1' { return 'release' }
|
||||||
'2' { return 'build' }
|
'2' { return 'build' }
|
||||||
default { Fail 'Unknown option' }
|
default { Fail 'Unknown option' }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function Get-Target {
|
function Get-Target {
|
||||||
if ($env:PROCESSOR_ARCHITECTURE -ne 'AMD64') {
|
$arch = $env:PROCESSOR_ARCHITECTURE
|
||||||
Fail "Only x86_64 Windows is supported, current architecture: $env:PROCESSOR_ARCHITECTURE"
|
if ($env:PROCESSOR_ARCHITEW6432) {
|
||||||
|
$arch = $env:PROCESSOR_ARCHITEW6432
|
||||||
|
}
|
||||||
|
switch ($arch) {
|
||||||
|
'AMD64' { return 'x86_64-pc-windows-msvc' }
|
||||||
|
'ARM64' { return 'aarch64-pc-windows-msvc' }
|
||||||
|
'x86' { return 'i686-pc-windows-msvc' }
|
||||||
|
default { Fail "Unsupported Windows architecture: $arch" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Fetch-ReleaseJson($channel) {
|
||||||
|
if ($channel -eq 'dev') {
|
||||||
|
Info "Looking for latest dev (pre-release)..."
|
||||||
|
$releases = Invoke-RestMethod -Method Get -Uri $ApiAll
|
||||||
|
$pre = $releases | Where-Object { $_.prerelease -eq $true } | Select-Object -First 1
|
||||||
|
if (-not $pre) { Fail "No dev (pre-release) found on GitHub" }
|
||||||
|
return $pre
|
||||||
|
} else {
|
||||||
|
return Invoke-RestMethod -Method Get -Uri $ApiLatest
|
||||||
}
|
}
|
||||||
return 'x86_64-pc-windows-msvc'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function Install-FromRelease {
|
function Install-FromRelease {
|
||||||
param([string]$target)
|
param([string]$target, [string]$channel)
|
||||||
|
|
||||||
New-Item -ItemType Directory -Path $InstallPath -Force | Out-Null
|
New-Item -ItemType Directory -Path $InstallPath -Force | Out-Null
|
||||||
|
|
||||||
$assetName = "dcr-$target.exe"
|
$release = Fetch-ReleaseJson $channel
|
||||||
Info "Fetching latest release..."
|
$tag = $release.tag_name
|
||||||
$release = Invoke-RestMethod -Method Get -Uri $ApiUrl
|
$version = $tag.TrimStart('v')
|
||||||
|
|
||||||
|
# Имя бинарника: dcr-<triple>-<version>.exe
|
||||||
|
$assetName = "dcr-$target-$version.exe"
|
||||||
|
|
||||||
|
Info "Fetching release $tag (channel: $channel)..."
|
||||||
|
|
||||||
$asset = $release.assets | Where-Object { $_.name -eq $assetName } | Select-Object -First 1
|
$asset = $release.assets | Where-Object { $_.name -eq $assetName } | Select-Object -First 1
|
||||||
if (-not $asset) {
|
if (-not $asset) {
|
||||||
Fail "Asset $assetName not found in release $($release.tag_name)"
|
Fail "Asset $assetName not found in release $tag"
|
||||||
}
|
}
|
||||||
|
|
||||||
Info "Downloading $assetName..."
|
Info "Downloading $assetName..."
|
||||||
@@ -58,7 +96,7 @@ function Install-FromRelease {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function Install-FromSource {
|
function Install-FromSource {
|
||||||
param([string]$target)
|
param([string]$target, [string]$channel)
|
||||||
|
|
||||||
Require-Cmd 'git'
|
Require-Cmd 'git'
|
||||||
Require-Cmd 'cargo'
|
Require-Cmd 'cargo'
|
||||||
@@ -67,7 +105,15 @@ function Install-FromSource {
|
|||||||
if (Test-Path $tmp) { Remove-Item -Recurse -Force $tmp }
|
if (Test-Path $tmp) { Remove-Item -Recurse -Force $tmp }
|
||||||
|
|
||||||
Info 'Cloning repository...'
|
Info 'Cloning repository...'
|
||||||
git clone --depth 1 $RepoUrl $tmp | Out-Null
|
if ($channel -eq 'dev') {
|
||||||
|
# Пробуем ветку dev
|
||||||
|
$result = git clone --depth 1 --branch dev $RepoUrl $tmp 2>&1
|
||||||
|
if ($LASTEXITCODE -ne 0) {
|
||||||
|
git clone --depth 1 $RepoUrl $tmp | Out-Null
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
git clone --depth 1 $RepoUrl $tmp | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
Info 'Building release binary...'
|
Info 'Building release binary...'
|
||||||
Push-Location $tmp
|
Push-Location $tmp
|
||||||
@@ -100,14 +146,15 @@ function Setup-Path {
|
|||||||
}
|
}
|
||||||
|
|
||||||
Info 'Starting DCR installation'
|
Info 'Starting DCR installation'
|
||||||
$mode = Select-Mode
|
$channel = Select-Channel
|
||||||
$target = Get-Target
|
$mode = Select-Mode
|
||||||
|
$target = Get-Target
|
||||||
|
|
||||||
if ($mode -eq 'build') {
|
if ($mode -eq 'build') {
|
||||||
Install-FromSource -target $target
|
Install-FromSource -target $target -channel $channel
|
||||||
} else {
|
} else {
|
||||||
Install-FromRelease -target $target
|
Install-FromRelease -target $target -channel $channel
|
||||||
}
|
}
|
||||||
|
|
||||||
Setup-Path
|
Setup-Path
|
||||||
Ok 'Installation completed successfully'
|
Ok 'Installation completed successfully'
|
||||||
195
install.sh
195
install.sh
@@ -4,9 +4,11 @@ set -Eeuo pipefail
|
|||||||
TMPDIR="/tmp/dcr-install"
|
TMPDIR="/tmp/dcr-install"
|
||||||
INSTALL_PATH="$HOME/.local/share/dcr"
|
INSTALL_PATH="$HOME/.local/share/dcr"
|
||||||
BINPATH="$HOME/.local/bin"
|
BINPATH="$HOME/.local/bin"
|
||||||
|
MANPATH="${XDG_DATA_HOME:-$HOME/.local/share}/man"
|
||||||
LOGFILE="$HOME/.cache/dcr-install.log"
|
LOGFILE="$HOME/.cache/dcr-install.log"
|
||||||
REPO_URL="https://github.com/dexoron/dcr"
|
REPO_URL="https://github.com/dexoron/dcr"
|
||||||
GITHUB_API="https://api.github.com/repos/dexoron/dcr/releases/latest"
|
GITHUB_API_LATEST="https://api.github.com/repos/dexoron/dcr/releases/latest"
|
||||||
|
GITHUB_API_ALL="https://api.github.com/repos/dexoron/dcr/releases"
|
||||||
|
|
||||||
RED='\033[0;31m'
|
RED='\033[0;31m'
|
||||||
GREEN='\033[0;32m'
|
GREEN='\033[0;32m'
|
||||||
@@ -17,17 +19,20 @@ NC='\033[0m'
|
|||||||
mkdir -p "$(dirname "$LOGFILE")"
|
mkdir -p "$(dirname "$LOGFILE")"
|
||||||
exec > >(tee -a "$LOGFILE") 2>&1
|
exec > >(tee -a "$LOGFILE") 2>&1
|
||||||
|
|
||||||
log() { echo -e "${BLUE}[$(date '+%Y-%m-%d %H:%M:%S')]${NC} $1"; }
|
log() { echo -e "${BLUE}[$(date '+%Y-%m-%d %H:%M:%S')]${NC} $1"; }
|
||||||
success() { echo -e "${GREEN}✔ $1${NC}"; }
|
success() { echo -e "${GREEN}✔ $1${NC}"; }
|
||||||
warn() { echo -e "${YELLOW}⚠ $1${NC}"; }
|
warn() { echo -e "${YELLOW}⚠ $1${NC}"; }
|
||||||
error() { echo -e "${RED}✖ $1${NC}"; }
|
error() { echo -e "${RED}✖ $1${NC}"; }
|
||||||
|
|
||||||
trap 'error "Error on line $LINENO"; exit 1' ERR
|
trap 'error "Error on line $LINENO"; exit 1' ERR
|
||||||
|
|
||||||
|
INSTALL_MODE=""
|
||||||
|
CHANNEL=""
|
||||||
|
|
||||||
check_os() {
|
check_os() {
|
||||||
case "$(uname -s)" in
|
case "$(uname -s)" in
|
||||||
Linux|Darwin) ;;
|
Linux|Darwin|FreeBSD|OpenBSD|NetBSD) ;;
|
||||||
*) error "Only Linux and macOS are supported"; exit 1 ;;
|
*) error "Only Linux, macOS, and BSD systems are supported"; exit 1 ;;
|
||||||
esac
|
esac
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -37,28 +42,141 @@ detect_target() {
|
|||||||
arch="$(uname -m)"
|
arch="$(uname -m)"
|
||||||
|
|
||||||
case "$os:$arch" in
|
case "$os:$arch" in
|
||||||
Linux:x86_64) TARGET_TRIPLE="x86_64-unknown-linux-gnu" ;;
|
Linux:x86_64) TARGET_TRIPLE="x86_64-unknown-linux-gnu" ;;
|
||||||
Darwin:x86_64) TARGET_TRIPLE="x86_64-apple-darwin" ;;
|
Linux:aarch64|Linux:arm64) TARGET_TRIPLE="aarch64-unknown-linux-gnu" ;;
|
||||||
Darwin:arm64|Darwin:aarch64) TARGET_TRIPLE="aarch64-apple-darwin" ;;
|
Linux:i686|Linux:i386) TARGET_TRIPLE="i686-unknown-linux-gnu" ;;
|
||||||
|
Linux:armv7l|Linux:armv7) TARGET_TRIPLE="armv7-unknown-linux-gnueabihf" ;;
|
||||||
|
Linux:riscv64) TARGET_TRIPLE="riscv64gc-unknown-linux-gnu" ;;
|
||||||
|
Darwin:x86_64) TARGET_TRIPLE="x86_64-apple-darwin" ;;
|
||||||
|
Darwin:arm64|Darwin:aarch64) TARGET_TRIPLE="aarch64-apple-darwin" ;;
|
||||||
|
FreeBSD:x86_64|FreeBSD:amd64) TARGET_TRIPLE="x86_64-unknown-freebsd" ;;
|
||||||
|
FreeBSD:aarch64|FreeBSD:arm64) TARGET_TRIPLE="aarch64-unknown-freebsd" ;;
|
||||||
|
FreeBSD:i686|FreeBSD:i386) TARGET_TRIPLE="i686-unknown-freebsd" ;;
|
||||||
|
OpenBSD:x86_64|OpenBSD:amd64) TARGET_TRIPLE="x86_64-unknown-openbsd" ;;
|
||||||
|
OpenBSD:aarch64|OpenBSD:arm64) TARGET_TRIPLE="aarch64-unknown-openbsd" ;;
|
||||||
|
OpenBSD:i686|OpenBSD:i386) TARGET_TRIPLE="i686-unknown-openbsd" ;;
|
||||||
|
NetBSD:x86_64|NetBSD:amd64) TARGET_TRIPLE="x86_64-unknown-netbsd" ;;
|
||||||
|
NetBSD:aarch64|NetBSD:arm64) TARGET_TRIPLE="aarch64-unknown-netbsd" ;;
|
||||||
|
NetBSD:i686|NetBSD:i386) TARGET_TRIPLE="i686-unknown-netbsd" ;;
|
||||||
|
|
||||||
*) error "Unsupported platform: $os/$arch"; exit 1 ;;
|
*) error "Unsupported platform: $os/$arch"; exit 1 ;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
ASSET_NAME="dcr-${TARGET_TRIPLE}"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
check_common_dependencies() {
|
check_common_dependencies() {
|
||||||
command -v curl >/dev/null 2>&1 || { error "curl is not installed"; exit 1; }
|
command -v curl >/dev/null 2>&1 || { error "curl is not installed"; exit 1; }
|
||||||
|
if [[ "$CHANNEL" == "dev" ]]; then
|
||||||
|
if ! command -v python3 >/dev/null 2>&1 && ! command -v jq >/dev/null 2>&1; then
|
||||||
|
error "For dev installations, either 'python3' or 'jq' must be installed to parse GitHub API response."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
check_build_dependencies() {
|
check_build_dependencies() {
|
||||||
command -v git >/dev/null 2>&1 || { error "git is not installed"; exit 1; }
|
command -v git >/dev/null 2>&1 || { error "git is not installed"; exit 1; }
|
||||||
command -v cargo >/dev/null 2>&1 || { error "cargo is not installed"; exit 1; }
|
command -v cargo >/dev/null 2>&1 || { error "cargo is not installed"; exit 1; }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
select_channel() {
|
||||||
|
echo "Choose channel:"
|
||||||
|
echo " 1) Latest stable release (default)"
|
||||||
|
echo " 2) Latest dev (pre-release)"
|
||||||
|
read -r -p "Enter 1 or 2 [1]: " choice < /dev/tty
|
||||||
|
|
||||||
|
case "${choice:-1}" in
|
||||||
|
1) CHANNEL="stable" ;;
|
||||||
|
2) CHANNEL="dev" ;;
|
||||||
|
*) error "Unknown option"; exit 1 ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
select_install_mode() {
|
||||||
|
echo "Choose installation mode:"
|
||||||
|
echo " 1) Download prebuilt binary from GitHub Release (recommended)"
|
||||||
|
echo " 2) Build from git"
|
||||||
|
read -r -p "Enter 1 or 2 [1]: " choice < /dev/tty
|
||||||
|
|
||||||
|
case "${choice:-1}" in
|
||||||
|
1) INSTALL_MODE="release" ;;
|
||||||
|
2) INSTALL_MODE="build" ;;
|
||||||
|
*) error "Unknown option"; exit 1 ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
# Returns JSON of the requested release to stdout
|
||||||
|
fetch_release_json() {
|
||||||
|
if [[ "$CHANNEL" == "dev" ]]; then
|
||||||
|
log "Looking for latest dev (pre-release)..."
|
||||||
|
local json result
|
||||||
|
json="$(curl -fsSL "$GITHUB_API_ALL")"
|
||||||
|
if command -v jq >/dev/null 2>&1; then
|
||||||
|
result="$(printf '%s' "$json" | jq -e -c 'map(select(.prerelease == true))[0]')"
|
||||||
|
else
|
||||||
|
result="$(printf '%s' "$json" | python3 - <<'EOF'
|
||||||
|
import sys, json
|
||||||
|
releases = json.load(sys.stdin)
|
||||||
|
pre = [r for r in releases if r.get("prerelease", False)]
|
||||||
|
if not pre:
|
||||||
|
print("{}", end="")
|
||||||
|
else:
|
||||||
|
print(json.dumps(pre[0]), end="")
|
||||||
|
EOF
|
||||||
|
)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -z "$result" || "$result" == "{}" || "$result" == "null" ]]; then
|
||||||
|
error "No dev (pre-release) found on GitHub"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
printf '%s' "$result"
|
||||||
|
else
|
||||||
|
curl -fsSL "$GITHUB_API_LATEST"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
download_binary() {
|
||||||
|
local release_json tag version asset_name download_url
|
||||||
|
|
||||||
|
release_json="$(fetch_release_json)"
|
||||||
|
|
||||||
|
tag="$(printf '%s\n' "$release_json" | \
|
||||||
|
sed -n 's/.*"tag_name": "\([^"]*\)".*/\1/p' | head -n1)"
|
||||||
|
if [[ -z "$tag" ]]; then
|
||||||
|
error "Failed to determine release version"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Version without leading 'v'
|
||||||
|
version="${tag#v}"
|
||||||
|
# Binary name: dcr-<triple>-<version>
|
||||||
|
asset_name="dcr-${TARGET_TRIPLE}-${version}"
|
||||||
|
|
||||||
|
log "Fetching release ${tag} (channel: ${CHANNEL})..."
|
||||||
|
|
||||||
|
download_url="$(printf '%s\n' "$release_json" | \
|
||||||
|
sed -n "s#.*\"browser_download_url\": \"\([^\"]*/${asset_name}\)\".*#\1#p" | head -n1)"
|
||||||
|
|
||||||
|
if [[ -z "$download_url" ]]; then
|
||||||
|
error "Asset ${asset_name} not found in release ${tag}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p "$INSTALL_PATH"
|
||||||
|
curl -fL "$download_url" -o "$INSTALL_PATH/dcr"
|
||||||
|
chmod +x "$INSTALL_PATH/dcr"
|
||||||
|
success "Binary ${asset_name} downloaded (${tag})"
|
||||||
|
}
|
||||||
|
|
||||||
prepare_sources() {
|
prepare_sources() {
|
||||||
log "Fetching sources..."
|
log "Fetching sources..."
|
||||||
rm -rf "$TMPDIR"
|
rm -rf "$TMPDIR"
|
||||||
git clone --depth 1 "$REPO_URL" "$TMPDIR"
|
git clone --depth 1 "$REPO_URL" "$TMPDIR"
|
||||||
|
if [[ "$CHANNEL" == "dev" ]]; then
|
||||||
|
# Clone dev branch if it exists
|
||||||
|
git clone --depth 1 --branch dev "$REPO_URL" "$TMPDIR" 2>/dev/null || \
|
||||||
|
git clone --depth 1 "$REPO_URL" "$TMPDIR"
|
||||||
|
fi
|
||||||
success "Sources fetched"
|
success "Sources fetched"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -68,34 +186,6 @@ build_binary() {
|
|||||||
success "Build completed"
|
success "Build completed"
|
||||||
}
|
}
|
||||||
|
|
||||||
fetch_latest_release_json() {
|
|
||||||
curl -fsSL "$GITHUB_API"
|
|
||||||
}
|
|
||||||
|
|
||||||
download_binary() {
|
|
||||||
log "Fetching latest release..."
|
|
||||||
|
|
||||||
local release_json download_url tag
|
|
||||||
release_json="$(fetch_latest_release_json)"
|
|
||||||
|
|
||||||
tag="$(printf '%s\n' "$release_json" | sed -n 's/.*"tag_name": "\([^"]*\)".*/\1/p' | head -n1)"
|
|
||||||
if [[ -z "$tag" ]]; then
|
|
||||||
error "Failed to determine release version"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
download_url="$(printf '%s\n' "$release_json" | sed -n "s#.*\"browser_download_url\": \"\([^\"]*${ASSET_NAME}\)\".*#\1#p" | head -n1)"
|
|
||||||
if [[ -z "$download_url" ]]; then
|
|
||||||
error "Asset ${ASSET_NAME} not found in release ${tag}"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
mkdir -p "$INSTALL_PATH"
|
|
||||||
curl -fL "$download_url" -o "$INSTALL_PATH/dcr"
|
|
||||||
chmod +x "$INSTALL_PATH/dcr"
|
|
||||||
success "Binary ${ASSET_NAME} downloaded (${tag})"
|
|
||||||
}
|
|
||||||
|
|
||||||
install_built_binary() {
|
install_built_binary() {
|
||||||
mkdir -p "$INSTALL_PATH"
|
mkdir -p "$INSTALL_PATH"
|
||||||
cp "$TMPDIR/target/release/dcr" "$INSTALL_PATH/dcr"
|
cp "$TMPDIR/target/release/dcr" "$INSTALL_PATH/dcr"
|
||||||
@@ -110,6 +200,16 @@ install_link() {
|
|||||||
success "Command 'dcr' added to $BINPATH"
|
success "Command 'dcr' added to $BINPATH"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
install_man() {
|
||||||
|
log "Installing man pages..."
|
||||||
|
local man_src="$TMPDIR/man/man1"
|
||||||
|
if [[ -d "$man_src" ]]; then
|
||||||
|
mkdir -p "$MANPATH/man1"
|
||||||
|
cp "$man_src"/*.1 "$MANPATH/man1/"
|
||||||
|
success "Man pages installed to $MANPATH/man1"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
check_path() {
|
check_path() {
|
||||||
if ! echo "$PATH" | grep -q "$BINPATH"; then
|
if ! echo "$PATH" | grep -q "$BINPATH"; then
|
||||||
warn "Directory $BINPATH not found in PATH"
|
warn "Directory $BINPATH not found in PATH"
|
||||||
@@ -122,24 +222,12 @@ cleanup() {
|
|||||||
rm -rf "$TMPDIR" 2>/dev/null || true
|
rm -rf "$TMPDIR" 2>/dev/null || true
|
||||||
}
|
}
|
||||||
|
|
||||||
select_install_mode() {
|
|
||||||
echo "Choose installation mode:"
|
|
||||||
echo " 1) Download prebuilt binary from GitHub Release (recommended)"
|
|
||||||
echo " 2) Build from git"
|
|
||||||
read -r -p "Enter 1 or 2 [1]: " choice
|
|
||||||
|
|
||||||
case "${choice:-1}" in
|
|
||||||
1) INSTALL_MODE="release" ;;
|
|
||||||
2) INSTALL_MODE="build" ;;
|
|
||||||
*) error "Unknown option"; exit 1 ;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
log "Starting DCR installation"
|
log "Starting DCR installation"
|
||||||
|
|
||||||
check_os
|
check_os
|
||||||
detect_target
|
detect_target
|
||||||
|
select_channel
|
||||||
check_common_dependencies
|
check_common_dependencies
|
||||||
select_install_mode
|
select_install_mode
|
||||||
cleanup
|
cleanup
|
||||||
@@ -154,6 +242,7 @@ main() {
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
install_link
|
install_link
|
||||||
|
install_man
|
||||||
check_path
|
check_path
|
||||||
cleanup
|
cleanup
|
||||||
|
|
||||||
|
|||||||
241
install_bsd.sh
Executable file
241
install_bsd.sh
Executable file
@@ -0,0 +1,241 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
TMPDIR="/tmp/dcr-install"
|
||||||
|
INSTALL_PATH="$HOME/.local/share/dcr"
|
||||||
|
BINPATH="$HOME/.local/bin"
|
||||||
|
MANPATH="${XDG_DATA_HOME:-$HOME/.local/share}/man"
|
||||||
|
LOGFILE="$HOME/.cache/dcr-install.log"
|
||||||
|
REPO_URL="https://github.com/dexoron/dcr"
|
||||||
|
GITHUB_API_LATEST="https://api.github.com/repos/dexoron/dcr/releases/latest"
|
||||||
|
GITHUB_API_ALL="https://api.github.com/repos/dexoron/dcr/releases"
|
||||||
|
|
||||||
|
RED='\033[0;31m'
|
||||||
|
GREEN='\033[0;32m'
|
||||||
|
YELLOW='\033[1;33m'
|
||||||
|
BLUE='\033[0;34m'
|
||||||
|
NC='\033[0m'
|
||||||
|
|
||||||
|
mkdir -p "$(dirname "$LOGFILE")"
|
||||||
|
|
||||||
|
log() { printf "${BLUE}[%s]${NC} %s\n" "$(date '+%Y-%m-%d %H:%M:%S')" "$1" | tee -a "$LOGFILE"; }
|
||||||
|
success() { printf "${GREEN}✔ %s${NC}\n" "$1" | tee -a "$LOGFILE"; }
|
||||||
|
warn() { printf "${YELLOW}⚠ %s${NC}\n" "$1" | tee -a "$LOGFILE"; }
|
||||||
|
error() { printf "${RED}✖ %s${NC}\n" "$1" | tee -a "$LOGFILE" >&2; }
|
||||||
|
|
||||||
|
INSTALL_MODE=""
|
||||||
|
CHANNEL=""
|
||||||
|
|
||||||
|
check_os() {
|
||||||
|
case "$(uname -s)" in
|
||||||
|
FreeBSD|OpenBSD|NetBSD|DragonFly) ;;
|
||||||
|
*) error "Only BSD systems (FreeBSD, OpenBSD, NetBSD, DragonFly) are supported by this script"; exit 1 ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
detect_target() {
|
||||||
|
local os arch
|
||||||
|
os="$(uname -s)"
|
||||||
|
arch="$(uname -m)"
|
||||||
|
|
||||||
|
case "$os:$arch" in
|
||||||
|
FreeBSD:x86_64|FreeBSD:amd64) TARGET_TRIPLE="x86_64-unknown-freebsd" ;;
|
||||||
|
FreeBSD:aarch64|FreeBSD:arm64) TARGET_TRIPLE="aarch64-unknown-freebsd" ;;
|
||||||
|
FreeBSD:i686|FreeBSD:i386) TARGET_TRIPLE="i686-unknown-freebsd" ;;
|
||||||
|
OpenBSD:x86_64|OpenBSD:amd64) TARGET_TRIPLE="x86_64-unknown-openbsd" ;;
|
||||||
|
OpenBSD:aarch64|OpenBSD:arm64) TARGET_TRIPLE="aarch64-unknown-openbsd" ;;
|
||||||
|
OpenBSD:i686|OpenBSD:i386) TARGET_TRIPLE="i686-unknown-openbsd" ;;
|
||||||
|
NetBSD:x86_64|NetBSD:amd64) TARGET_TRIPLE="x86_64-unknown-netbsd" ;;
|
||||||
|
NetBSD:aarch64|NetBSD:arm64) TARGET_TRIPLE="aarch64-unknown-netbsd" ;;
|
||||||
|
NetBSD:i686|NetBSD:i386) TARGET_TRIPLE="i686-unknown-netbsd" ;;
|
||||||
|
DragonFly:x86_64|DragonFly:amd64) TARGET_TRIPLE="x86_64-unknown-dragonfly" ;;
|
||||||
|
*) error "Unsupported BSD platform: $os/$arch"; exit 1 ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
check_common_dependencies() {
|
||||||
|
command -v curl >/dev/null 2>&1 || { error "curl is not installed"; exit 1; }
|
||||||
|
if [ "$CHANNEL" = "dev" ]; then
|
||||||
|
if ! command -v python3 >/dev/null 2>&1 && ! command -v jq >/dev/null 2>&1; then
|
||||||
|
error "For dev installations, either 'python3' or 'jq' must be installed to parse GitHub API response."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_build_dependencies() {
|
||||||
|
command -v git >/dev/null 2>&1 || { error "git is not installed"; exit 1; }
|
||||||
|
command -v cargo >/dev/null 2>&1 || { error "cargo is not installed"; exit 1; }
|
||||||
|
}
|
||||||
|
|
||||||
|
select_channel() {
|
||||||
|
echo "Choose channel:"
|
||||||
|
echo " 1) Latest stable release (default)"
|
||||||
|
echo " 2) Latest dev (pre-release)"
|
||||||
|
printf "Enter 1 or 2 [1]: "
|
||||||
|
read -r choice
|
||||||
|
|
||||||
|
case "${choice:-1}" in
|
||||||
|
1) CHANNEL="stable" ;;
|
||||||
|
2) CHANNEL="dev" ;;
|
||||||
|
*) error "Unknown option"; exit 1 ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
select_install_mode() {
|
||||||
|
echo "Choose installation mode:"
|
||||||
|
echo " 1) Download prebuilt binary from GitHub Release (recommended)"
|
||||||
|
echo " 2) Build from git"
|
||||||
|
printf "Enter 1 or 2 [1]: "
|
||||||
|
read -r choice
|
||||||
|
|
||||||
|
case "${choice:-1}" in
|
||||||
|
1) INSTALL_MODE="release" ;;
|
||||||
|
2) INSTALL_MODE="build" ;;
|
||||||
|
*) error "Unknown option"; exit 1 ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
fetch_release_json() {
|
||||||
|
if [ "$CHANNEL" = "dev" ]; then
|
||||||
|
log "Looking for latest dev (pre-release)..."
|
||||||
|
local json result
|
||||||
|
json="$(curl -fsSL "$GITHUB_API_ALL")"
|
||||||
|
if command -v jq >/dev/null 2>&1; then
|
||||||
|
result="$(printf '%s' "$json" | jq -e -c 'map(select(.prerelease == true))[0]')"
|
||||||
|
else
|
||||||
|
result="$(printf '%s' "$json" | python3 - <<'EOF'
|
||||||
|
import sys, json
|
||||||
|
releases = json.load(sys.stdin)
|
||||||
|
pre = [r for r in releases if r.get("prerelease", False)]
|
||||||
|
if not pre:
|
||||||
|
print("{}", end="")
|
||||||
|
else:
|
||||||
|
print(json.dumps(pre[0]), end="")
|
||||||
|
EOF
|
||||||
|
)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$result" ] || [ "$result" = "{}" ] || [ "$result" = "null" ]; then
|
||||||
|
error "No dev (pre-release) found on GitHub"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
printf '%s' "$result"
|
||||||
|
else
|
||||||
|
curl -fsSL "$GITHUB_API_LATEST"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
download_binary() {
|
||||||
|
local release_json tag version asset_name download_url
|
||||||
|
|
||||||
|
release_json="$(fetch_release_json)"
|
||||||
|
|
||||||
|
tag="$(printf '%s\n' "$release_json" | \
|
||||||
|
sed -n 's/.*"tag_name": "\([^"]*\)".*/\1/p' | head -n1)"
|
||||||
|
if [ -z "$tag" ]; then
|
||||||
|
error "Failed to determine release version"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
version="${tag#v}"
|
||||||
|
asset_name="dcr-${TARGET_TRIPLE}-${version}"
|
||||||
|
|
||||||
|
log "Fetching release ${tag} (channel: ${CHANNEL})..."
|
||||||
|
|
||||||
|
download_url="$(printf '%s\n' "$release_json" | \
|
||||||
|
sed -n "s#.*\"browser_download_url\": \"\([^\"]*/${asset_name}\)\".*#\1#p" | head -n1)"
|
||||||
|
|
||||||
|
if [ -z "$download_url" ]; then
|
||||||
|
error "Asset ${asset_name} not found in release ${tag}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p "$INSTALL_PATH"
|
||||||
|
curl -fL "$download_url" -o "$INSTALL_PATH/dcr"
|
||||||
|
chmod +x "$INSTALL_PATH/dcr"
|
||||||
|
success "Binary ${asset_name} downloaded (${tag})"
|
||||||
|
}
|
||||||
|
|
||||||
|
prepare_sources() {
|
||||||
|
log "Fetching sources..."
|
||||||
|
rm -rf "$TMPDIR"
|
||||||
|
git clone --depth 1 "$REPO_URL" "$TMPDIR"
|
||||||
|
if [ "$CHANNEL" = "dev" ]; then
|
||||||
|
git clone --depth 1 --branch dev "$REPO_URL" "$TMPDIR" 2>/dev/null || \
|
||||||
|
git clone --depth 1 "$REPO_URL" "$TMPDIR"
|
||||||
|
fi
|
||||||
|
success "Sources fetched"
|
||||||
|
}
|
||||||
|
|
||||||
|
build_binary() {
|
||||||
|
log "Building release binary..."
|
||||||
|
(cd "$TMPDIR" && cargo build --release)
|
||||||
|
success "Build completed"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_built_binary() {
|
||||||
|
mkdir -p "$INSTALL_PATH"
|
||||||
|
cp "$TMPDIR/target/release/dcr" "$INSTALL_PATH/dcr"
|
||||||
|
chmod +x "$INSTALL_PATH/dcr"
|
||||||
|
success "Binary installed from source"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_link() {
|
||||||
|
log "Creating symlink..."
|
||||||
|
mkdir -p "$BINPATH"
|
||||||
|
ln -sf "$INSTALL_PATH/dcr" "$BINPATH/dcr"
|
||||||
|
success "Command 'dcr' added to $BINPATH"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_man() {
|
||||||
|
log "Installing man pages..."
|
||||||
|
man_src="$TMPDIR/man/man1"
|
||||||
|
if [ -d "$man_src" ]; then
|
||||||
|
mkdir -p "$MANPATH/man1"
|
||||||
|
cp "$man_src"/*.1 "$MANPATH/man1/"
|
||||||
|
success "Man pages installed to $MANPATH/man1"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_path() {
|
||||||
|
if ! echo "$PATH" | grep -q "$BINPATH"; then
|
||||||
|
warn "Directory $BINPATH not found in PATH"
|
||||||
|
echo "Add this to ~/.bashrc, ~/.zshrc or ~/.profile:"
|
||||||
|
echo "export PATH=\"$BINPATH:\$PATH\""
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
cleanup() {
|
||||||
|
rm -rf "$TMPDIR" 2>/dev/null || true
|
||||||
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
log "Starting DCR installation for BSD"
|
||||||
|
|
||||||
|
check_os
|
||||||
|
select_channel
|
||||||
|
check_common_dependencies
|
||||||
|
detect_target
|
||||||
|
select_install_mode
|
||||||
|
cleanup
|
||||||
|
|
||||||
|
if [ "$INSTALL_MODE" = "build" ]; then
|
||||||
|
check_build_dependencies
|
||||||
|
prepare_sources
|
||||||
|
build_binary
|
||||||
|
install_built_binary
|
||||||
|
else
|
||||||
|
download_binary
|
||||||
|
fi
|
||||||
|
|
||||||
|
install_link
|
||||||
|
install_man
|
||||||
|
check_path
|
||||||
|
cleanup
|
||||||
|
|
||||||
|
success "Installation completed successfully"
|
||||||
|
log "Log saved to $LOGFILE"
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
42
man/man1/dcr-add.1
Normal file
42
man/man1/dcr-add.1
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
.TH DCR-ADD 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-add \- Add a dependency to a DCR project
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr add \fI<name>\fR \fI<source>\fR
|
||||||
|
[\fB\-\-branch\fR \fI<b>\fR]
|
||||||
|
[\fB\-\-tag\fR \fI<t>\fR]
|
||||||
|
[\fB\-\-rev\fR \fI<r>\fR]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Adds a dependency to the project.
|
||||||
|
.SH SOURCES
|
||||||
|
.TP
|
||||||
|
.B user/repo
|
||||||
|
GitHub shorthand.
|
||||||
|
.TP
|
||||||
|
.B github:user/repo
|
||||||
|
Full GitHub repository.
|
||||||
|
.TP
|
||||||
|
.B gitlab:user/repo
|
||||||
|
GitLab repository.
|
||||||
|
.TP
|
||||||
|
.B git:host.com/user/repo
|
||||||
|
Generic git repository.
|
||||||
|
.TP
|
||||||
|
.B path:./path/to/lib
|
||||||
|
Local path dependency.
|
||||||
|
.TP
|
||||||
|
.B <version>
|
||||||
|
Version from registry.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-branch \fI<name>\fR
|
||||||
|
Use a specific branch.
|
||||||
|
.TP
|
||||||
|
.B \-\-tag \fI<name>\fR
|
||||||
|
Use a specific tag.
|
||||||
|
.TP
|
||||||
|
.B \-\-rev \fI<hash>\fR
|
||||||
|
Use a specific commit hash.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-tree (1)
|
||||||
37
man/man1/dcr-build.1
Normal file
37
man/man1/dcr-build.1
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
.TH DCR-BUILD 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-build \- Compile a DCR project
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr build
|
||||||
|
[\fB\-\-debug\fR | \fB\-\-release\fR]
|
||||||
|
[\fB\-\-target\fR \fI<triple>\fR]
|
||||||
|
[\fB\-\-force\fR]
|
||||||
|
[\fB\-\-clean\fR]
|
||||||
|
[\fB\-\-verbose\fR]
|
||||||
|
[\fB\-\-workspace\fR \fI<name>\fR]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Compiles the project. Default profile is \fB\-\-debug\fR.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
Build with debug profile (default). Enables debug symbols.
|
||||||
|
.TP
|
||||||
|
.B \-\-release
|
||||||
|
Build with release profile. Enables full optimization.
|
||||||
|
.TP
|
||||||
|
.B \-\-target \fI<triple>\fR
|
||||||
|
Cross-compile for the given target.
|
||||||
|
.TP
|
||||||
|
.B \-\-force
|
||||||
|
Force a full rebuild, ignoring cached artifacts.
|
||||||
|
.TP
|
||||||
|
.B \-\-clean
|
||||||
|
Clean before building.
|
||||||
|
.TP
|
||||||
|
.B \-\-verbose
|
||||||
|
Print detailed build output including compiler commands.
|
||||||
|
.TP
|
||||||
|
.B \-\-workspace \fI<name>\fR
|
||||||
|
Build a specific workspace member.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1)
|
||||||
26
man/man1/dcr-clean.1
Normal file
26
man/man1/dcr-clean.1
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
.TH DCR-CLEAN 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-clean \- Remove build artifacts
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr clean
|
||||||
|
[\fB\-\-debug\fR | \fB\-\-release\fR]
|
||||||
|
[\fB\-\-target\fR \fI<triple>\fR]
|
||||||
|
[\fB\-\-all\fR]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Removes build artifacts from the target directory.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
Clean debug artifacts (default).
|
||||||
|
.TP
|
||||||
|
.B \-\-release
|
||||||
|
Clean release artifacts.
|
||||||
|
.TP
|
||||||
|
.B \-\-target \fI<triple>\fR
|
||||||
|
Clean artifacts for a specific target.
|
||||||
|
.TP
|
||||||
|
.B \-\-all
|
||||||
|
Clean all workspace members.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-build (1)
|
||||||
10
man/man1/dcr-fmt.1
Normal file
10
man/man1/dcr-fmt.1
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
.TH DCR-FMT 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-fmt \- Format C/C++ source files
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr fmt
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Formats all C/C++ source files using clang-format. Scans \fBsrc/\fR
|
||||||
|
and \fBtests/\fR directories recursively.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1)
|
||||||
23
man/man1/dcr-gen.1
Normal file
23
man/man1/dcr-gen.1
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
.TH DCR-GEN 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-gen \- Generate IDE and tooling integration files
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr gen \fI<subcommand>\fR
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Generates IDE and tooling integration files for DCR projects.
|
||||||
|
.SH SUBCOMMANDS
|
||||||
|
.TP
|
||||||
|
.B project-info
|
||||||
|
Print project metadata as JSON to stdout.
|
||||||
|
.TP
|
||||||
|
.B compile-commands
|
||||||
|
Generate \fBcompile_commands.json\fR for IDE tooling.
|
||||||
|
.TP
|
||||||
|
.B vscode
|
||||||
|
Generate \fB.vscode/\fR integration files (tasks, launch configurations).
|
||||||
|
.TP
|
||||||
|
.B clion
|
||||||
|
Generate \fB.idea/\fR integration files for CLion.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-build (1)
|
||||||
11
man/man1/dcr-init.1
Normal file
11
man/man1/dcr-init.1
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
.TH DCR-INIT 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-init \- Initialize a directory as a DCR project
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr init
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Initializes the current directory as a DCR project. The directory must
|
||||||
|
be empty.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-new (1)
|
||||||
13
man/man1/dcr-new.1
Normal file
13
man/man1/dcr-new.1
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
.TH DCR-NEW 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-new \- Create a new DCR project
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr new \fI<name>\fR
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Creates a new C/C++ project with the given name. The name may only
|
||||||
|
contain ASCII letters, digits, underscores and hyphens.
|
||||||
|
.SH EXAMPLE
|
||||||
|
.B dcr new my-project
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-init (1)
|
||||||
35
man/man1/dcr-run.1
Normal file
35
man/man1/dcr-run.1
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
.TH DCR-RUN 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-run \- Build and run a DCR project
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr run
|
||||||
|
[\fB\-\-debug\fR | \fB\-\-release\fR]
|
||||||
|
[\fB\-\-target\fR \fI<triple>\fR]
|
||||||
|
[\fB\-\-force\fR]
|
||||||
|
[\fB\-\-clean\fR]
|
||||||
|
[\fB\-\-verbose\fR]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Builds and runs the project. Only available for projects with
|
||||||
|
\fBkind = "bin"\fR.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
Run with debug profile (default).
|
||||||
|
.TP
|
||||||
|
.B \-\-release
|
||||||
|
Run with release profile.
|
||||||
|
.TP
|
||||||
|
.B \-\-target \fI<triple>\fR
|
||||||
|
Cross-compile for the given target.
|
||||||
|
.TP
|
||||||
|
.B \-\-force
|
||||||
|
Force a full rebuild.
|
||||||
|
.TP
|
||||||
|
.B \-\-clean
|
||||||
|
Clean before building.
|
||||||
|
.TP
|
||||||
|
.B \-\-verbose
|
||||||
|
Print detailed build output.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-build (1)
|
||||||
11
man/man1/dcr-setup.1
Normal file
11
man/man1/dcr-setup.1
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
.TH DCR-SETUP 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-setup \- Set up DCR registries
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr setup
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Sets up DCR registries. Downloads and indexes package registries
|
||||||
|
for dependency resolution.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-add (1)
|
||||||
24
man/man1/dcr-test.1
Normal file
24
man/man1/dcr-test.1
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
.TH DCR-TEST 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-test \- Run project tests
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr test
|
||||||
|
[\fB\-\-init\fR]
|
||||||
|
[\fB\-\-debug\fR | \fB\-\-release\fR]
|
||||||
|
.SH ALIASES
|
||||||
|
.B dcr tests
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Runs project tests and prints a unified testsuite report.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-init
|
||||||
|
Create \fBtests/dcr_test.h\fR in the current project.
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
Build and run tests with debug profile (default).
|
||||||
|
.TP
|
||||||
|
.B \-\-release
|
||||||
|
Build and run tests with release profile.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-build (1)
|
||||||
11
man/man1/dcr-tree.1
Normal file
11
man/man1/dcr-tree.1
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
.TH DCR-TREE 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr-tree \- Display the dependency tree
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr tree
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Displays the dependency tree of the current project, showing all
|
||||||
|
transitive dependencies and their versions.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR dcr (1),
|
||||||
|
.BR dcr-add (1)
|
||||||
204
man/man1/dcr.1
Normal file
204
man/man1/dcr.1
Normal file
@@ -0,0 +1,204 @@
|
|||||||
|
.TH DCR 1 "2026-06-02" "dcr 0.7.0" "DCR Manual"
|
||||||
|
.SH NAME
|
||||||
|
dcr \- Cargo\-like build tool and package manager for C/C++ projects
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dcr
|
||||||
|
[\fIcommand\fR] [\fIoptions\fR]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
DCR is a comprehensive build tool and package manager for C and C++ projects,
|
||||||
|
inspired by Cargo from the Rust ecosystem. It handles project creation,
|
||||||
|
building, dependency management, testing, formatting, and IDE integration.
|
||||||
|
.SH COMMANDS
|
||||||
|
.TP
|
||||||
|
.B new \fI<name>\fR
|
||||||
|
Create a new C/C++ project with the given name. Only ASCII letters, digits,
|
||||||
|
underscores and hyphens are allowed.
|
||||||
|
.TP
|
||||||
|
.B init
|
||||||
|
Initialize the current (empty) directory as a DCR project.
|
||||||
|
.TP
|
||||||
|
.B build [\fIoptions\fR]
|
||||||
|
Compile the project. Default profile is \fB\-\-debug\fR.
|
||||||
|
.TP
|
||||||
|
.B run [\fIoptions\fR]
|
||||||
|
Build and run the project. Only available for binary projects.
|
||||||
|
.TP
|
||||||
|
.B clean [\fIoptions\fR]
|
||||||
|
Remove build artifacts from the target directory.
|
||||||
|
.TP
|
||||||
|
.B test [\fI\-\-init\fR] [\fI\-\-debug\fR|\fI\-\-release\fR]
|
||||||
|
Run project tests (alias: \fBdcr tests\fR).
|
||||||
|
.TP
|
||||||
|
.B add \fI<name>\fR \fI<source>\fR [\fIoptions\fR]
|
||||||
|
Add a dependency to the project.
|
||||||
|
.TP
|
||||||
|
.B tree
|
||||||
|
Display the dependency tree of the current project.
|
||||||
|
.TP
|
||||||
|
.B fmt
|
||||||
|
Format all C/C++ source files using clang-format.
|
||||||
|
.TP
|
||||||
|
.B gen \fI<subcommand>\fR
|
||||||
|
Generate IDE integration files (vscode, clion, compile-commands, project-info).
|
||||||
|
.TP
|
||||||
|
.B setup
|
||||||
|
Set up DCR registries for dependency resolution.
|
||||||
|
.SH GLOBAL FLAGS
|
||||||
|
.TP
|
||||||
|
.B \-\-help
|
||||||
|
Show this help message and exit.
|
||||||
|
.TP
|
||||||
|
.B \-\-version
|
||||||
|
Print version information and exit.
|
||||||
|
.TP
|
||||||
|
.B \-\-update
|
||||||
|
Update DCR to the latest version from GitHub Releases.
|
||||||
|
.SH BUILD OPTIONS
|
||||||
|
The following options apply to \fBbuild\fR and \fBrun\fR commands:
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
Build with debug profile (default). Enables debug symbols and minimal optimization.
|
||||||
|
.TP
|
||||||
|
.B \-\-release
|
||||||
|
Build with release profile. Enables full optimization without debug symbols.
|
||||||
|
.TP
|
||||||
|
.B \-\-target \fI<triple>\fR
|
||||||
|
Cross-compile for the given target (e.g. \fBaarch64-linux-gnu\fR, \fBx86_64-w64-mingw32\fR).
|
||||||
|
Short names like \fBlinux\fR, \fBmacos\fR, \fBwindows\fR are also supported.
|
||||||
|
.TP
|
||||||
|
.B \-\-force
|
||||||
|
Force a full rebuild, ignoring cached build artifacts.
|
||||||
|
.TP
|
||||||
|
.B \-\-clean
|
||||||
|
Clean build artifacts before building.
|
||||||
|
.TP
|
||||||
|
.B \-\-verbose
|
||||||
|
Print detailed build output including compiler commands.
|
||||||
|
.TP
|
||||||
|
.B \-\-workspace \fI<name>\fR
|
||||||
|
Build a specific workspace member.
|
||||||
|
.SH CLEAN OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
Clean debug artifacts (default).
|
||||||
|
.TP
|
||||||
|
.B \-\-release
|
||||||
|
Clean release artifacts.
|
||||||
|
.TP
|
||||||
|
.B \-\-target \fI<triple>\fR
|
||||||
|
Clean artifacts for a specific target.
|
||||||
|
.TP
|
||||||
|
.B \-\-all
|
||||||
|
Clean all workspace members.
|
||||||
|
.SH ADD OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-branch \fI<name>\fR
|
||||||
|
Use a specific branch when adding a git dependency.
|
||||||
|
.TP
|
||||||
|
.B \-\-tag \fI<name>\fR
|
||||||
|
Use a specific tag when adding a git dependency.
|
||||||
|
.TP
|
||||||
|
.B \-\-rev \fI<hash>\fR
|
||||||
|
Use a specific commit hash when adding a git dependency.
|
||||||
|
.SH DEPENDENCY SOURCES
|
||||||
|
.TP
|
||||||
|
.B user/repo
|
||||||
|
GitHub shorthand (e.g. \fBuser/repo\fR).
|
||||||
|
.TP
|
||||||
|
.B github:user/repo
|
||||||
|
Full GitHub repository URL shorthand.
|
||||||
|
.TP
|
||||||
|
.B gitlab:user/repo
|
||||||
|
GitLab repository URL shorthand.
|
||||||
|
.TP
|
||||||
|
.B git:host.com/user/repo
|
||||||
|
Generic git repository.
|
||||||
|
.TP
|
||||||
|
.B path:./path/to/lib
|
||||||
|
Local path dependency.
|
||||||
|
.TP
|
||||||
|
.B \fI<version>\fR
|
||||||
|
Version from registry (e.g. \fB1.2.3\fR).
|
||||||
|
.SH GEN SUBCOMMANDS
|
||||||
|
.TP
|
||||||
|
.B project-info
|
||||||
|
Print project metadata as JSON to stdout.
|
||||||
|
.TP
|
||||||
|
.B compile-commands
|
||||||
|
Generate \fBcompile_commands.json\fR for IDE tooling.
|
||||||
|
.TP
|
||||||
|
.B vscode
|
||||||
|
Generate \fB.vscode/\fR integration files (tasks, launch configurations).
|
||||||
|
.TP
|
||||||
|
.B clion
|
||||||
|
Generate \fB.idea/\fR integration files for CLion.
|
||||||
|
.SH TEST OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-init
|
||||||
|
Create \fBtests/dcr_test.h\fR in the current project.
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
Build and run tests with debug profile (default).
|
||||||
|
.TP
|
||||||
|
.B \-\-release
|
||||||
|
Build and run tests with release profile.
|
||||||
|
.SH PROJECT CONFIGURATION
|
||||||
|
DCR uses \fBdcr.toml\fR for project configuration. Key settings include:
|
||||||
|
.TP
|
||||||
|
.B package.name
|
||||||
|
Project name (required).
|
||||||
|
.TP
|
||||||
|
.B package.version
|
||||||
|
Project version (default: \fB0.1.0\fR).
|
||||||
|
.TP
|
||||||
|
.B build.language
|
||||||
|
Programming language: \fBc\fR or \fBc++\fR (default: \fBc\fR).
|
||||||
|
.TP
|
||||||
|
.B build.standard
|
||||||
|
Language standard (e.g. \fBc11\fR, \fBc17\fR, \fBc++20\fR; default: \fBc11\fR).
|
||||||
|
.TP
|
||||||
|
.B build.compiler
|
||||||
|
Compiler to use: \fBclang\fR, \fBgcc\fR, \fBcl\fR, \fBclang-cl\fR (default: \fBclang\fR).
|
||||||
|
.TP
|
||||||
|
.B build.kind
|
||||||
|
Output type: \fBbin\fR, \fBlib\fR (static or dynamic), \fBstaticlib\fR, \fBsharedlib\fR (default: \fBbin\fR).
|
||||||
|
.SH FILES
|
||||||
|
.TP
|
||||||
|
.I dcr.toml
|
||||||
|
Project manifest file.
|
||||||
|
.TP
|
||||||
|
.I ~/.dcr/config.toml
|
||||||
|
User-level DCR configuration.
|
||||||
|
.TP
|
||||||
|
.I ~/.dcr/index.json
|
||||||
|
Local registry index.
|
||||||
|
.SH ENVIRONMENT
|
||||||
|
.TP
|
||||||
|
.B DCR_COMPILER
|
||||||
|
Override the compiler used for building.
|
||||||
|
.TP
|
||||||
|
.B DCR_CC
|
||||||
|
Alternative way to override the compiler.
|
||||||
|
.SH EXAMPLES
|
||||||
|
.TP
|
||||||
|
Create a new project:
|
||||||
|
.B dcr new hello
|
||||||
|
.TP
|
||||||
|
Initialize from current directory:
|
||||||
|
.B dcr init
|
||||||
|
.TP
|
||||||
|
Build with release profile:
|
||||||
|
.B dcr build \-\-release
|
||||||
|
.TP
|
||||||
|
Cross-compile for Windows:
|
||||||
|
.B dcr build \-\-target windows
|
||||||
|
.TP
|
||||||
|
Add a dependency:
|
||||||
|
.BR "dcr add curl git:https://github.com/curl/curl" .
|
||||||
|
.TP
|
||||||
|
Generate VS Code integration:
|
||||||
|
.B dcr gen vscode
|
||||||
|
.SH SEE ALSO
|
||||||
|
.IR https://dcr.dexoron.su ", " https://github.com/dexoron/dcr
|
||||||
|
.SH AUTHORS
|
||||||
|
Dexoron (Bezotechestvo Vladimir) <main@dexoron.su>
|
||||||
1
packaging/aur/dcr-dev-git
Submodule
1
packaging/aur/dcr-dev-git
Submodule
Submodule packaging/aur/dcr-dev-git added at 93bdce858b
1
packaging/aur/dcr-git
Submodule
1
packaging/aur/dcr-git
Submodule
Submodule packaging/aur/dcr-git added at 2c5743a456
@@ -27,4 +27,7 @@ package() {
|
|||||||
cd "$srcdir/$pkgname-$pkgver"
|
cd "$srcdir/$pkgname-$pkgver"
|
||||||
install -Dm755 "target/release/dcr" "$pkgdir/usr/bin/dcr"
|
install -Dm755 "target/release/dcr" "$pkgdir/usr/bin/dcr"
|
||||||
install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
|
install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
|
||||||
|
for manpage in man/man1/*.1; do
|
||||||
|
install -Dm644 "$manpage" "$pkgdir/usr/share/man/man1/$(basename "$manpage")"
|
||||||
|
done
|
||||||
}
|
}
|
||||||
|
|||||||
18
packaging/snap/snapcraft.yaml
Normal file
18
packaging/snap/snapcraft.yaml
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
name: dcrup
|
||||||
|
base: core22
|
||||||
|
version: '0.6.9'
|
||||||
|
summary: Cargo-like utility to manage C/C++ projects
|
||||||
|
description: |
|
||||||
|
A build tool and package manager for C/C++ projects inspired by Rust's Cargo.
|
||||||
|
|
||||||
|
grade: stable
|
||||||
|
confinement: classic
|
||||||
|
|
||||||
|
apps:
|
||||||
|
dcr:
|
||||||
|
command: bin/dcr
|
||||||
|
|
||||||
|
parts:
|
||||||
|
dcr:
|
||||||
|
plugin: dump
|
||||||
|
source: dist/
|
||||||
2
rust-toolchain.toml
Normal file
2
rust-toolchain.toml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
[toolchain]
|
||||||
|
channel = "stable"
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user