diff options
author | Chandan Singh <csingh43@bloomberg.net> | 2018-12-30 21:35:17 +0000 |
---|---|---|
committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-12-31 19:54:25 +0000 |
commit | ce9e9c2dbec71841d5ac5311f6d18ffb78bce9d3 (patch) | |
tree | 1e818daf5ce2e113ff0f23da540c94fe7ffe4301 /doc | |
parent | 4b2992c1a33f39cff4c0d77cf7d20ca107215059 (diff) | |
download | buildstream-ce9e9c2dbec71841d5ac5311f6d18ffb78bce9d3.tar.gz |
doc: Add note about valid element names
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/format_declaring.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst index 57ea4488a..714e1fa33 100644 --- a/doc/source/format_declaring.rst +++ b/doc/source/format_declaring.rst @@ -526,3 +526,27 @@ read-only variables are also dynamically declared by BuildStream: build, support for this is conditional on the element type and the build system used (any element using 'make' can implement this). + + +Naming elements +--------------- +When naming the element files, use the following rules: + +* The name of the file must have ``.bst`` extension. + +* All characters in the name must be printable 7-bit ASCII characters. + +* Following characters are reserved and must not be part of the name: + + - ``<`` (less than) + - ``>`` (greater than) + - ``:`` (colon) + - ``"`` (double quote) + - ``/`` (forward slash) + - ``\`` (backslash) + - ``|`` (vertical bar) + - ``?`` (question mark) + - ``*`` (asterisk) + +BuildStream will attempt to raise warnings when any of these rules are violated +but that may not always be possible. |