diff options
| author | Chandan Singh <csingh43@bloomberg.net> | 2018-12-30 21:35:17 +0000 |
|---|---|---|
| committer | Chandan Singh <csingh43@bloomberg.net> | 2019-01-03 00:32:45 +0000 |
| commit | 142fafbff70dd32dc3d03a767f7acd752bcf52e9 (patch) | |
| tree | f59008d1493cc91dd214f413b1856bff523ffb86 | |
| parent | 3295f9b5209fb6fd6e96029609f5e6adcd67dd8a (diff) | |
| download | buildstream-142fafbff70dd32dc3d03a767f7acd752bcf52e9.tar.gz | |
doc: Add note about valid element names
| -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. |