The source format chapter was missing details about the characters that are valid for labels and what labels are for. Add a paragraph to cover those details. Signed-off-by: Grant Likely <grant.likely@xxxxxxx> --- source/source-language.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) mode change 100644 => 100755 source/source-language.rst diff --git a/source/source-language.rst b/source/source-language.rst old mode 100644 new mode 100755 index cefbbd8..c17aab0 --- a/source/source-language.rst +++ b/source/source-language.rst @@ -22,6 +22,33 @@ additional files. /include/ "FILE" +Labels +------ +The source format support attaching labels to any node or property data in the device tree. +Phandle and path references can be automatically generated by referencing the label instead of +explicitly specifying the phandle value or the full path to a node. +Labels are only used in the devicetree source format and are not encoded into the binary format. + +A label shall be between 1 to 31 characters in length, +be composed only of the characters in the set :numref:`label-characters`, +and must not start with a number. + +Labels are created by appending a colon (':') to the label name. +References are created by adding an ampersand ('&') suffix to the label name. + +.. tabularcolumns:: | c p{8cm} | +.. _label-characters: +.. table:: Valid characters for DTS labels + + ========= ================ + Character Description + ========= ================ + ``0-9`` digit + ``a-z`` lowercase letter + ``A-Z`` uppercase letter + ``_`` underscore + ========= ================ + Node and property definitions ----------------------------- -- 2.11.0 -- To unsubscribe from this list: send the line "unsubscribe devicetree-spec" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html