[svn-r30314] HDFFV-9971: Change the usage of a CMake variable for the build type to the recommended variable name. Updated documentation.

10 files changed, 55 insertions, 44 deletions

diff --git a/config/cmake/HDF518_Examples.cmake.in b/config/cmake/HDF518_Examples.cmake.in
index 135dcfc..561bdb7 100644
--- a/config/cmake/HDF518_Examples.cmake.in
+++ b/config/cmake/HDF518_Examples.cmake.in
@@ -10,7 +10,7 @@ set(CTEST_DASHBOARD_ROOT ${CTEST_SCRIPT_DIRECTORY})
 
 # handle input parameters to script.
 #INSTALLDIR - HDF5-1.8 root folder
-#CTEST_BUILD_CONFIGURATION - Release, Debug, RelWithDebInfo
+#CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo
 #CTEST_SOURCE_NAME - name of source folder; HDF4Examples
 #STATIC_LIBRARIES - Default is YES
 #FORTRAN_LIBRARIES - Default is NO
@@ -29,8 +29,8 @@ endif()
 if(NOT DEFINED INSTALLDIR)
     set(INSTALLDIR "@CMAKE_INSTALL_PREFIX@")
 endif()
-if(NOT DEFINED CTEST_BUILD_CONFIGURATION)
-    set(CTEST_BUILD_CONFIGURATION "Release")
+if(NOT DEFINED CTEST_CONFIGURATION_TYPE)
+    set(CTEST_CONFIGURATION_TYPE "Release")
 endif()
 if(NOT DEFINED CTEST_SOURCE_NAME)
     set(CTEST_SOURCE_NAME "HDF5Examples")
@@ -143,7 +143,7 @@ if(NOT N EQUAL 0)
   set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N})
 endif()
 set (CTEST_CONFIGURE_COMMAND
-    "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_BUILD_CONFIGURATION} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""
+    "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_CONFIGURATION_TYPE} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""
 )
 
 #-----------------------------------------------------------------------------
diff --git a/config/cmake/HDF5_Examples.cmake.in b/config/cmake/HDF5_Examples.cmake.in
index 3dce88e..d7e2591 100644
--- a/config/cmake/HDF5_Examples.cmake.in
+++ b/config/cmake/HDF5_Examples.cmake.in
@@ -10,7 +10,7 @@ set(CTEST_DASHBOARD_ROOT ${CTEST_SCRIPT_DIRECTORY})
 
 # handle input parameters to script.
 #INSTALLDIR - HDF5 root folder
-#CTEST_BUILD_CONFIGURATION - Release, Debug, RelWithDebInfo
+#CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo
 #CTEST_SOURCE_NAME - name of source folder; HDF4Examples
 #STATIC_LIBRARIES - Default is YES
 #FORTRAN_LIBRARIES - Default is NO
@@ -30,8 +30,8 @@ endif()
 if(NOT DEFINED INSTALLDIR)
     set(INSTALLDIR "@CMAKE_INSTALL_PREFIX@")
 endif()
-if(NOT DEFINED CTEST_BUILD_CONFIGURATION)
-    set(CTEST_BUILD_CONFIGURATION "Release")
+if(NOT DEFINED CTEST_CONFIGURATION_TYPE)
+    set(CTEST_CONFIGURATION_TYPE "Release")
 endif()
 if(NOT DEFINED CTEST_SOURCE_NAME)
     set(CTEST_SOURCE_NAME "HDF5Examples")
@@ -154,7 +154,7 @@ if(NOT N EQUAL 0)
   set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N})
 endif()
 set (CTEST_CONFIGURE_COMMAND
-    "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_BUILD_CONFIGURATION} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""
+    "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_CONFIGURATION_TYPE} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""
 )
 
 #-----------------------------------------------------------------------------
