Merge CMake changes from 1.10 to 1.8

5 files changed, 560 insertions, 24 deletions

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index a786932..aa0672f 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -30,7 +30,7 @@ Obtaining HDF5 source code
 
 CMake version
    1. We suggest you obtain the latest CMake from the Kitware web site.
-      The HDF5 1.8."X" product requires a minimum CMake version 3.2.2,
+      The HDF5 1.8."X" product requires a minimum CMake version 3.10,
       where "X" is the current HDF5 release version.
 
 Note:
@@ -617,6 +617,7 @@ HDF5_STRICT_FORMAT_CHECKS      "Whether to perform strict file format checks"
 HDF_TEST_EXPRESS               "Control testing framework (0-3)"                              "0"
 HDF5_TEST_VFD                  "Execute tests with different VFDs"                            OFF
 HDF5_USE_16_API_DEFAULT        "Use the HDF5 1.6.x API by default"                            OFF
+HDF5_USE_18_API_DEFAULT        "Use the HDF5 1.8.x API by default"                            ON
 HDF5_USE_FOLDERS               "Enable folder grouping of projects in IDEs."                  OFF
 HDF5_WANT_DATA_ACCURACY        "IF data accuracy is guaranteed during data conversions"       ON
 HDF5_WANT_DCONV_EXCEPTION      "exception handling functions is checked during data conversions" ON
diff --git a/release_docs/INSTALL_Warnings.txt b/release_docs/INSTALL_Warnings.txt
new file mode 100644
index 0000000..5fde45f
--- /dev/null
+++ b/release_docs/INSTALL_Warnings.txt
@@ -0,0 +1,474 @@
+***********************************************************************
+*                       COMPILER WARNINGS OPTIONS
+***********************************************************************
+
+                     Table of Contents
+
+Section I:    Managing Warnings
+Section II:   Default Warnings
+Section III:  All Warnings
+Section IV:   Group 0 Warnings
+Section V:    Group 1 Warnings
+Section VI:   Group 2 Warnings
+Section VII:  Group 3 Warnings
+Section VIII: Group 4 Warnings
+Section IX:   Disable Warnings
+
+************************************************************************
+
+
+========================================================================
+I. Managing Warnings
+========================================================================
+Compiler warnings are managed by setting the compiler flags variables.
+
+Autotools uses the H5_CFLAGS and H5_CXXFLAGS, both variables set the flags nearly
+  identical, along with H5_FCFLAGS for Fortran. Autotools uses the type
+  and version of the compiler to determine which warning flags are used.
+  However, there is an option, enable-developer-warnings, to enable extra
+  flags for developers.
+
+CMake uses the CMAKE_C_FLAGS and CMAKE_CXX_FLAGS, both sets are nearly
+  identical, along with CMAKE_Fortran_FLAGS for Fortran. CMake has a
+  minimum set of flags for GNU type compilers and for MSVC compilers. In
+  addition, CMake breaks the list of flags into groups. The groups for
+  GNU are roughly associated with the version of the compiler, while
+  the MSVC groups are associated with the warning levels for the
+  Microsoft compilers. The CMake option for enabling extra developer
+  warnings is HDF5_ENABLE_DEV_WARNINGS.
+
+Custom settings can be used by setting;
+  Environment variables H5_CFLAGS and H5_CXXFLAGS for Autotools
+  CMake defines CMAKE_C_FLAGS and CMAKE_CXX_FLAGS for CMake
+
+
+========================================================================
+II. Default Warnings
+========================================================================
+
+--------------------------------------------------
+Autotools UNIX warnings added to H5_CFLAGS
+--------------------------------------------------
+    -std=c99
+
+   the following warning switches should not raise warnings by the current code
+    -pedantic
+    -Wall
+    -Wextra
+    -Wbad-function-cast
+    -Wc++-compat
+    -Wcast-align
+    -Wcast-qual
+    -Wconversion
+    -Wdeclaration-after-statement
+    -Wdisabled-optimization
+    -Wfloat-equal
+    -Wformat=2
+    -Winit-self
+    -Winvalid-pch
+    -Wmissing-declarations
+    -Wmissing-include-dirs
+    -Wmissing-prototypes
+    -Wnested-externs
+    -Wold-style-definition
+    -Wpacked
+    -Wpointer-arith
+    -Wredundant-decls
+    -Wshadow
+    -Wstrict-prototypes
+    -Wswitch-default
+    -Wswitch-enum
+    -Wundef
+    -Wunused-macros
+    -Wunsafe-loop-optimizations
+    -Wwrite-strings
+
+   enable-developer-warnings=ON
+        -Winline
+        -Waggregate-return
+        -Wmissing-format-attribute
+        -Wmissing-noreturn
+   enable-developer-warnings=OFF
+        -Wno-inline
+        -Wno-aggregate-return
+        -Wno-missing-format-attribute
+        -Wno-missing-noreturn
+
+IF GCC <= 4.3
+    -Wno-long-long
+    -Wvolatile-register-var
+    -Wstrict-overflow
+
+IF GCC <= 4.4
+    -Wno-long-long
+    -Wvolatile-register-var
+    -Wstrict-overflow
+    -Wlogical-op
+    -Wvla
+
+IF GCC <= 4.5
+    -Wno-long-long
+    -Wvolatile-register-var
+    -Wstrict-overflow
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+
+IF GCC <= 4.6
+    -Wno-long-long
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+    -Wstrict-aliasing
+    -Wstrict-overflow=5
+    -Wjump-misses-init
+    -Wunsuffixed-float-constants
+
+IF GCC <= 4.7
+    -Wno-long-long
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+    -Wstrict-aliasing
+    -Wstrict-overflow=5
+    -Wjump-misses-init
+    -Wunsuffixed-float-constants
+    -Wdouble-promotion
+    -Wtrampolines
+   enable-developer-warnings=ON:
+        -Wsuggest-attribute=const
+   enable-developer-warnings=OFF:
+        -Wno-suggest-attribute=const
+
+IF GCC <= 4.8
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+    -Wstrict-overflow=5
+    -Wjump-misses-init
+    -Wunsuffixed-float-constants
+    -Wdouble-promotion
+    -Wtrampolines
+    -Wstack-usage=8192
+    -Wvector-operation-performance
+   enable-developer-warnings=ON:
+        -Wsuggest-attribute=const
+        -Wsuggest-attribute=pure
+        -Wsuggest-attribute=noreturn
+   enable-developer-warnings=OFF:
+        -Wno-suggest-attribute=const
+        -Wno-suggest-attribute=pure
+        -Wno-suggest-attribute=noreturn
+
+IF GCC <= 4.9
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+    -Wstrict-overflow=5
+    -Wjump-misses-init
+    -Wdouble-promotion
+    -Wtrampolines
+    -Wstack-usage=8192
+    -Wvector-operation-performance
+   enable-developer-warnings=ON:
+        -Wsuggest-attribute=const
+        -Wsuggest-attribute=pure
+        -Wsuggest-attribute=noreturn
+        -Wsuggest-attribute=format
+   enable-developer-warnings=OFF:
+        -Wno-suggest-attribute=const
+        -Wno-suggest-attribute=pure
+        -Wno-suggest-attribute=noreturn
+        -Wno-suggest-attribute=format
+
+IF GCC < 5
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+    -Wstrict-overflow=5
+    -Wjump-misses-init
+    -Wunsuffixed-float-constants
+    -Wdouble-promotion
+    -Wtrampolines
+    -Wstack-usage=8192
+    -Wvector-operation-performance
+    -Wdate-time
+   enable-developer-warnings=ON:
+        -Wsuggest-attribute=const
+        -Wsuggest-attribute=pure
+        -Wsuggest-attribute=noreturn
+        -Wsuggest-attribute=format
+   enable-developer-warnings=OFF:
+        -Wno-suggest-attribute=const
+        -Wno-suggest-attribute=pure
+        -Wno-suggest-attribute=noreturn
+        -Wno-suggest-attribute=format
+
+IF GCC < 6
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+    -Wstrict-overflow=5
+    -Wjump-misses-init
+    -Wunsuffixed-float-constants
+    -Wdouble-promotion
+    -Wtrampolines
+    -Wstack-usage=8192
+    -Wvector-operation-performance
+    -Wdate-time
+    -Warray-bounds=2
+    -Wc99-c11-compat
+   enable-developer-warnings=ON:
+        -Wsuggest-attribute=const
+        -Wsuggest-attribute=pure
+        -Wsuggest-attribute=noreturn
+        -Wsuggest-attribute=format
+   enable-developer-warnings=OFF:
+        -Wno-suggest-attribute=const
+        -Wno-suggest-attribute=pure
+        -Wno-suggest-attribute=noreturn
+        -Wno-suggest-attribute=format
+
+IF GCC < 7
+    -Wlogical-op
+    -Wvla
+    -Wlarger-than=2048
+    -Wsync-nand
+    -Wframe-larger-than=16384
+    -Wpacked-bitfield-compat
+    -Wstrict-overflow=5
+    -Wjump-misses-init
+    -Wunsuffixed-float-constants
+    -Wdouble-promotion
+    -Wtrampolines
+    -Wstack-usage=8192
+    -Wvector-operation-performance
+    -Wdate-time
+    -Warray-bounds=2
+    -Wc99-c11-compat
+    -Wnull-dereference
+    -Wunused-const-variable
+    -Wduplicated-cond -Whsa
+   enable-developer-warnings=ON:
+        -Wsuggest-attribute=const
+        -Wsuggest-attribute=pure
+        -Wsuggest-attribute=noreturn
+        -Wsuggest-attribute=format
+   enable-developer-warnings=OFF:
+        -Wno-suggest-attribute=const
+        -Wno-suggest-attribute=pure
+        -Wno-suggest-attribute=noreturn
+        -Wno-suggest-attribute=format
+
+
+--------------------------------------------
+CMake warnings added to CMAKE_C_FLAGS
+--------------------------------------------
+
+IF GNU GCC
+    -pedantic
+    -Wall
+    -Wextra
+    -Wbad-function-cast
+    -Wc++-compat
+    -Wcast-align
+    -Wcast-qual
+    -Wconversion
+    -Wdeclaration-after-statement
+    -Wdisabled-optimization
+    -Wfloat-equal
+    -Wformat=2
+    -Winit-self
+    -Winvalid-pch
+    -Wmissing-declarations
+    -Wmissing-include-dirs
+    -Wmissing-prototypes
+    -Wnested-externs
+    -Wold-style-definition
+    -Wpacked
+    -Wpointer-arith
+    -Wredundant-decls
+    -Wshadow
+    -Wstrict-prototypes
+    -Wswitch-default
+    -Wswitch-enum
+    -Wundef
+    -Wunused-macros
+    -Wunsafe-loop-optimizations
+    -Wwrite-strings
+
+    -fmessage-length=0
+   HDF5_ENABLE_DEV_WARNINGS=ON
+        -Winline
+        -Waggregate-return
+   HDF5_ENABLE_DEV_WARNINGS=OFF
+        -Wno-unused-parameter
+        -Wno-inline
+        -Wno-aggregate-return
+
+
+========================================================================
+III. All Warnings in CMake
+========================================================================
+
+Default: HDF5_ENABLE_DEV_WARNINGS:BOOL=OFF
+    For Visual Studio:
+        /W3
+
+HDF5_ENABLE_ALL_WARNINGS:BOOL=ON
+    For Visual Studio:
+        /Wall
+        /wd4668
+
+    For GNU GCC
+        Group 0 flags
+        Group 1 flags
+        Group 2 flags
+
+
+========================================================================
+IV. Group 0 Warnings in CMake
+========================================================================
+
+Default: HDF5_ENABLE_GROUPZERO_WARNINGS:BOOL=OFF
+
+HDF5_ENABLE_GROUPZERO_WARNINGS:BOOL=ON
+    For Visual Studio
+        /W1
+
+    For GNU GCC
+        Default Warnings
+
+
+========================================================================
+V. Group 1 Warnings in CMake
+========================================================================
+
+Default: HDF5_ENABLE_GROUPONE_WARNINGS:BOOL=OFF
+
+HDF5_ENABLE_GROUPONE_WARNINGS:BOOL=ON
+    For Visual Studio
+        /W2
+
+    For GNU GCC
+      IF GCC >= 4.3
+        -Wlogical-op
+        -Wvla
+        -Wlarger-than=2048
+      IF GCC >= 4.4
+        -Wsync-nand
+        -Wframe-larger-than=16384
+        -Wpacked-bitfield-compat
+      IF GCC >= 4.5
+        -Wstrict-overflow=5
+        -Wjump-misses-init
+        -Wunsuffixed-float-constants
+
+
+========================================================================
+VI. Group 2 Warnings in CMake
+========================================================================
+
+Default: HDF5_ENABLE_GROUPTWO_WARNINGS:BOOL=OFF
+
+HDF5_ENABLE_GROUPTWO_WARNINGS:BOOL=ON
+    For Visual Studio
+        /W3
+
+    For GNU GCC
+      IF GCC >= 4.6
+        -Wdouble-promotion
+        -Wtrampolines
+       enable-developer-warnings=ON:
+            -Wsuggest-attribute=const
+       enable-developer-warnings=OFF:
+            -Wno-suggest-attribute=const
+      IF GCC >= 4.7
+        -Wstack-usage=8192
+        -Wvector-operation-performance
+       enable-developer-warnings=ON:
+            -Wsuggest-attribute=pure
+            -Wsuggest-attribute=noreturn
+       enable-developer-warnings=OFF:
+            -Wno-suggest-attribute=pure
+            -Wno-suggest-attribute=noreturn
+      IF GCC >= 4.8
+       enable-developer-warnings=ON:
+            -Wsuggest-attribute=format
+       enable-developer-warnings=OFF:
+            -Wno-suggest-attribute=format
+      IF GCC >= 4.8
+        -Wdate-time
+
+
+========================================================================
+VII. Group 3 Warnings in CMake
+========================================================================
+
+Default: HDF5_ENABLE_GROUPTHREE_WARNINGS:BOOL=OFF
+
+HDF5_ENABLE_GROUPTHREE_WARNINGS:BOOL=ON
+    For Visual Studio
+        /W4
+
+    For GNU GCC
+        IF GCC >= 5.1
+            -Warray-bounds=2
+            -Wc99-c11-compat
+
+
+========================================================================
+VIII. Group 4 Warnings in CMake
+========================================================================
+
+Default: HDF5_ENABLE_GROUPFOUR_WARNINGS:BOOL=OFF
+
+HDF5_ENABLE_GROUPFOUR_WARNINGS:BOOL=ON
+    For GNU GCC
+        IF GCC >= 6.0
+            -Wnull-dereference
+            -Wunused-const-variable
+            -Wduplicated-cond
+            -Whsa
+
+
+========================================================================
+IX. Disable Warnings in CMake
+========================================================================
+
+Default: HDF5_DISABLE_COMPILER_WARNINGS:BOOL=OFF
+
+HDF5_DISABLE_COMPILER_WARNINGS:BOOL=ON
+    For Visual Studio
+        HDF5_WARNINGS_BLOCKED:BOOL=ON
+        /W0
+
+    For GNU GCC
+        -w
+
+
+========================================================================
+For further assistance, send email to help@hdfgroup.org
+========================================================================
+
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 57534f9..4c44a97 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -17,21 +17,21 @@ The HDF5 1.8.21 release can be obtained from:
 
      https://support.hdfgroup.org/HDF5/release/obtain518.html
 
-User documentation for the snapshot can be accessed directly at this location:
+Links to HDF5 documentation can be found on The HDF5 web page:
 
-     https://support.hdfgroup.org/HDF5/doc1.8/
+     https://portal.hdfgroup.org/display/HDF5/HDF5
 
 New features in the HDF5-1.8.x release series, including brief general
 descriptions of some new and modified APIs, are described in the "What's New
 in 1.8.0?" document:
 
-     https://support.hdfgroup.org/HDF5/doc/ADGuide/WhatsNew180.html
+     https://www.hdfgroup.org/downloads/hdf5/
 
 All new and modified APIs are listed in detail in the "HDF5 Software Changes
 from Release to Release" document, in the section "Release 1.8.22 (current
 release) versus Release 1.8.21
 
-     https://support.hdfgroup.org/HDF5/doc1.8/ADGuide/Changes.html
+     https://portal.hdfgroup.org/display/HDF5/HDF5+Application+Developer%27s+Guide
 
 If you have any questions or comments, please send them to the HDF Help Desk:
 
@@ -48,6 +48,7 @@ CONTENTS
 - Supported Configuration Features Summary
 - More Tested Platforms
 - Known Problems
+- CMake vs. Autotools installations
 
 
 New Features
@@ -319,3 +320,39 @@ Known Problems
     Known problems in previous releases can be found in the HISTORY*.txt files
     in the HDF5 source. Please report any new problems found to
     help@hdfgroup.org.
+
+
+CMake vs. Autotools installations
+=================================
+While both build systems produce similar results, there are differences.
+Each system produces the same set of folders on linux (only CMake works
+on standard Windows); bin, include, lib and share. Autotools places the
+COPYING and RELEASE.txt file in the root folder, CMake places them in
+the share folder.
+
+The bin folder contains the tools and the build scripts. Additionally, CMake
+creates dynamic versions of the tools with the suffix "-shared". Autotools
+installs one set of tools depending on the "--enable-shared" configuration
+option.
+  build scripts
+  -------------
+  Autotools: h5c++, h5cc, h5fc
+  CMake: h5c++, h5cc, h5hlc++, h5hlcc
+
+The include folder holds the header files and the fortran mod files. CMake
+places the fortran mod files into separate shared and static subfolders,
+while Autotools places one set of mod files into the include folder. Because
+CMake produces a tools library, the header files for tools will appear in
+the include folder.
+
+The lib folder contains the library files, and CMake adds the pkgconfig
+subfolder with the hdf5*.pc files used by the bin/build scripts created by
+the CMake build. CMake separates the C interface code from the fortran code by
+creating C-stub libraries for each Fortran library. In addition, only CMake
+installs the tools library. The names of the szip libraries are different
+between the build systems.
+
+The share folder will have the most differences because CMake builds include
+a number of CMake specific files for support of CMake's find_package and support
+for the HDF5 Examples CMake project.
+
diff --git a/release_docs/USING_HDF5_CMake.txt b/release_docs/USING_HDF5_CMake.txt
index aa86058..8da33de 100644
--- a/release_docs/USING_HDF5_CMake.txt
+++ b/release_docs/USING_HDF5_CMake.txt
@@ -188,13 +188,13 @@ string(TOLOWER ${LIB_TYPE} SEARCH_TYPE)
 
 find_package (HDF5 NAMES hdf5 COMPONENTS C ${SEARCH_TYPE})
 # find_package (HDF5) # Find non-cmake built HDF5
