[Notes] [Git][BuildStream/buildstream][raoul/775-execution-environment-reqs] format_project.rst: Add docs for OptionOS



Title: GitLab

Raoul Hidalgo Charman pushed to branch raoul/775-execution-environment-reqs at BuildStream / buildstream

Commits:

1 changed file:

Changes:

  • doc/source/format_project.rst
    ... ... @@ -572,6 +572,30 @@ Architecture options can be tested with the same expressions
    572 572
     as other Enumeration options.
    
    573 573
     
    
    574 574
     
    
    575
    +.. _project_options_os:
    
    576
    +
    
    577
    +OS
    
    578
    +~~
    
    579
    +
    
    580
    +The ``os`` option type is a special enumeration option, which defaults to the
    
    581
    +results of `uname -s`. It does not support assigning any default in the project
    
    582
    +configuration.
    
    583
    +
    
    584
    +.. code:: yaml
    
    585
    +
    
    586
    +    options:
    
    587
    +      machine_os:
    
    588
    +        type: os
    
    589
    +        description: The machine OS
    
    590
    +        values:
    
    591
    +        - Linux
    
    592
    +        - SunOS
    
    593
    +        - Darwin
    
    594
    +        - FreeBSD
    
    595
    +
    
    596
    +Os options can be tested with the same expressions as other Enumeration options.
    
    597
    +
    
    598
    +
    
    575 599
     .. _project_options_element_mask:
    
    576 600
     
    
    577 601
     Element mask
    



  • [Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]