diff options
author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-02-21 20:06:12 +0900 |
---|---|---|
committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-02-21 22:28:54 +0900 |
commit | 3d94bd25ddb74ab05a4c9f4785c7f3d8441df23f (patch) | |
tree | 8eee84a80ad023884774ab41314cf4172a942e7d | |
parent | 2e6566e2bf7a5a06a4eb01256dd03d57ea59f6dd (diff) | |
download | buildstream-3d94bd25ddb74ab05a4c9f4785c7f3d8441df23f.tar.gz |
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.
-rw-r--r-- | doc/source/projectconf.rst | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/doc/source/projectconf.rst b/doc/source/projectconf.rst index de19c9e84..1faaf88fa 100644 --- a/doc/source/projectconf.rst +++ b/doc/source/projectconf.rst @@ -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: |