]> SALOME platform Git repositories - tools/documentation.git/commitdiff
Salome HOME
CMake: reverting to the previous behaviour for optional prerequisites.
authorbruneton <bruneton>
Tue, 17 Sep 2013 10:08:20 +0000 (10:08 +0000)
committerbruneton <bruneton>
Tue, 17 Sep 2013 10:08:20 +0000 (10:08 +0000)
If not found, we trigger the failure of the configuration. This is handled
by macros SALOME_PACKAGE_REPORT_AND_CHECK
and SALOME_LOG_OPTIONAL_PACKAGE, allowing a nice error message which indicates
what flag should be switched off to avoid the issue.

dev/cmake/source/pkg.rst

index dde67b5017dabe680a39ada07cbaabbb74b6c6cf..31c91d3cbdb85a41aa1014a3d79c024229dd6e88 100644 (file)
@@ -73,9 +73,13 @@ All prerequisite detection in SALOME should be implemented by:
 * potentially, a prerequisite might be optional. In this case the following syntax is preferred::
   
     FIND_PACKAGE(SalomeLibXml2)
-    SALOME_UPDATE_FLAG_AND_LOG_PACKAGE(LibXml2 SALOME_FOO_FEATURE)
+    SALOME_LOG_OPTIONAL_PACKAGE(LibXml2 SALOME_FOO_FEATURE)
+    
+
+* the custom macro SALOME_LOG_OPTIONAL_PACKAGE registers internally the fact that the package is optional, and the flag that can be changed to avoid its detection. The final status of what has been found or not can then be displayed by calling SALOME_PACKAGE_REPORT_AND_CHECK(). This will trigger the failure of the configuration process if some package is missing, and it will also display the flag that should be turned OFF to avoid the issue::
 
-* the custom macro SALOME_UPDATE_FLAG_AND_LOG_PACKAGE takes care of switching OFF the flag SALOME_FOO_FEATURE if the package was not found. The final status of what has been found or not can then be displayed by calling SALOME_PACKAGE_REPORT().
+    # Final report and global check of optional prerequisites:
+    SALOME_PACKAGE_REPORT_AND_CHECK()
 
 Typically the FindSalome<Xyz>.cmake file looks like this::