Skip to content
Snippets Groups Projects
Commit 3d94bd25 authored by Tristan Van Berkom's avatar Tristan Van Berkom
Browse files

doc/source/projectconf.rst: Moving docs for `fail-on-overlaps`

This is not a part of the documentation on how external plugins
are loaded and referenced; lets put it in the main general section
instead.
parent 2e6566e2
No related branches found
No related tags found
No related merge requests found
Pipeline #
......@@ -105,6 +105,25 @@ with an artifact share.
You can also specify a list of caches here; earlier entries in the list
will have higher priority than later ones.
Fail on Overlaps
~~~~~~~~~~~~~~~~
When multiple elements are staged, there's a possibility that different
elements will try and stage different versions of the same file.
When ``fail-on-overlap`` is true, if an overlap is detected
that hasn't been allowed by the element's
:ref:`overlap whitelist<public_overlap_whitelist>`,
then an error will be raised and the build will fail.
otherwise, a warning will be raised indicating which files had overlaps,
and the order that the elements were overlapped.
.. code:: yaml
fail-on-overlap: true
.. _project_plugins:
External Plugins
......@@ -190,23 +209,6 @@ system.
elements:
potato: 0
Fail on Overlaps
~~~~~~~~~~~~~~~~
When multiple elements are staged, there's a possibility that different
elements will try and stage different versions of the same file.
When ``fail-on-overlap`` is true, if an overlap is detected
that hasn't been allowed by the element's
:ref:`overlap whitelist<public_overlap_whitelist>`,
then an error will be raised and the build will fail.
otherwise, a warning will be raised indicating which files had overlaps,
and the order that the elements were overlapped.
.. code:: yaml
fail-on-overlap: true
.. _project_options:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment