zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Conflict Msg Pkg Guide (#16201)

Browse Source 
Document the nice `msg=` argument in conflicts. Super useful
for less generic conflict guidance.
This commit is contained in:
Axel Huebl 2020-04-21 14:22:30 -07:00 committed by GitHub
parent 272c47207d
commit ca4c0b97ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/spack/docs/packaging_guide.rst
View File

@ -2169,13 +2169,17 @@ Adding the following to a package:
.. code-block:: python
conflicts('%intel', when='@1.2')
conflicts('%intel', when='@:1.2',
msg='<myNicePackage> <= v1.2 cannot be built with Intel ICC, '
'please use a newer release.')
we express the fact that the current package *cannot be built* with the Intel
compiler when we are trying to install version "1.2". The ``when`` argument can
be omitted, in which case the conflict will always be active.
compiler when we are trying to install a version "<=1.2". The ``when`` argument
can be omitted, in which case the conflict will always be active.
Conflicts are always evaluated after the concretization step has been performed,
and if any match is found a detailed error message is shown to the user.
You can add an additional message via the ``msg=`` parameter to a conflict that
provideds more specific instructions for users.
.. _packaging_extensions: