mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 14:38:30 +00:00
81 lines
3.3 KiB
Markdown
81 lines
3.3 KiB
Markdown
# 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.filename`
|
|
- `build.extension`
|
|
- `build.compiler`
|
|
- `build.language`
|
|
- `build.standard`
|
|
- `build.cxx_standard`
|
|
- `build.kind`
|
|
- `build.target`
|
|
- `build.out_dir`
|
|
- `build.platform`
|
|
- `package.type`
|
|
- `build.cflags`
|
|
- `build.ldflags`
|
|
- `build.ldscript`
|
|
- `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`, `freebsd`, `openbsd`, `netbsd`).
|
|
- `--verbose` prints the compiler/linker command lines to stderr (also works via `DCR_DEBUG` env var).
|
|
- `--workspace <name>` filters build to a specific workspace member.
|
|
- 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.
|
|
- `build.filename` + `build.extension` allow full control over the final artifact name (e.g. `KERNEL.BIN` instead of using `package.name`). When `build.kind = "efi"`, the output is a PE32+ executable with `.efi` extension.
|
|
- `build.kind = "efi"` links with `-shared -nostdlib -Wl,-dll -Wl,--subsystem,10` for UEFI PE32+ format. Use `build.filename` and `build.extension` for full control over the artifact name.
|
|
- `build.kind = "elf"` produces a bare-metal ELF executable. Linking flags are user-controlled via `build.ldflags` (no PIE/CRT defaults are added).
|
|
- Default GCC/Clang profile flags: `debug` -> `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDCR_DEBUG`, `release` -> `-O3 -DNDEBUG`.
|
|
These defaults are **not applied** for bare-metal targets (e.g. `aarch64-none-elf`, targets containing `none` / `-elf` / `eabi`).
|
|
- 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.
|