-INCLUDE_DIRECTORIES (${HDF5_INCLUDE_DIR})
+set_directory_properties(PROPERTIES INCLUDE_DIRECTORIES "${HDF5_INCLUDE_DIR}")
 set (LINK_LIBS ${LINK_LIBS} ${HDF5_C_${LIB_TYPE}_LIBRARY})
 
 set (example hdf_example)
 
 add_executable (${example} ${PROJECT_SOURCE_DIR}/${example}.c)
-TARGET_C_PROPERTIES (${example} ${LIB_TYPE} " " " ")
+TARGET_C_PROPERTIES (${example} PRIVATE ${LIB_TYPE})
 target_link_libraries (${example} ${LINK_LIBS})
 
 enable_testing ()
diff --git a/release_docs/USING_HDF5_VS.txt b/release_docs/USING_HDF5_VS.txt
index 27191d3..3fd0453 100644
--- a/release_docs/USING_HDF5_VS.txt
+++ b/release_docs/USING_HDF5_VS.txt
@@ -16,30 +16,58 @@ The following two sections are helpful if you do not use CMake to build
 your applications. Consult the Microsoft documentation for your product
 for more information.
 
-========================================================================
-Using Visual Studio with HDF5 Libraries
-========================================================================
+==============================================================================================
+Using Visual Studio 2010 and above with HDF5 Libraries built with Visual Studio 2010 and above
+==============================================================================================
+
+   1. Set up path for external libraries and headers
+
+      The path settings will need to be in the project property sheets per project.
+      Go to "Project" and select "Properties", find "Configuration Properties",
+      and then "VC++ Directories".
 
