Expand description
Site file schema.
Every struct is declared through doc_struct!, which emits the serde
struct and its field documentation from one declaration. The parser, the
schema reference and the documentation test all read the same table.
Structs§
- Admission
- Inode admission before a build unit starts.
- Build
Type Override - Per build type override of a target.
- Cache
Target - One module cache entry.
- Caches
- Module caches, one finaliser per target.
- Eessi
- EESSI layer.
- Field
Doc - One documented key of the site file.
- Filesystems
- Paths.
- Hardware
- Hardware identity of a target.
- Licence
Required - Required licensed software.
- Licences
- Licence enforcement mechanism; the data stays in the site file.
- Logs
- Log handling.
- Modules
- Environment modules.
- Phase
Args - Launch arguments per phase role.
- Rebuild
- Staged rebuild.
- Rotate
- Rotation limits.
- Route
- Wrapper for CPU phases on a host that is not native to the target.
- Scheduler
- How a phase becomes a job.
- Select
- Per-target line selection by a build list option.
- Shards
- Shard planning.
- Site
- A site file.
- Site
Info - Site identity.
- Sources
- Source prefetch.
- Target
- One node type.
- Tool
Spec - A sibling tool: binary and minimum version.
- Tools
- Sibling tool table.
Constants§
- SECTIONS
- Every documented table, by its path in the file.
Functions§
- reference
- Render the key reference as plain text.