]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation and build system for parameter_gui removal
authorMatthias Maier <tamiko@43-1.org>
Wed, 6 Jul 2016 20:39:14 +0000 (15:39 -0500)
committerMatthias Maier <tamiko@43-1.org>
Mon, 11 Jul 2016 13:05:19 +0000 (08:05 -0500)
12 files changed:
CMakeLists.txt
cmake/setup_cached_variables.cmake
cmake/setup_custom_targets.cmake
contrib/CMakeLists.txt [deleted file]
contrib/README.md [deleted file]
doc/doxygen/CMakeLists.txt
doc/doxygen/images/parameter_gui.png [deleted file]
doc/readme.html
doc/users/cmake.html
doc/users/config.sample
include/deal.II/base/parameter_handler.h
tests/run_testsuite.cmake

index b425ee1f488c430e264a4ee863d77af5396014b7..478691aa156d6f839268410a08a89388af7fa70b 100644 (file)
@@ -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)
index f9211584a6d89da4f3337601e400555e11487d2a..28881b719981ae7ab29aa344f004d398aecf6792 100644 (file)
@@ -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()
index ceeb425566f2e011acdf3d619e1aacba6b45c6a9..e3e4f0b503a59e6dc187d43029650fd78786ffca 100644 (file)
@@ -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 (file)
index 1a5aae3..0000000
+++ /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 (file)
index 2298b2e..0000000
+++ /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.
index e47f14e9df52bdac5fe147a79a8faee49d95f574..de718fc5a4e7182e88cdda48391b43896b567d6f 100644 (file)
@@ -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 (file)
index 204eab6..0000000
Binary files a/doc/doxygen/images/parameter_gui.png and /dev/null differ
index f8d3e0b19f869df24ccb709028d1c7aaa7df3c36..128ac71e445e82e9be34a98dfe7c579e0241477c 100644 (file)
@@ -6,7 +6,7 @@
     <title>The deal.II Readme</title>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
     <link href="screen.css" rel="StyleSheet"/>
-    <meta name="copyright" content="Copyright (C) 1998 - 2015 by the deal.II Authors"/>
+    <meta name="copyright" content="Copyright (C) 1998 - 2016 by the deal.II Authors"/>
     <meta name="keywords" content="deal.II"/>
   </head>
 
        </p>
       </li>
 
-      <li>
-        <p>
-          <i>parameter_gui</i>: If you wish to compile and install the
-          <code>parameter_gui</code> tool discussed in the documentation
-         of the <code>ParameterHandler</code> class, specify
-          <code>-DDEAL_II_COMPONENT_PARAMETER_GUI=ON</code>. Beware of the
-          fact that <code>parameter_gui</code> needs development packages for Qt.
-       </p>
-      </li>
-
       <li>
   <p>
     <i>64bit indices</i>: By default, deal.II use unsigned int (32bit)
index 43af69f0474829410b45d35c15280cab9856da1f..a34092a9960692ba17d3a9857fcd521ed818a51f 100644 (file)
@@ -184,9 +184,9 @@ cmake -DDEAL_II_WITH_MPI=ON &lt;...&gt;
 </pre>
       The same holds for all variables starting with <code>COMPONENT_</code>
       and all individual component names:
-      <code>DOCUMENTATION</code>, <code>EXAMPLES</code>
-      and <code>PARAMETER_GUI</code> (which will be expanded to the 
-      full <code>DEAL_II_COMPONENT_*</code> variable name).
+      <code>DOCUMENTATION</code>, and <code>EXAMPLES</code>
+      (which will be expanded to the full <code>DEAL_II_COMPONENT_*</code>
+      variable name).
     </p>
 
 
@@ -225,7 +225,6 @@ cmake -DDEAL_II_WITH_MPI=ON &lt;...&gt;
 #    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 &lt;...&gt;
 #  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
 </pre>
 
 
@@ -752,19 +749,6 @@ cmake -DLAPACK_FOUND=true \
             not generate the documentation for the tutorial steps).
             This adds a component <code>examples</code> to the build system.
           </p>
-
-       <li>
-          <p>
-            <code>DEAL_II_COMPONENT_PARAMETER_GUI</code> (default
-            <code>OFF</code>):
-          </p>
-          <p>
-            Enable configuration and installation of the
-            <code>parameter_gui</code> binary. This adds a component
-            <code>parameter_gui</code> to the build system. Beware of the
-            fact that this component needs development packages for Qt.
-         </p>
-
       </ul>
     </p>
 
index cbb65f38b24ed0de7d6079128791b3bae02dfb9b..747b6586b5d3f1ae55f597ed3eb9d39d61827cf7 100644 (file)
 #   "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."
-#   )
-#
 
 
 #
index 42e9b04d6a7e649ed55f26f684b68c9c0895a80c..62a66099d6e080f3d2efb71203357dcdc0520d66 100644 (file)
@@ -1077,29 +1077,10 @@ namespace Patterns
  * <h3>Using the %ParameterHandler Graphical User Interface</h3>
  *
  * 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 <i>Representation
- * of Parameters</i> section. This file can then be loaded using the
- * executable for the GUI, which should be located in
- * <code>lib/bin/dealii_parameter_gui</code> of your deal.II installation,
- * assuming that you have a sufficiently recent version of the <a
- * href="http://qt.nokia.com/">Qt toolkit</a> installed.
- *
- * Once loaded, the GUI displays subsections and individual parameters in tree
- * form (see also the discussion in the <i>Representation of Parameters</i>
- * 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 <a href="https://github.com/dealii/parameter_gui>the parameter_gui
+ * github repository</a> for further details.
  *
  * <h3>Getting entry values out of a %ParameterHandler object</h3>
  *
index 2696df385e8349a9116072861b1e89542c051d4b..d31bd451c342fd3b769679aee86876bc94d66bb6 100644 (file)
@@ -1,6 +1,6 @@
 ## ---------------------------------------------------------------------
 ##
-## Copyright (C) 2013 - 2015 by the deal.II authors
+## Copyright (C) 2013 - 2016 by the deal.II authors
 ##
 ## This file is part of the deal.II library.
 ##
@@ -268,7 +268,7 @@ ENDIF()
 GET_CMAKE_PROPERTY(_variables VARIABLES)
 FOREACH(_var ${_variables})
   IF( _var MATCHES "^(TEST|DEAL_II|ALLOW|WITH|FORCE|COMPONENT)_" OR
-      _var MATCHES "^(DOCUMENTATION|EXAMPLES|PARAMETER_GUI)" OR
+      _var MATCHES "^(DOCUMENTATION|EXAMPLES)" OR
       _var MATCHES "^(ARPACK|BOOST|OPENCASCADE|MUPARSER|HDF5|METIS|MPI)_" OR
       _var MATCHES "^(NETCDF|P4EST|PETSC|SLEPC|THREADS|TBB|TRILINOS)_" OR
       _var MATCHES "^(UMFPACK|ZLIB|LAPACK|MUPARSER)_" OR

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.