Skip to content

Commit 189cacc

Browse files
authored
docs: reflect cabin check in the cargo-inspired interface audit (#1348)
1 parent 8187132 commit 189cacc

2 files changed

Lines changed: 3 additions & 4 deletions

File tree

docs/architecture.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ source replacement, the dev / test / example target kinds
2222
plus `cabin test`, vendoring + `--offline`,
2323
`cabin metadata` / `cabin tree` / `cabin explain`, the
2424
Cargo-inspired interface foundation (`cabin run`, the
25-
`cabin-env` crate), `cabin fmt` / `cabin tidy`,
25+
`cabin-env` crate), `cabin check`, `cabin fmt` / `cabin tidy`,
2626
`pkg-config`-driven ``system = true` deps`,
2727
`CPPFLAGS` / `CFLAGS` / `CXXFLAGS` / `LDFLAGS` ingestion,
2828
`-j` / `--jobs` build / run / tidy parallelism,
@@ -93,6 +93,7 @@ docs/
9393
metadata-tree-explain.md `cabin metadata` / `cabin tree` / `cabin explain`
9494
cargo-inspired-interface.md Cabin-vs-Cargo audit / classification
9595
environment-variables.md CABIN_* read-side / run / test env vars
96+
check.md `cabin check` (-fsyntax-only type-check)
9697
fmt.md `cabin fmt` (clang-format)
9798
tidy.md `cabin tidy` (run-clang-tidy)
9899
system-dependencies.md ``system = true` deps` and pkg-config

docs/cargo-inspired-interface.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ leaves out, and where to look for the rule when in doubt.
1818
| `cabin init` | `cargo init` | Single-package generator (current directory). `--bin` / `--lib` select scaffold kind (binary by default). See [`new-and-init.md`](new-and-init.md). |
1919
| `cabin new` | `cargo new` | Single-package generator (new directory). `--bin` / `--lib` select scaffold kind (binary by default). See [`new-and-init.md`](new-and-init.md). |
2020
| `cabin build` | `cargo build` | Plans + invokes Ninja |
21+
| `cabin check` | `cargo check` | Reuses the build graph but compiles with `-fsyntax-only`; no objects or binaries |
2122
| `cabin clean` | `cargo clean` | Removes Cabin-generated build artifacts |
2223
| `cabin run` | `cargo run` | Builds and runs an exec target; `--` forwards args |
2324
| `cabin test` | `cargo test` | Builds + runs `test` targets |
@@ -144,9 +145,6 @@ Cabin's C/C++ scope:
144145
`cargo owner` / `cargo yank` — registry-server work is out
145146
of scope until a Cabin registry server exists.
146147
- `cargo rustc` / `cargo rustdoc` / `cargo fix` — Rust-specific.
147-
- `cargo check` — C/C++ has no compile-without-link contract
148-
shared across compilers; `cabin build` already covers the
149-
typical "did this change compile?" use case.
150148
- `cargo bench` — Cabin has no benchmark target kind and no
151149
benchmark harness model. Users who need to time a binary
152150
declare an `executable` and run it themselves.

0 commit comments

Comments
 (0)