Commit df06e0b8 authored by Utkarsh Ayachit's avatar Utkarsh Ayachit
Browse files

rename "essentials" to "editions"

parent 86789c7b
......@@ -39,27 +39,27 @@ cmake_dependent_option(PARAVIEW_BUILD_VTK_TESTING "Enable VTK testing" OFF
"PARAVIEW_BUILD_TESTING" OFF)
option(PARAVIEW_BUILD_DEVELOPER_DOCUMENTATION "Generate ParaView C++/Python docs" "${doc_default}")
set(PARAVIEW_BUILD_ESSENTIALS "CANONICAL"
set(PARAVIEW_BUILD_EDITION "CANONICAL"
CACHE STRING "Enable ParaView components essential for requested capabilities.")
set_property(CACHE PARAVIEW_BUILD_ESSENTIALS
set_property(CACHE PARAVIEW_BUILD_EDITION
PROPERTY
STRINGS "CORE;RENDERING;CANONICAL")
if (PARAVIEW_BUILD_ESSENTIALS STREQUAL "CORE")
if (PARAVIEW_BUILD_EDITION STREQUAL "CORE")
set(VTK_GROUP_ENABLE_PARAVIEW_CORE "YES" CACHE INTERNAL "")
set(VTK_GROUP_ENABLE_PARAVIEW_RENDERING "NO" CACHE INTERNAL "")
set(VTK_GROUP_ENABLE_PARAVIEW_CANONICAL "NO" CACHE INTERNAL "")
set(PARAVIEW_BUILD_CORE ON)
set(PARAVIEW_BUILD_RENDERING OFF)
set(PARAVIEW_BUILD_CANONICAL OFF)
elseif (PARAVIEW_BUILD_ESSENTIALS STREQUAL "RENDERING")
elseif (PARAVIEW_BUILD_EDITION STREQUAL "RENDERING")
set(VTK_GROUP_ENABLE_PARAVIEW_CORE "YES" CACHE INTERNAL "")
set(VTK_GROUP_ENABLE_PARAVIEW_RENDERING "YES" CACHE INTERNAL "")
set(VTK_GROUP_ENABLE_PARAVIEW_CANONICAL "NO" CACHE INTERNAL "")
set(PARAVIEW_BUILD_CORE ON)
set(PARAVIEW_BUILD_RENDERING ON)
set(PARAVIEW_BUILD_CANONICAL OFF)
elseif (PARAVIEW_BUILD_ESSENTIALS STREQUAL "CANONICAL")
elseif (PARAVIEW_BUILD_EDITION STREQUAL "CANONICAL")
set(VTK_GROUP_ENABLE_PARAVIEW_CORE "YES" CACHE INTERNAL "")
set(VTK_GROUP_ENABLE_PARAVIEW_RENDERING "YES" CACHE INTERNAL "")
set(VTK_GROUP_ENABLE_PARAVIEW_CANONICAL "YES" CACHE INTERNAL "")
......@@ -129,7 +129,7 @@ if (PARAVIEW_USE_PYTHON AND WIN32)
set(paraview_web_default "${have_pywin32}")
endif ()
if (NOT PARAVIEW_BUILD_ESSENTIALS STREQUAL "CANONICAL")
if (NOT PARAVIEW_BUILD_EDITION STREQUAL "CANONICAL")
set(paraview_web_default OFF)
endif()
cmake_dependent_option(PARAVIEW_ENABLE_WEB "Enable/Disable web support" "${paraview_web_default}"
......@@ -169,10 +169,10 @@ cmake_dependent_option(PARAVIEW_ENABLE_COSMOTOOLS
"Build ParaView with CosmoTools VTK Extensions" OFF
"UNIX;PARAVIEW_USE_MPI" OFF)
# PARAVIEW_ENABLE_EXPORTERS option is shown only when PARAVIEW_BUILD_ESSENTIALS is set to RENDERING.
# If PARAVIEW_BUILD_ESSENTIALS is set to CORE, the ParaView::RemotingExport module's CONDITION
# PARAVIEW_ENABLE_EXPORTERS option is shown only when PARAVIEW_BUILD_EDITION is set to RENDERING.
# If PARAVIEW_BUILD_EDITION is set to CORE, the ParaView::RemotingExport module's CONDITION
# ensures that the module is not built nor is the option available.
# If PARAVIEW_BUILD_ESSENTIALS is set to CANONICAL, the option is not shown but is assumed ON and
# If PARAVIEW_BUILD_EDITION is set to CANONICAL, the option is not shown but is assumed ON and
# ParaView::RemotingExport module's CONDITION succeeds, thus enabling the module.
cmake_dependent_option(PARAVIEW_ENABLE_EXPORTERS
"Enable view exporters." OFF
......
......@@ -291,7 +291,7 @@ The common variables to modify include:
Less common, but variables which may be of interest to some:
* `PARAVIEW_BUILD_ESSENTIALS` (default `CANONICAL`): Choose which features to
* `PARAVIEW_BUILD_EDITION` (default `CANONICAL`): Choose which features to
enable in this build. This is useful to generate ParaView builds with
limited features. More on this later.
* `PARAVIEW_BUILD_EXAMPLES` (default `OFF`): If set, ParaView's example code
......@@ -445,12 +445,12 @@ These variables should be documented once they're effective again.
ParaView's example Catalyst adaptors will be added as tests to the ParaView
test suite.
-->
## Building essentials
## Building editions
A typical ParaView build includes several modules and dependencies. While these
are necessary for a fully functional application, there are cases (e.g. in situ
use-cases) where a built with limited set of features is adequate. ParaView build supports
this using the `PARAVIEW_BUILD_ESSENTIALS` setting. Supported values for this setting are:
use-cases) where a build with limited set of features is adequate. ParaView build supports
this using the `PARAVIEW_BUILD_EDITION` setting. Supported values for this setting are:
* `CORE`: Build modules necessary for core ParaView functionality.
This does not include rendering.
......
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