From: Matthias Maier Date: Wed, 6 Jul 2016 20:39:14 +0000 (-0500) Subject: Update documentation and build system for parameter_gui removal X-Git-Tag: v8.5.0-rc1~879^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0b6c38929fcb7abd0490e6d529216516273a8d69;p=dealii.git Update documentation and build system for parameter_gui removal --- diff --git a/CMakeLists.txt b/CMakeLists.txt index b425ee1f48..478691aa15 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ ## --------------------------------------------------------------------- ## -## Copyright (C) 2012 - 2015 by the deal.II authors +## Copyright (C) 2012 - 2016 by the deal.II authors ## ## This file is part of the deal.II library. ## @@ -149,7 +149,6 @@ ENDIF() ADD_SUBDIRECTORY(source) # has to be included after bundled ADD_SUBDIRECTORY(cmake/config) # has to be included after source -ADD_SUBDIRECTORY(contrib) # has to be included after source ADD_SUBDIRECTORY(examples) IF(DEAL_II_HAVE_TESTS_DIRECTORY) diff --git a/cmake/setup_cached_variables.cmake b/cmake/setup_cached_variables.cmake index f9211584a6..28881b7199 100644 --- a/cmake/setup_cached_variables.cmake +++ b/cmake/setup_cached_variables.cmake @@ -24,7 +24,6 @@ # DEAL_II_ALLOW_BUNDLED # DEAL_II_COMPONENT_DOCUMENTATION # DEAL_II_COMPONENT_EXAMPLES -# DEAL_II_COMPONENT_PARAMETER_GUI # DEAL_II_COMPONENT_PACKAGE # DEAL_II_FORCE_AUTODETECTION # @@ -92,12 +91,6 @@ OPTION(DEAL_II_COMPONENT_PACKAGE ) LIST(APPEND DEAL_II_COMPONENTS PACKAGE) -OPTION(DEAL_II_COMPONENT_PARAMETER_GUI - "Build and install the parameter_gui. This adds a COMPONENT \"parameter_gui\" to the build system." - OFF - ) -LIST(APPEND DEAL_II_COMPONENTS PARAMETER_GUI) - OPTION(DEAL_II_ALLOW_AUTODETECTION "Allow to automatically set up features by setting all undefined DEAL_II_WITH_* variables to ON or OFF" ON @@ -390,7 +383,7 @@ FOREACH(_var ${_res}) # # Same for components: # - IF(_var MATCHES "^(DOCUMENTATION|EXAMPLES|PACKAGE|PARAMETER_GUI)") + IF(_var MATCHES "^(DOCUMENTATION|EXAMPLES|PACKAGE)") SET(DEAL_II_COMPONENT_${_var} ${${_var}} CACHE BOOL "" FORCE) UNSET(${_var} CACHE) ENDIF() diff --git a/cmake/setup_custom_targets.cmake b/cmake/setup_custom_targets.cmake index ceeb425566..e3e4f0b503 100644 --- a/cmake/setup_custom_targets.cmake +++ b/cmake/setup_custom_targets.cmake @@ -20,7 +20,6 @@ # compat_files # documentation # examples -# parameter_gui # @@ -54,7 +53,7 @@ ENDIF() # The library can always be compiled and/or installed unconditionally ;-) _add_custom_target(library) -FOREACH(_component compat_files documentation examples parameter_gui) +FOREACH(_component compat_files documentation examples) STRING(TOUPPER "${_component}" _component_uppercase) IF(DEAL_II_COMPONENT_${_component_uppercase}) _add_custom_target(${_component}) @@ -141,7 +140,6 @@ FILE(WRITE ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/print_info.cmake # documentation - ${_description_string} component 'documentation' # examples - ${_description_string} component 'examples' # library - ${_description_string} component 'library' -# parameter_gui - ${_description_string} component 'parameter_gui' # package - build binary package # # test - run a minimal set of tests @@ -156,7 +154,7 @@ FILE(WRITE ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/print_info.cmake # Provide "relocate" target to run install_name_tool on all external libraries # under ${DEAL_II_CPACK_EXTERNAL_LIBS_TREE} # -IF(CMAKE_SYSTEM_NAME MATCHES "Darwin" AND +IF(CMAKE_SYSTEM_NAME MATCHES "Darwin" AND NOT "${DEAL_II_CPACK_EXTERNAL_LIBS_TREE}" STREQUAL "") ADD_CUSTOM_TARGET(relocate WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} diff --git a/contrib/CMakeLists.txt b/contrib/CMakeLists.txt deleted file mode 100644 index 1a5aae3d4d..0000000000 --- a/contrib/CMakeLists.txt +++ /dev/null @@ -1,21 +0,0 @@ -## --------------------------------------------------------------------- -## -## Copyright (C) 2012 - 2015 by the deal.II authors -## -## This file is part of the deal.II library. -## -## The deal.II library is free software; you can use it, redistribute -## it, and/or modify it under the terms of the GNU Lesser General -## Public License as published by the Free Software Foundation; either -## version 2.1 of the License, or (at your option) any later version. -## The full text of the license can be found in the file LICENSE at -## the top level of the deal.II distribution. -## -## --------------------------------------------------------------------- - -IF(DEAL_II_COMPONENT_PARAMETER_GUI) - MESSAGE(STATUS "Setting up parameter_gui") - ADD_SUBDIRECTORY(parameter_gui) - MESSAGE(STATUS "Setting up parameter_gui - Done") -ENDIF() - diff --git a/contrib/README.md b/contrib/README.md deleted file mode 100644 index 2298b2e6de..0000000000 --- a/contrib/README.md +++ /dev/null @@ -1,21 +0,0 @@ -This folder contains contributions to the deal.II library -========================================================= - -**PLEASE NOTE THAT THESE PROJECTS MAY be COPYRIGHTED BY OTHERS THAN THE -deal.II AUTHORS, but are included by permission. For details, consult the -stated licenses below.** - - -parameter_gui -------------- - -Is a program written by Martin Steigemann and Wolfgang Bangerth and -licensed under the GNU Lesser General Public License (LGPL) Version 2.1 or -later. See `parameter_gui/README`, `parameter_gui/lgpl-2.1.txt`. - - -utilities ---------- - -A collection of small programs for various purposes. Distributed under the -same license as the deal.II library. diff --git a/doc/doxygen/CMakeLists.txt b/doc/doxygen/CMakeLists.txt index e47f14e9df..de718fc5a4 100644 --- a/doc/doxygen/CMakeLists.txt +++ b/doc/doxygen/CMakeLists.txt @@ -103,19 +103,15 @@ LIST(APPEND _doxygen_input ${CMAKE_BINARY_DIR}/include/ ${CMAKE_SOURCE_DIR}/doc/news/ ${CMAKE_CURRENT_BINARY_DIR}/tutorial/tutorial.h - ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/ ) # Add other directories in which to find images SET(_doxygen_image_path ${CMAKE_CURRENT_SOURCE_DIR}/images - ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/images ) file(GLOB _doxygen_depend ${CMAKE_CURRENT_SOURCE_DIR}/headers/*.h - ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/*.h - ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/main.cpp ${CMAKE_SOURCE_DIR}/doc/news/*.h ${CMAKE_SOURCE_DIR}/include/deal.II/**/*.h ) diff --git a/doc/doxygen/images/parameter_gui.png b/doc/doxygen/images/parameter_gui.png deleted file mode 100644 index 204eab69c3..0000000000 Binary files a/doc/doxygen/images/parameter_gui.png and /dev/null differ diff --git a/doc/readme.html b/doc/readme.html index f8d3e0b19f..128ac71e44 100644 --- a/doc/readme.html +++ b/doc/readme.html @@ -6,7 +6,7 @@ The deal.II Readme - + @@ -392,16 +392,6 @@

