summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2018-07-30 20:09:50 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2018-07-30 20:09:50 (GMT)
commitc0ff42f67699273f845b0101c481854e23a5a98a (patch)
treeb788b6996f1faa146dd8042257555096c5da0446
parentb33ba00c9cf0b5a94d1c0a102b6e47046830362e (diff)
downloadhdf5-c0ff42f67699273f845b0101c481854e23a5a98a.zip
hdf5-c0ff42f67699273f845b0101c481854e23a5a98a.tar.gz
hdf5-c0ff42f67699273f845b0101c481854e23a5a98a.tar.bz2
HDFFV-10508 Document binary diffs
-rw-r--r--release_docs/RELEASE.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 9161b3c..bbef7f9 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -39,6 +39,7 @@ CONTENTS
- Tested Configuration Features Summary
- More Tested Platforms
- Known Problems
+- CMake vs. Autotools installations
New Features
@@ -511,3 +512,37 @@ Known Problems
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".
+ 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 uses links to the main library file, while autotools
+builds copies library files. In addition, because CMake creates the tools
+library and the C-stub libraries for the Fortran libraries, these libraries
+are present only for CMake builds. The names of the szip libaries 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 CMakes find_package and support
+for the HDF5 Examples CMake project.
+