Documentation Docs/en/reference/packages/index.md

Generated Package Interface

Generated reference. Do not edit this page directly. Update BuildTools/PackageInterface.json or BuildTools/package.py, then run python BuildTools/docs_package.py --write.

Index

Declaration

This reference joins the CMake package declaration with the runtime-consumed packager contract. It describes engine capabilities, not an embedding project’s release matrix. This generated package interface is the entry point for DefinePackage grammar, package.py targets, platforms, pack tokens, and payload effects.

Cross-contract decision

Use this cross-contract sequence:

State the package boundary explicitly: pin an exact Engine revision and use BuildTools/PackageInterface.json as the internal package contract; do not replace this statement with a generic revision-pinned heading.
Treat accepted package.py dimensions and payload effects as capability only. Embedding-project package matrices, release policy, secret provisioning, deployment topology, and installer signing credentials remain excluded and project-owned.
Read support separately: build_gated, smoke_gated, source_capable, and not_in_public_matrix are distinct states.
For each example, report source status, remote visibility/state, observed required checks, exact Engine pin, update-delivery policy, and matching Contract digest together. Only a published source with a public / published remote and passing observed checks is publication evidence; a private, reserved, source-staged, planned, or unobserved repository is not.

Contract status

Field	Value
Stability	`internal`
Since	Not declared
Support policy	No versioned package support line is declared; embedding projects must pin an engine revision.
Manifest	BuildTools/PackageInterface.json
Packager	BuildTools/package.py
Contract digest	`13ad77ab5b1a53bc20e8c3a701043aebcc6c6c27dcc3e03b9d0fa696c6602b2f`

Coverage

Reference	Entries	Purpose
Declaration	2	CMake clauses and per-binary modifiers.
Targets/platforms/packs	6 / 6 / 19	Accepted runtime dimensions and support status.
Payloads and artifacts	8	Implemented output-producing pack tokens.
Packager CLI	17	Exact internal package.py invocation contract.

Boundary

Included:

DefinePackage declaration clauses and the per-binary POSTFIX modifier
package.py targets, platforms, architecture keys, pack tokens, and payload effects
implemented, placeholder, and unsupported package boundaries

Excluded from this slice:

embedding-project package matrices and release policy
project configuration key schema and secret provisioning
resource-pack content selection and deployment topology
installer signing credentials and external tool operation