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

Package Declaration Grammar

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

Declare a named package target and one or more binary payloads.

Stable ID: package.declaration.DefinePackage

Source: BuildTools/cmake/helpers/Build.cmake; consumer: BuildTools/cmake/stages/Packages.cmake.

DefinePackage(<name>
    CONFIG <config>
    BINARY <target> <platform> <arch[+arch...]> <pack[+pack...]> [POSTFIX <value>]
    [BINARY ...]
)

Stable ID	Clause	Arguments	Required	Repeatable	Purpose
`package.declaration.DefinePackage.clause.CONFIG`	`CONFIG`	`<config>`	yes	no	Set the package-wide default config.
`package.declaration.DefinePackage.clause.BINARY`	`BINARY`	`<target> <platform> <arch> <pack>`	yes	yes	Add one target/platform/architecture payload, optionally followed by POSTFIX and a value that apply together only to this binary entry.

Per-binary modifiers

Stable ID	Modifier	Value	Default	Purpose
`package.binary-option.POSTFIX`	`POSTFIX`	`string`	`empty`	Select the matching postfixed binary input and isolate this entry’s target directory, packaged build name, runtime-update payloads, and MSI name without affecting sibling BINARY entries.

DefinePackage requires CONFIG. Each BINARY becomes one package.py invocation. POSTFIX is optional and belongs only to the immediately preceding BINARY; it has no package-wide fallback.