diff options
| author | Raoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk> | 2018-11-27 10:23:14 +0000 |
|---|---|---|
| committer | Raoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk> | 2018-12-05 14:58:53 +0000 |
| commit | 23c27580d763c5107b5f9819a6d3b69fb2179212 (patch) | |
| tree | 2d48c84ffad781f30cf60912eb4504ca58f3ac0d | |
| parent | 81163a79a3bcf5cbe367a457048556597d2ea866 (diff) | |
| download | buildstream-23c27580d763c5107b5f9819a6d3b69fb2179212.tar.gz | |
format_project.rst: Add docs for OptionOS
| -rw-r--r-- | doc/source/format_project.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst index f5b324161..59ee05e85 100644 --- a/doc/source/format_project.rst +++ b/doc/source/format_project.rst @@ -586,6 +586,30 @@ Architecture options can be tested with the same expressions as other Enumeration options. +.. _project_options_os: + +OS +~~ + +The ``os`` option type is a special enumeration option, which defaults to the +results of `uname -s`. It does not support assigning any default in the project +configuration. + +.. code:: yaml + + options: + machine_os: + type: os + description: The machine OS + values: + - Linux + - SunOS + - Darwin + - FreeBSD + +Os options can be tested with the same expressions as other Enumeration options. + + .. _project_options_element_mask: Element mask |