Skip to content

Commit

Permalink
1
Browse files Browse the repository at this point in the history
  • Loading branch information
metux committed Sep 8, 2023
1 parent e34a86f commit 34f7c73
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ dck-buildpackage tool) and puts them into installable apt repos.

Configuration is done via yaml. (see packages.yml for an example)

See [FAQ](FAQ.md)
See [specification objects](doc/spec-object.md) and [FAQ](FAQ.md)

NOTE: this is still experimental - before using it in production,
please consult me first.
Expand Down
File renamed without changes.
26 changes: 19 additions & 7 deletions doc/config-objects.md → doc/spec-objects.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
Configuration objects
Specification objects
=====================

The configuration scheme is comprised of several objects, with tree-structured attributes,
which are loaded from YAML files. Some attributes have intrinsic defaults, resolved at runtime.
Various objects also have references to other objects *(e.g. the global config)*, which also
are added as intrinsics.
The configuration of the build process is comprised of several specification
objects - these have tree-structured attributes, loaded from YAML files.
Some attributes have intrinsic defaults, resolved at runtime *(when the value
is retrieved)*.

Spec objects also may have references to other ones *(via intrinsics)*, all
have a reference to the GlobalSpec *(as `GLOBAL::`).

Variable substitution
---------------------
Expand Down Expand Up @@ -33,9 +36,18 @@ Path addressing also works through intrinsic object references:
Object types
------------

* global config / repo config
* [GlobalSpec](GlobalSpec.md)
* represents the global configuration for a set of target repositories
* linked into other objects under the `GLOBAL` key

* package config
* [PkgSpec](PkgSpec.md)
* represents individual packages

* [PoolSpec](PoolSpec.md)
* represents a pool

* [TargetSpec](TargetSpec.md)
* build target

* [DutSpec](DutSpec.md)
* device under test

0 comments on commit 34f7c73

Please sign in to comment.