Skip to content

doc/source/format_project.rst: Clarifying behavior of project.refs regarding subprojects #1659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtristan merged 1 commit into from
Jun 13, 2022
Merged

doc/source/format_project.rst: Clarifying behavior of project.refs regarding subprojects #1659

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/source/format_project.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,20 @@ following to your ``project.conf``:

ref-storage: project.refs

.. attention::

**Storing subproject source references in project.refs**

When using the ``project.refs`` file, it is possible to override the
references in subprojects by editing the ``project.refs`` file directly
or by using :ref:`bst source track --cross-junctions <invoking_source_track>`,
this can be practical to try out fresher versions of components which
are maintained in a subproject.

It should be noted however that overridden subproject source references listed
in your ``project.refs`` file will be ignored by projects which use your project
as a subproject.


.. _configurable_warnings:

Expand Down