[GitHub] [buildstream] juergbi commented on a change in pull request #1519: WIP: Add `project-root` and `toplevel-root` variables

[GitBox <gi...@apache.org>]

juergbi commented on a change in pull request #1519:
URL: https://github.com/apache/buildstream/pull/1519#discussion_r716460842



##########
File path: doc/source/format_declaring.rst
##########
@@ -652,6 +652,39 @@ read-only variables are also dynamically declared by BuildStream:
 
   The name of project where BuildStream is being used.
 
+* ``project-root``
+
+  The directory where the project is located on the host.
+
+  This variable is only available when declaring
+  :ref:`source alias values <project_source_aliases>` or
+  :ref:`source mirror values <project_essentials_mirrors>` and allows
+  specification of ``file://`` URIs to access files in a project
+  relative location on the build host.
+
+  .. tip::
+
+     Use this variable to declare :ref:`source alias values <project_source_aliases>`
+     to refer to files which you store as a part of your project, e.g. tarballs
+     which you have committed to you BuildStream project.
+
+* ``project-root``

Review comment:
       ```suggestion
   * ``toplevel-root``
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org