diff options
Diffstat (limited to 'src/buildstream/types.py')
| -rw-r--r-- | src/buildstream/types.py | 48 |
1 files changed, 47 insertions, 1 deletions
diff --git a/src/buildstream/types.py b/src/buildstream/types.py index 3b1f7a4db..48dd5de6d 100644 --- a/src/buildstream/types.py +++ b/src/buildstream/types.py @@ -100,6 +100,12 @@ class CoreWarnings: which is not whitelisted. See :ref:`Overlap Whitelist <public_overlap_whitelist>` """ + UNSTAGED_FILES = "unstaged-files" + """ + This warning will be produced when a file cannot be staged. This can happen when + a file overlaps with a directory in the sandbox that is not empty. + """ + REF_NOT_IN_TRACK = "ref-not-in-track" """ This warning will be produced when a source is configured with a reference @@ -114,11 +120,51 @@ class CoreWarnings: BAD_CHARACTERS_IN_NAME = "bad-characters-in-name" """ - This warning will be produces when filename for a target contains invalid + This warning will be produced when a filename for a target contains invalid characters in its name. """ +class OverlapAction(FastEnum): + """OverlapAction() + + Defines what action to take when files staged into the sandbox overlap. + + .. note:: + + This only dictates what happens when functions such as + :func:`Element.stage_artifact() <buildstream.element.Element.stage_artifact>` and + :func:`Element.stage_dependency_artifacts() <buildstream.element.Element.stage_dependency_artifacts>` + are called multiple times in an Element's :func:`Element.stage() <buildstream.element.Element.stage>` + implementation, and the files staged from one function call result in overlapping files staged + from previous invocations. + + If multiple staged elements overlap eachother within a single call to + :func:`Element.stage_dependency_artifacts() <buildstream.element.Element.stage_dependency_artifacts>`, + then the :ref:`overlap whitelist <public_overlap_whitelist>` will be ovserved, and warnings will + be issued for overlapping files, which will be fatal warnings if + :attr:`CoreWarnings.OVERLAPS <buildstream.types.CoreWarnings.OVERLAPS>` is specified + as a :ref:`fatal warning <configurable_warnings>`. + """ + + ERROR = "error" + """ + It is an error to overlap previously staged files + """ + + WARNING = "warning" + """ + A warning will be issued for previously staged files, which will fatal if + :attr:`CoreWarnings.OVERLAPS <buildstream.types.CoreWarnings.OVERLAPS>` is specified + as a :ref:`fatal warning <configurable_warnings>` in the project. + """ + + IGNORE = "ignore" + """ + Overlapping files are acceptable, and do not cause any warning or error. + """ + + # _Scope(): # # Defines the scope of dependencies to include for a given element |