Commit Graph

2 Commits

Author SHA1 Message Date
vasilito 037e0f6a13 docs: document --check-sweep flag in BUILD-SYSTEM.md and SCRIPT-BEHAVIOR-MATRIX.md
redbear-ci / check (push) Has been cancelled
Add the --check-sweep option to the authoritative build-system reference
since it was missing from the documentation despite being a key gating
mechanism.

BUILD-SYSTEM.md (canonical reference):
- Added --check-sweep row to the §2 Options table with a clear pointer
  to the new §2.1 section
- Added §2.1 'Pre-build check sweep' section that documents:
  * What it does: cargo check --target <triple> --offline on every fork
    + every config recipe BEFORE the cook/prefix cycle
  * Why it exists: surfaces all type/borrow errors at once instead of
    one-at-a-time deep inside a multi-minute relibc rebuild
  * Implementation: redbear_check_sweep() in build-redbear.sh
  * Toolchain requirement: ~/.redoxer/<triple>/toolchain/bin/cargo
  * Skip list: bootloader (bare-metal/UEFI, custom targets)
  * Log location: $REDBEAR_BUILD_LOGS_DIR/check-sweep-<name>.log
  * Exit codes: 0 on success, 1 on any failure with summary
  * Current evidence: 48/48 packages pass on redbear-mini with
    --check-sweep after the 2026-07-28 refactor round

SCRIPT-BEHAVIOR-MATRIX.md (per-script roles):
- Updated the build-redbear.sh table entry to call out --check-sweep
  in the 'enforces' description
- Added a new 'build-redbear.sh Flag Reference' table with the full
  flag list and effect descriptions (mirrors the actual --help output)
- The new section highlights that --check-sweep is the recommended
  pre-build gate to surface all type/borrow errors up-front

Verification: --check-sweep redbear-mini passes 48/48 packages, matching
the documented behavior.
2026-07-29 10:01:28 +09:00
vasilito a043a03c81 docs: add canonical BUILD-SYSTEM.md; update build docs for flags + no-stashing
Add local/docs/BUILD-SYSTEM.md as the single authoritative build-system
reference (entry point, CLI flags, pipeline stages, offline/release, caching,
no working-tree stashing, fork/vendored-upstream versioning, self-versioning).
Update AGENTS.md (dirty-gate replaces the removed stash-and-restore; --allow-dirty;
pointer), SCRIPT-BEHAVIOR-MATRIX.md (stash line -> dirty-source gate), README.md
(flags + pointer), and add canonical-doc pointers to BUILD-SYSTEM-INVARIANTS.md
and docs/06-BUILD-SYSTEM-SETUP.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-27 13:23:07 +09:00