-   1. The HDF5 binary must match with your Visual Studio version
+      1.1 If you are building on 64-bit Windows, find the "Platform" dropdown
+          and select "x64".
+
+      1.2 Add the header path to the "Include Directories" setting.
+
+      1.3 Add the library path to the "Library Directories" setting.
+
+      1.4 Select Linker->Input and beginning with the
+          "Additional Dependencies" line, enter the library names. The
+          external libraries should be listed first, followed by the HDF5
+          library, and then optionally the HDF5 High Level, Fortran or C++
+          libraries. For example, to compile a C++ application, enter:
+
+          szip.lib zlib.lib hdf5.lib hdf5_cpp.lib
+
+
+==========================================================================
+Using Visual Studio 2008 with HDF5 Libraries built with Visual Studio 2008
+==========================================================================
 
    2. Set up the path for external libraries and headers
 
-      Follow the Microsoft guidelines for adding third-party libraries.
+      Invoke Microsoft Visual Studio and go to "Tools" and select "Options",
+      find "Projects", and then "VC++ Directories".
 
-      2.1 If you are building on 64-bit Windows, be sure the binary is
-          built for the your intended "Platform"; 64-bit or 32-bit.
+      2.1 If you are building on 64-bit Windows, find the "Platform" dropdown
+          and select "x64".
 
-      2.2 Add the header path (i.e. c:\Program Files\HDF_Group\HDF5\1.8.x\include)
-          to the included directories settings.
+      2.2 Find the box "Show directories for", choose "Include files", add the
+          header path (i.e. c:\Program Files\HDF_Group\HDF5\1.8.x\include)
+          to the included directories.
 
-      2.3 Add the library path (i.e. c:\Program Files\HDF_Group\HDF5\1.8.x\lib)
+      2.3 Find the box "Show directories for", choose "Library files", add the
+          library path (i.e. c:\Program Files\HDF_Group\HDF5\1.8.x\lib)
           to the library directories.
 
       2.4 If using Fortran libraries, you will also need to setup the path
           for the Intel Fortran compiler.
 
-      2.5 Enter the library names into the linker "Additional Dependencies" line.
-          The external libraries should be listed first, followed by the HDF5
+      2.5 Select Project->Properties->Linker->Input and beginning with the
+          "Additional Dependencies" line, enter the library names. The
+          external libraries should be listed first, followed by the HDF5
           library, and then optionally the HDF5 High Level, Fortran or C++
           libraries. For example, to compile a C++ application, enter:
 
@@ -52,11 +80,7 @@ Using Visual Studio with HDF5 Libraries
     3.1 FAQ
 
     Many other common questions and hints are located online and being updated
-    in the HDF5 FAQ.  For Windows-specific questions, please see:
-
-        http://support.hdfgroup.org/HDF5/faq/windows.html
-
-    For all other general questions, you can look in the general FAQ:
+    in the HDF Knowledge Base, please see:
 
        https://portal.hdfgroup.org/display/knowledge/HDF+Knowledge+Base