diff --git a/config/cmake/README.txt.cmake.in b/config/cmake/README.txt.cmake.in
index 4c4ffd5..7ab3c35 100644
--- a/config/cmake/README.txt.cmake.in
+++ b/config/cmake/README.txt.cmake.in
@@ -40,7 +40,7 @@ To test the installation with the examples;
     The default installation folder is defined as "@CMAKE_INSTALL_PREFIX@".
         It can be changed with the INSTALLDIR script option.
     The default ctest configuration is defined as "Release". It can be changed
-        with the CTEST_BUILD_CONFIGURATION script option. Note that this must
+        with the CTEST_CONFIGURATION_TYPE script option. Note that this must
         be the same as the value used with the -C command line option.
     The default build configuration is defined to build and use static libraries.
         Shared libraries can be used with the STATICLIBRARIES script option set to "NO".
diff --git a/config/cmake/mccacheinit.cmake b/config/cmake/mccacheinit.cmake
index 48d4739..b605f58 100644
--- a/config/cmake/mccacheinit.cmake
+++ b/config/cmake/mccacheinit.cmake
@@ -75,7 +75,7 @@ set (SZIP_TGZ_NAME "SZip.tar.gz" CACHE STRING "Use SZip from compressed file" FO
 
 set (CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build Debug" FORCE)
 
-set (CTEST_BUILD_CONFIGURATION "Debug" CACHE STRING "Build Debug" FORCE)
+set (CTEST_CONFIGURATION_TYPE "Debug" CACHE STRING "Build Debug" FORCE)
 
 set (ZLIB_PACKAGE_NAME "zlib" CACHE STRING "Name of ZLIB package" FORCE)
 
diff --git a/config/cmake/scripts/CTestScript.cmake b/config/cmake/scripts/CTestScript.cmake
index 403eedd..8a08caa 100755
--- a/config/cmake/scripts/CTestScript.cmake
+++ b/config/cmake/scripts/CTestScript.cmake
@@ -208,14 +208,14 @@ else(USE_AUTOTOOLS)
   if(LOCAL_MEMCHECK_TEST)

     find_program(CTEST_MEMORYCHECK_COMMAND NAMES valgrind)

     set (CTEST_CONFIGURE_COMMAND

-        "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/mccacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_BUILD_CONFIGURATION} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""

+        "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/mccacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_CONFIGURATION_TYPE} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""

     )

   else()

     if(LOCAL_COVERAGE_TEST)

       find_program(CTEST_COVERAGE_COMMAND NAMES gcov)

     endif()

     set (CTEST_CONFIGURE_COMMAND

-        "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_BUILD_CONFIGURATION} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""

+        "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_CONFIGURATION_TYPE} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""

     )

   endif()

 endif()

@@ -231,7 +231,7 @@ foreach(v
     CTEST_SOURCE_DIRECTORY

     CTEST_BINARY_DIRECTORY

     CTEST_CMAKE_GENERATOR

-    CTEST_BUILD_CONFIGURATION

+    CTEST_CONFIGURATION_TYPE

     CTEST_GIT_COMMAND

     CTEST_CHECKOUT_COMMAND

     CTEST_CONFIGURE_COMMAND

@@ -294,7 +294,7 @@ message(STATUS "Dashboard script configuration:\n${vars}\n")
     ##-----------------------------------------------

     ## Package the product

     ##-----------------------------------------------

-    execute_process(COMMAND cpack -C ${CTEST_BUILD_CONFIGURATION} -V

+    execute_process(COMMAND cpack -C ${CTEST_CONFIGURATION_TYPE} -V

       WORKING_DIRECTORY ${CTEST_BINARY_DIRECTORY}

       RESULT_VARIABLE cpackResult

       OUTPUT_VARIABLE cpackLog

diff --git a/config/cmake/scripts/HDF5config.cmake b/config/cmake/scripts/HDF5config.cmake
index 4ab9650..672026f 100755
--- a/config/cmake/scripts/HDF5config.cmake
+++ b/config/cmake/scripts/HDF5config.cmake
@@ -19,7 +19,7 @@ cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR)
 #            VS201264 * Visual Studio 11 2012 Win64

 #

 #     INSTALLDIR  -  root folder where hdf5 is installed

-#     CTEST_BUILD_CONFIGURATION  - Release, Debug, etc

+#     CTEST_CONFIGURATION_TYPE  - Release, Debug, etc

 #     CTEST_SOURCE_NAME  -  source folder

 #     STATIC_LIBRARIES  -  Build/use static libraries

 #     FORTRAN_LIBRARIES -  Build/use fortran libraries

@@ -34,7 +34,7 @@ set(CTEST_SOURCE_VERSEXT "")
 # handle input parameters to script.

 #BUILD_GENERATOR - which CMake generator to use, required

 #INSTALLDIR - HDF5-1.10.0 root folder

-#CTEST_BUILD_CONFIGURATION - Release, Debug, RelWithDebInfo

+#CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo

 #CTEST_SOURCE_NAME - name of source folder; HDF5-1.10.0

 #STATIC_LIBRARIES - Default is YES

 #FORTRAN_LIBRARIES - Default is NO

@@ -82,8 +82,8 @@ if(NOT DEFINED INSTALLDIR)
     set(INSTALLDIR "/usr/local/myhdf5")

   endif()

 endif()

-if(NOT DEFINED CTEST_BUILD_CONFIGURATION)

-    set(CTEST_BUILD_CONFIGURATION "Release")

+if(NOT DEFINED CTEST_CONFIGURATION_TYPE)

+    set(CTEST_CONFIGURATION_TYPE "Release")

 endif()

 if(NOT DEFINED CTEST_SOURCE_NAME)

     set(CTEST_SOURCE_NAME "hdf5-${CTEST_SOURCE_VERSION}${CTEST_SOURCE_VERSEXT}")

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index b49b3a6..ee331a8 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -106,7 +106,7 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
       The -S option uses the script version of ctest.
 
       The value for the -C option (as shown above, "-C Release") must
-      match the setting for CTEST_BUILD_CONFIGURATION in the platform
+      match the setting for CTEST_CONFIGURATION_TYPE in the platform
       configuration file.
 
       The -VV option is for most verbose; use -V for less verbose.
@@ -675,7 +675,7 @@ cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR)
 #            VS201264 * Visual Studio 11 2012 Win64
 #
 #     INSTALLDIR  -  root folder where hdf5 is installed
-#     CTEST_BUILD_CONFIGURATION  - Release, Debug, etc
+#     CTEST_CONFIGURATION_TYPE  - Release, Debug, etc
 #     CTEST_SOURCE_NAME  -  source folder
 #     STATIC_LIBRARIES  -  Build/use static libraries
 #     FORTRAN_LIBRARIES -  Build/use fortran libraries
@@ -690,7 +690,7 @@ set(CTEST_SOURCE_VERSEXT "-pre1")
 # handle input parameters to script.
 #BUILD_GENERATOR - which CMake generator to use, required
 #INSTALLDIR - HDF5-1.10.0 root folder
-#CTEST_BUILD_CONFIGURATION - Release, Debug, RelWithDebInfo
+#CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo
 #CTEST_SOURCE_NAME - name of source folder; HDF5-1.10.0
 #STATIC_LIBRARIES - Default is YES
 #FORTRAN_LIBRARIES - Default is NO
@@ -738,8 +738,8 @@ if(NOT DEFINED INSTALLDIR)
     set(INSTALLDIR "/usr/local/myhdf5")
   endif()
 endif()
-if(NOT DEFINED CTEST_BUILD_CONFIGURATION)
-    set(CTEST_BUILD_CONFIGURATION "Release")
+if(NOT DEFINED CTEST_CONFIGURATION_TYPE)
+    set(CTEST_CONFIGURATION_TYPE "Release")
 endif()
 if(NOT DEFINED CTEST_SOURCE_NAME)
     set(CTEST_SOURCE_NAME "hdf5-${CTEST_SOURCE_VERSION}${CTEST_SOURCE_VERSEXT}")
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 052ba31..4d9b832 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -41,9 +41,12 @@ New Features
 
     Configuration:
     -------------
+    - CMake: change CTEST_BUILD_CONFIGURATION to CTEST_CONFIGURATION_TYPE, which is
+      recommended by CMake documentation.
+      HDFFV-9971 (ADB 2016/8/22)
     - Java JNI library API wrappers and supporting files added as HDF_JAVA language
       option. Both configure and CMake disable this option by default.
-      HDFFV-9552 (ADB 2016/02.28)
+      HDFFV-9552 (ADB 2016/02/28)
     - CMake minimum is now 3.1.0. (ADB 2015/11/14)
     - cmakehdf5: configure options added to enable or disable the building of
       different API's and testings. See "cmakehdf5 --help" for details.
@@ -121,6 +124,14 @@ New Features
 
     Library:
     --------
+    - Java API added new H5Iget_name that returns a string.
+      The old function, now deprecated, would cause a memory leak and
+      not return a proper String value.
+      HDFFV-9972 (ADB 2016/8/22)
+    - Add support to expand the plugin path value on Windows when the path
+      includes an environment variable.
+      HDFFV-9706 (ADB 2016/8/22)
+
     - H5F_ACC_DEBUG labeled "deprecated"
 
       The symbol was originally used to emit some extra debugging
@@ -418,7 +429,7 @@ New Features
     ---------------
 
      C Packet Table API
-     ------------------ 
+     ------------------
      - Replacement of a public function
 
       The existing function H5PTcreate_fl limits applications to deflate
@@ -426,18 +437,18 @@ New Features
       H5PTcreate_fl.  H5PTcreate takes a property list ID to provide
       flexibility on creation properties.
 
-	hid_t H5PTcreate(hid_t loc_id, const char *dset_name,
+    hid_t H5PTcreate(hid_t loc_id, const char *dset_name,
                          hid_t dtype_id, hsize_t chunk_size, hid_t plist_id);
                                                (BMR, 2016/03/04, HDFFV-8623)
 
      - New public functions
 
       Two accessor functions were added per HDFFV-8623/patch 003.
-	/* Returns the ID of the dataset associated with the packet table  */
-	   hid_t H5PTget_dataset(hid_t table_id);
+    /* Returns the ID of the dataset associated with the packet table  */
+    hid_t H5PTget_dataset(hid_t table_id);
 
-	/* Returns the ID of the datatype the packet table uses */
-	   hid_t H5PTget_type(hid_t table_id);
+    /* Returns the ID of the datatype the packet table uses */
+    hid_t H5PTget_type(hid_t table_id);
                                                (BMR, 2016/03/04, HDFFV-8623)
 
      - Regarding #ifdef VLPT_REMOVED
@@ -449,23 +460,23 @@ New Features
                                                (BMR, 2016/03/04, HDFFV-442)
 
      C++ Packet Table API
-     -------------------- 
+     --------------------
      - New constructor
 
       An overloaded constructor is added to FL_PacketTable and takes a property
       list ID to provide flexibility on creation properties.
 
-	FL_PacketTable(hid_t fileID, hid_t plist_id, const char* name, hid_t dtypeID, hsize_t chunkSize);
+    FL_PacketTable(hid_t fileID, hid_t plist_id, const char* name, hid_t dtypeID, hsize_t chunkSize);
                                                (BMR, 2016/03/08, HDFFV-8623)
 
      - New public functions
 
       Two accessor wrappers to class PacketTable, per HDFFV-8623/patch 004.
-	/* Returns the ID of the dataset associated with the packet table  */
-	   hid_t PacketTable::GetDataset()
+    /* Returns the ID of the dataset associated with the packet table  */
+    hid_t PacketTable::GetDataset()
 
-	/* Returns the ID of the datatype the packet table uses */
-	   hid_t PacketTable::GetDataset()
+    /* Returns the ID of the datatype the packet table uses */
+    hid_t PacketTable::GetDataset()
                                                (BMR, 2016/03/04, HDFFV-8623)
 
      - Member functions having "char*" as an argument
@@ -478,14 +489,14 @@ New Features
 
       The #ifdef VLPT_REMOVED blocks are removed from the PT library source
       except the following cases:
-	+ VL_PacketTable::IsVariableLength() is moved to PacketTable
-	+ VL_PacketTable::FreeReadBuff() now became PacketTable::FreeBuff()
+    + VL_PacketTable::IsVariableLength() is moved to PacketTable
+    + VL_PacketTable::FreeReadBuff() now became PacketTable::FreeBuff()
 
                                                (BMR, 2016/03/04, HDFFV-442)
 
 
      Internal header file
-     -------------------- 
+     --------------------
      - A new API function H5DOwrite_chunk.  It writes a data chunk directly
             into a file bypassing hyperslab selection, data conversion, and
             filter pipeline.  The user must be careful with the function and
diff --git a/release_docs/USING_CMake_Examples.txt b/release_docs/USING_CMake_Examples.txt
index d8940a5..d3618e9 100644
--- a/release_docs/USING_CMake_Examples.txt
+++ b/release_docs/USING_CMake_Examples.txt
@@ -49,7 +49,7 @@ Default installation process:
        The default installation folder is defined as "@CMAKE_INSTALL_PREFIX@".
            It can be changed with the INSTALLDIR script option.
        The default ctest configuration is defined as "Release". It can be changed
-           with the CTEST_BUILD_CONFIGURATION script option. Note that this must
+           with the CTEST_CONFIGURATION_TYPE script option. Note that this must
            be the same as the value used with the -C command line option.
        The default build configuration is defined to build and use static libraries.
            Shared libraries can be used with the STATIC_LIBRARIES script option set to "NO".
diff --git a/release_docs/USING_HDF5_CMake.txt b/release_docs/USING_HDF5_CMake.txt
index 64d1a2a..e89f1eb 100644
--- a/release_docs/USING_HDF5_CMake.txt
+++ b/release_docs/USING_HDF5_CMake.txt
@@ -235,7 +235,7 @@ set(CTEST_DASHBOARD_ROOT ${CTEST_SCRIPT_DIRECTORY})
 
 # handle input parameters to script.
 #INSTALLDIR - HDF5 root folder
-#CTEST_BUILD_CONFIGURATION - Release, Debug, RelWithDebInfo
+#CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo
 #CTEST_SOURCE_NAME - name of source folder; HDF4Examples
 #STATIC_LIBRARIES - Default is YES
 #FORTRAN_LIBRARIES - Default is NO
@@ -255,8 +255,8 @@ endif()
 if(NOT DEFINED INSTALLDIR)
     set(INSTALLDIR "@CMAKE_INSTALL_PREFIX@")
 endif()
-if(NOT DEFINED CTEST_BUILD_CONFIGURATION)
-    set(CTEST_BUILD_CONFIGURATION "Release")
+if(NOT DEFINED CTEST_CONFIGURATION_TYPE)
+    set(CTEST_CONFIGURATION_TYPE "Release")
 endif()
 if(NOT DEFINED CTEST_SOURCE_NAME)
     set(CTEST_SOURCE_NAME "HDF5Examples")
@@ -379,7 +379,7 @@ if(NOT N EQUAL 0)
   set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N})
 endif()
 set (CTEST_CONFIGURE_COMMAND
-    "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_BUILD_CONFIGURATION} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""
+    "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_CONFIGURATION_TYPE} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""
 )
 
 #-----------------------------------------------------------------------------