-
  • -

    - parameter_gui: If you wish to compile and install the - parameter_gui tool discussed in the documentation - of the ParameterHandler class, specify - -DDEAL_II_COMPONENT_PARAMETER_GUI=ON. Beware of the - fact that parameter_gui needs development packages for Qt. -

    -
  • -
  • 64bit indices: By default, deal.II use unsigned int (32bit) diff --git a/doc/users/cmake.html b/doc/users/cmake.html index 43af69f047..a34092a996 100644 --- a/doc/users/cmake.html +++ b/doc/users/cmake.html @@ -184,9 +184,9 @@ cmake -DDEAL_II_WITH_MPI=ON <...> The same holds for all variables starting with COMPONENT_ and all individual component names: - DOCUMENTATION, EXAMPLES - and PARAMETER_GUI (which will be expanded to the - full DEAL_II_COMPONENT_* variable name). + DOCUMENTATION, and EXAMPLES + (which will be expanded to the full DEAL_II_COMPONENT_* + variable name).

    @@ -225,7 +225,6 @@ cmake -DDEAL_II_WITH_MPI=ON <...> # documentation - build and install component 'documentation' # examples - build and install component 'examples' # library - build and install component 'library' -# parameter_gui - build and install component 'parameter_gui' # package - build binary package # # test - run a minimal set of tests @@ -265,7 +264,6 @@ cmake -DDEAL_II_WITH_MPI=ON <...> # Component configuration: # ( DEAL_II_COMPONENT_DOCUMENTATION = OFF ) # DEAL_II_COMPONENT_EXAMPLES -# ( DEAL_II_COMPONENT_PARAMETER_GUI = OFF ) # # Detailed information (compiler flags, feature configuration) can be found in detailed.log # @@ -403,7 +401,6 @@ $ cmake -GNinja [...] documentation - builds and installs the 'documentation' component examples - builds and installs the 'examples' component library - builds and installs the 'library' component -parameter_gui - builds and installs the 'parameter_gui' component @@ -752,19 +749,6 @@ cmake -DLAPACK_FOUND=true \ not generate the documentation for the tutorial steps). This adds a component examples to the build system.

    - -
  • -

    - DEAL_II_COMPONENT_PARAMETER_GUI (default - OFF): -

    -

    - Enable configuration and installation of the - parameter_gui binary. This adds a component - parameter_gui to the build system. Beware of the - fact that this component needs development packages for Qt. -

    -

    diff --git a/doc/users/config.sample b/doc/users/config.sample index cbb65f38b2..747b6586b5 100644 --- a/doc/users/config.sample +++ b/doc/users/config.sample @@ -24,10 +24,6 @@ # "Enable configuration and installation of the example steps. This adds a COMPONENT \"examples\" to the build system." # ) # -# SET(DEAL_II_COMPONENT_PARAMETER_GUI OFF CACHE BOOL -# "Build and install the parameter_gui. This adds a COMPONENT \"parameter_gui\" to the build system." -# ) -# # diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index 42e9b04d6a..62a66099d6 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1077,29 +1077,10 @@ namespace Patterns *

    Using the %ParameterHandler Graphical User Interface

    * * An alternative to using the hand-written input files shown above is to use - * the graphical user interface (GUI) that accompanies this class. For this, - * you first need to write a description of all the parameters, their default - * values, patterns and documentation strings into a file in a format that the - * GUI can understand; this is done using the - * ParameterHandler::print_parameters() function with ParameterHandler::XML as - * second argument, as discussed in more detail below in the Representation - * of Parameters section. This file can then be loaded using the - * executable for the GUI, which should be located in - * lib/bin/dealii_parameter_gui of your deal.II installation, - * assuming that you have a sufficiently recent version of the Qt toolkit installed. - * - * Once loaded, the GUI displays subsections and individual parameters in tree - * form (see also the discussion in the Representation of Parameters - * section below). Here is a screen shot with some sub-sections expanded and - * one parameter selected for editing: - * - * @image html parameter_gui.png "Parameter GUI" - * - * Using the GUI, you can edit the values of individual parameters and save - * the result in the same format as before. It can then be read in using the - * ParameterHandler::read_input_from_xml() function. + * the graphical user interface (GUI) that accompanies this class. * + * See