diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-04-25 23:32:47 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-04-25 23:32:47 +0900 |
| commit | 52da8751462d4d574482f7b56af13d2b97fffb8b (patch) | |
| tree | c7d363e85f2dbcf5a1ea944cc331f17dbe1af377 | |
| parent | 719a3fc3ee15513a790290d009ace5d3ec7bcd17 (diff) | |
| download | buildstream-tristan/separate-junction-refs.tar.gz | |
doc: Clarify that junction sources are stored separately from project.refstristan/separate-junction-refs
| -rw-r--r-- | doc/source/projectconf.rst | 3 | ||||
| -rw-r--r-- | doc/source/projectrefs.rst | 3 |
2 files changed, 5 insertions, 1 deletions
diff --git a/doc/source/projectconf.rst b/doc/source/projectconf.rst index 4fe38bcc6..3fbf8e4af 100644 --- a/doc/source/projectconf.rst +++ b/doc/source/projectconf.rst @@ -111,7 +111,8 @@ allowed to be configured with the following values: * ``project.refs`` - Source references are stored in the ``project.refs`` file. + Source references are stored in the ``project.refs`` file, and + junction source references are stored in the ``junction.refs`` file. To enable storing of source references in ``project.refs``, add the following to your ``project.conf``: diff --git a/doc/source/projectrefs.rst b/doc/source/projectrefs.rst index 94bf4c718..799b5e761 100644 --- a/doc/source/projectrefs.rst +++ b/doc/source/projectrefs.rst @@ -9,6 +9,9 @@ file, then it will be stored at the toplevel of your project directory adjacent to ``project.conf``. This can be configured in your project using the :ref:`ref-storage configuration <project_format_ref_storage>` +Sources for :mod:`junction <elements.junction>` elements are stored +separately in an adjacent ``junction.refs`` file of the same format. + .. _projectrefs_basics: |