Fix #438, add three PDI deactivation option through CMake #543
Conversation
… on forward declaration of Paraconf
…ointing toward FindPDI.cmake
…: without paraconf
JAuriac
requested review from
jbigot,
benoitmartin88,
Yushan-Wang and
jmorice91
|
Warning you're updating the tutorial. This is unrelated |
| Use a `CMakeLists.txt` similar to `no-pdi_exampleTargetCMakeLists_findpackage.txt` for your target, | ||
| then use the following: | ||
| ```bash | ||
| cmake . -DCMAKE_MODULE_PATH="/<full>/<path>/<to>/pdi/no-pdi/cmake" |
There was a problem hiding this comment.
| cmake . -DCMAKE_MODULE_PATH="/<full>/<path>/<to>/pdi/no-pdi/cmake" | |
| cmake . -PDI_ROOT="/<full>/<path>/<to>/pdi/no-pdi/cmake" |
When switching from FindPDI to PDIConfig
There was a problem hiding this comment.
This method implies modifying the user target CMakeLists, using :
include(${PDI_ROOT}/PDIConfig.cmake)
instead of :
find_package(PDI 1.0.0 REQUIRED COMPONENTS C)
pdi/docs/Using_PDI.md
Outdated
| cmake . -DCMAKE_MODULE_PATH="/<full>/<path>/<to>/pdi/no-pdi/cmake" | ||
| ``` | ||
|
|
||
| Alternatively, you can use the `include`/`target_include_directories` method, |
There was a problem hiding this comment.
| Alternatively, you can use the `include`/`target_include_directories` method, | |
| Alternatively, you can use the `add_subdirectory` method, |
There was a problem hiding this comment.
The example file does not have the text add_subdirectory but include.
pdi/docs/Using_PDI.md
Outdated
|
|
||
| Alternatively, you can use the `include`/`target_include_directories` method, | ||
| which does not require to pass an additional argument at compilation | ||
| but requires to add ad option to the target `CMakeLists.txt`, |
There was a problem hiding this comment.
| but requires to add ad option to the target `CMakeLists.txt`, | |
| but requires to slightly modify your `CMakeLists.txt`, |
There was a problem hiding this comment.
Less precise. Needs to indicate the part of file which is concerned by the change. Edited for typo.
no-pdi/include/pdi.h
Outdated
| */ | ||
| static inline const char* PDI_errmsg(void) | ||
| { | ||
| return 0; |
There was a problem hiding this comment.
If the result of the function is passed to printf, a null pointer will make it crash
no-pdi/CMakeLists.txt
Outdated
| set(CMAKE_PREFIX_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") | ||
|
|
||
| # Find the PDI package | ||
| find_package(PDI REQUIRED) |
There was a problem hiding this comment.
or just include() it, it will be simpler
There was a problem hiding this comment.
It is possible to change toward include(cmake/PDIConfig.cmake) in this case, but to a target application's CMakeLists, an additional argument will be needed such as include(${PDI_ROOT}/PDIConfig.cmake), where previously find_package was used.
| /** \addtogroup error | ||
| * \{ | ||
| */ |
There was a problem hiding this comment.
The Doxygen group, the same as pdi/include/pdi.h
| static const PDI_errhandler_t PDI_NULL_HANDLER = {NULL, NULL}; | ||
|
|
||
| /** Prints the error message and aborts if the status is invalid | ||
| */ | ||
| static const PDI_errhandler_t PDI_ASSERT_HANDLER = PDI_NULL_HANDLER; | ||
|
|
||
| /** Prints the error message and continue if the status is invalid | ||
| */ | ||
| static const PDI_errhandler_t PDI_WARN_HANDLER = PDI_NULL_HANDLER; |
There was a problem hiding this comment.
These are the default handlers right ? If this is the case, I don't think the values should be NULL as it cause a segfault. Is this tested ?
tests/add_all_tests.sh
Outdated
There was a problem hiding this comment.
I don't think we need to separate the pdi and no-pdi tests. This can be done inside the cmakelists.txt.
Missing the case where paraconf is missing.
List of things to check before making a PR
Before merging your code, please check the following:
.clang-format;Fix #issuekeyword to autoclose the issue when merged.