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

Package Manifest API

English | 한국어

English

RUSTOS.package.toml is the deployment source of truth. The parser and schema types are in tools/xtask/src/package_manifest.rs.

Minimal Shape

id = "example"
kind = "service"
execution_domain = "user"
profiles = ["default"]
startup = "none"

[build]
builder = "cargo-kernel-binary"
package = "example"

[install]
path = "services/example/example.elf"

[[desktop.entries]]
display_name = "example"
weight_micros = 100
console_hosted = false

Top-Level Fields

FieldValuesMeaning
idstringStable package id used by runtime deps and registries.
kindboot, kernel, bridge-driver, user-driver, service, app, compatPackage taxonomy.
execution_domainkernel, userOptional explicit execution domain.
profilesstring listBuild/profile membership; defaults to ["default"].
startupnone, init, session, desktopStartup policy for generated registries.
runtime_depspackage id listRuntime ordering/exposure dependency metadata.

Build Section

builderPurpose
bootloader-uefiCompatibility alias for GRUB EFI boot manager generation.
kernel-rustcKernel/nucleus artifact build.
cargo-kernel-binaryRust userspace service/app ELF.
mingw-c-exeWindows PE executable demo.
c-demoHost C demo/smoke artifact.
module-imageKernel bridge .ko module image.
winsys-dll-bundleWindows system DLL bundle.
external-copyCopy externally provided artifact.

Install Section

FieldMeaning
pathRelative path inside artifacts and staged image.
layoutfile or directory; defaults to file.

Desktop Entries

[[desktop.entries]] generates desktop/runtime launch metadata.

FieldMeaning
display_nameUI/runtime display name.
imageOptional staged image path override.
execOptional executable path override.
weight_microsScheduling/task weight metadata.
logical_adminMarks privileged/admin-style components.
console_hostedWhether runtime should host it through console.
launchnone, new-session, or all-sessions.
argsCommand argv metadata.
envEnvironment entries.

Autoload Section

Bridge drivers can declare autoload metadata:

[autoload]
name = "amdgpu"
class = "display"
bus = "pci"
enabled = true
priority = 10
when = "vfs-ready"
aliases = ["pci:vendor=0x1002,class=0x03"]
provider_group = "display-primary"
fallback_only = false

Stage writes enabled entries into system/registry/kernel/loadable-drivers.tsv.

한국어

RUSTOS.package.toml은 deployment source of truth입니다. parser와 schema type은 tools/xtask/src/package_manifest.rs에 있습니다.

최소 형태

id = "example"
kind = "service"
execution_domain = "user"
profiles = ["default"]
startup = "none"

[build]
builder = "cargo-kernel-binary"
package = "example"

[install]
path = "services/example/example.elf"

[[desktop.entries]]
display_name = "example"
weight_micros = 100
console_hosted = false

Top-Level Fields

FieldValuesMeaning
idstringruntime deps와 registry에서 쓰는 stable package id
kindboot, kernel, bridge-driver, user-driver, service, app, compatpackage taxonomy
execution_domainkernel, useroptional explicit execution domain
profilesstring listbuild/profile membership, 기본값 ["default"]
startupnone, init, session, desktopgenerated registry startup policy
runtime_depspackage id listruntime ordering/exposure dependency metadata

Build Section

builderPurpose
bootloader-uefiGRUB EFI boot manager 생성용 compatibility alias
kernel-rustckernel/nucleus artifact build
cargo-kernel-binaryRust userspace service/app ELF
mingw-c-exeWindows PE executable demo
c-demohost C demo/smoke artifact
module-imagekernel bridge .ko module image
winsys-dll-bundleWindows system DLL bundle
external-copyexternally provided artifact copy

Install Section

FieldMeaning
pathartifact와 staged image 안의 relative path
layoutfile 또는 directory, 기본값 file

Desktop Entries

[[desktop.entries]]는 desktop/runtime launch metadata를 생성합니다.

FieldMeaning
display_nameUI/runtime display name
imageoptional staged image path override
execoptional executable path override
weight_microsscheduling/task weight metadata
logical_adminprivileged/admin-style component 표시
console_hostedruntime이 console로 host할지 여부
launchnone, new-session, all-sessions
argscommand argv metadata
envenvironment entries

Autoload Section

Bridge driver는 autoload metadata를 선언할 수 있습니다.

[autoload]
name = "amdgpu"
class = "display"
bus = "pci"
enabled = true
priority = 10
when = "vfs-ready"
aliases = ["pci:vendor=0x1002,class=0x03"]
provider_group = "display-primary"
fallback_only = false

stage는 enabled entry만 system/registry/kernel/loadable-drivers.tsv에 기록합니다.