diff options
author | Tristan van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-06-07 15:54:36 +0900 |
---|---|---|
committer | Tristan van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-06-08 23:55:20 +0900 |
commit | 34c5ce34c11880a37fe7e7f848018036fd46f98f (patch) | |
tree | d7694775ed9710f5355c1acb6827e89b5f8d6b3d /tests/format | |
parent | bcb03590e0cc787b48c92a541e2573c5586e8185 (diff) | |
download | buildstream-34c5ce34c11880a37fe7e7f848018036fd46f98f.tar.gz |
docs: Updating documentation regarding element names and addressing.
This commit does the following:
* Move the section about rules on element naming to the beginning
of the document instead of the end.
Element names are probably the first thing you need to know about
elements, not the last.
* Expand this element naming section to also speak about element
addressing, and how to express element paths and how these
can be used across the boundaries of multiple junctions.
It helps to have a single place to discuss this and link to
in the documentation, instead of repetitively explaining in
multiple places that one must specify a filename relative
to a project's element path.
* Update documentation about dependencies to refer to the
element naming and addressing documentation.
* Update the documentation in the `link` and `junction`
elements to link back to the element name documentation.
Diffstat (limited to 'tests/format')
0 files changed, 0 insertions, 0 deletions