Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Stability

From 1.0, the rqtk command line follows semantic versioning. Within 1.x, the following change only in backwards-compatible ways:

SurfacePromise within 1.x
File format (schema_version = 1)Files valid today stay valid. New optional fields may be added. A breaking change gets a new schema_version.
Commands and flagsNone removed or renamed.
--json outputFields are only added, never removed, renamed or retyped.
Exit codes0, 1, 2 and 3 keep their meaning.
Lint rule codesA code keeps its meaning and is never reused. New rules may be added, so lint can find new problems after an upgrade.
Content hashTagged with its version (v1:); a different algorithm gets a new tag.

Not covered: human-readable text output, and the Rust library crates (rqtk-core, rqtk-export, rqtk-report, rqtk-macros), which stay at 0.x and may change between minor versions, along with their re-exports from the rqtk crate (rqtk::core, rqtk::export, rqtk::macros). The #[rqtk::verifies("…")] attribute itself is covered.