diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-04-06 17:46:28 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-04-06 17:51:16 +0900 |
| commit | 23edfe5d961136c2a22fd4c0939bb9dc0e9e3a14 (patch) | |
| tree | cfce967ad382e5cc1db068f497d2bd4dd60f3db1 /doc/source | |
| parent | 06b1920bf3aefe4f50999a5d828aaebfe7e8a583 (diff) | |
| download | buildstream-23edfe5d961136c2a22fd4c0939bb9dc0e9e3a14.tar.gz | |
doc/source/projectconf.rst: Document restrictions on option and option variable names.
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/projectconf.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/source/projectconf.rst b/doc/source/projectconf.rst index b356faeb7..d740bb0e3 100644 --- a/doc/source/projectconf.rst +++ b/doc/source/projectconf.rst @@ -298,6 +298,11 @@ Users can configure those options when invoking BuildStream with the $ bst --option debug True ... +.. note:: + + The name of the option may contain alphanumeric characters + underscores, and may not start with a leading digit. + Common Properties ~~~~~~~~~~~~~~~~~ @@ -321,6 +326,12 @@ All option types accept the following common attributes variable declared in ``project.conf``, and will be overridden in the regular :ref:`composition order <format_composition>`. + .. note:: + + The name of the variable to export may contain alphanumeric + characters, dashes, underscores, and may not start with a leading + digit. + Boolean ~~~~~~~ |