Commit b0c11a45 authored by Ben Boeckel's avatar Ben Boeckel
Browse files

ParaViewPluginDebugging: expose options to debug plugins

Sometimes why plugins are not available is not obvious, so these flags
are offered to assist in figuring out such problems.
parent 887f335a
Pipeline #234756 waiting for manual action with stages
option(ParaView_DEBUG_PLUGINS "Debug plugin logic in ParaView" OFF)
mark_as_advanced(ParaView_DEBUG_PLUGINS)
set(_paraview_plugin_log)
include(CMakeDependentOption)
cmake_dependent_option(ParaView_DEBUG_PLUGINS_ALL "Enable all debugging" OFF
"ParaView_DEBUG_PLUGINS" OFF)
mark_as_advanced(ParaView_DEBUG_PLUGINS_ALL)
if (ParaView_DEBUG_PLUGINS_ALL)
set(_paraview_plugin_log "ALL")
else ()
set(_builtin_domains
building
plugin)
foreach (_domain IN LISTS _builtin_domains _debug_domains)
cmake_dependent_option("ParaView_DEBUG_PLUGINS_${_domain}" "Enable debugging of ${_domain} logic" OFF
"ParaView_DEBUG_PLUGINS" OFF)
mark_as_advanced("ParaView_DEBUG_PLUGINS_${_domain}")
if (ParaView_DEBUG_PLUGINS_${_domain})
list(APPEND _paraview_plugin_log
"${_domain}")
endif ()
endforeach ()
unset(_domain)
unset(_builtin_domains)
endif ()
......@@ -85,6 +85,7 @@ include(ParaViewServerManager)
include(ParaViewTesting)
include(ParaViewClient)
include(ParaViewPlugin)
include(ParaViewPluginDebugging)
include(vtkModuleWrapClientServer)
include(CTest)
set_property(CACHE BUILD_TESTING
......
......@@ -515,6 +515,19 @@ following flags:
* `ParaView_DEBUG_MODULE_testing` (default `OFF`): Log testing for VTK
modules.
### ParaView Plugins
ParaView's plugin system has a similar setup:
* `ParaView_DEBUG_PLUGINS` (default `OFF`): If enabled, debugging is enabled.
Specific portions of the plugin system may be debugged using the other
flags.
* `ParaView_DEBUG_PLUGINS_ALL` (default `OFF`): Enable all debugging messages.
* `ParaView_DEBUG_PLUGINS_building` (default `OFF`): Log when plugins are
being built.
* `ParaView_DEBUG_PLUGINS_plugin` (default `OFF`): Log information about
discovered plugins.
### Building documentation
The following targets are used to build documentation for ParaView:
......
# ParaView Plugin debugging
New CMake options to debug plugin discovery and building has been added. The
`ParaView_DEBUG_PLUGINS`, `ParaView_DEBUG_PLUGINS_ALL`,
`ParaView_DEBUG_PLUGINS_building`, and `ParaView_DEBUG_PLUGINS_plugin` flags
may be used to enable various logging for plugins.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment