summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/source/format_project.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 29bd73dfd..abc989a50 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