summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2013-04-25 17:41:38 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2013-04-25 17:41:38 (GMT)
commitce593b0f5674cb29360ef4fccf42f7d1ebe3ea68 (patch)
treea0bbd42a11e6bbaf5b2fb975d2137b9189a46398
parent720afbd6734acc6bb5cc8ed81a35cdd338640a39 (diff)
downloadhdf5-ce593b0f5674cb29360ef4fccf42f7d1ebe3ea68.zip
hdf5-ce593b0f5674cb29360ef4fccf42f7d1ebe3ea68.tar.gz
hdf5-ce593b0f5674cb29360ef4fccf42f7d1ebe3ea68.tar.bz2
[svn-r23625] Updated and renamed documents
-rw-r--r--MANIFEST6
-rw-r--r--release_docs/INSTALL_CMake.txt (renamed from release_docs/CMake.txt)158
-rw-r--r--release_docs/INSTALL_Windows.txt2
-rw-r--r--release_docs/USING_HDF5_CMake.txt (renamed from release_docs/USING_CMake.txt)14
-rw-r--r--release_docs/USING_HDF5_VS.txt (renamed from release_docs/USING_Windows.txt)64
5 files changed, 136 insertions, 108 deletions
diff --git a/MANIFEST b/MANIFEST
index 5a55229..7e02b2f 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -443,19 +443,19 @@
./perform/sio_timer.h
./perform/zip_perf.c
-./release_docs/CMake.txt
./release_docs/COPYING
./release_docs/HISTORY-1_0-1_8_0_rc3.txt
./release_docs/HISTORY-1_8.txt
./release_docs/INSTALL
+./release_docs/INSTALL_CMake.txt
./release_docs/INSTALL_Cygwin.txt
./release_docs/INSTALL_MinGW.txt
./release_docs/INSTALL_parallel
./release_docs/INSTALL_VMS.txt
./release_docs/INSTALL_Windows.txt
./release_docs/RELEASE.txt
-./release_docs/USING_CMake.txt
-./release_docs/USING_Windows.txt
+./release_docs/USING_HDF5_CMake.txt
+./release_docs/USING_HDF5_VS.txt
./src/.indent.pro _DO_NOT_DISTRIBUTE_
./src/hdf5.lnt _DO_NOT_DISTRIBUTE_
diff --git a/release_docs/CMake.txt b/release_docs/INSTALL_CMake.txt
index bfac7aa..95ebec9 100644
--- a/release_docs/CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -2,42 +2,86 @@
* Build and Install HDF5 C/C++ Library with CMake *
************************************************************************
+ Table of Contents
+
+Section I: Quick Step Building HDF5 Libraries with CMake
+Section II: Preconditions
+Section III: Building HDF5 C/C++ Libraries with CMake
+Section IV: All Options for HDF5 C/C++ Libraries with CMake
+Section V: APPENDIX
+
+************************************************************************
+
+
+
+========================================================================
+I. Quick Step Building HDF5 Libraries with CMake
+========================================================================
Notes: This short set of instructions is written for users who want to
quickly build the HDF5 Library and tools from the HDF5 source code
package using the CMake tools.
- More information about using CMake can be found at the KitWare site,
- www.cmake.org.
-
- CMake uses the command line; however, the visual CMake tool is
- recommended for the configuration step. The steps are similar for
- all the operating systems supported by CMake.
-
- NOTES:
- 1. Using CMake for building and using HDF5 is under active development.
- While we have attempted to provide error-free files, please
- understand that development with CMake has not been extensively
- tested outside of HDF. The CMake specific files may change
- before the next release.
-
- 2. CMake support for HDF5 development should be usable on any
- system where CMake is supported. Please send us any comments on
- how CMake support can be improved on any system. Visit the
- KitWare site for more information about CMake.
-
- 3. Build and test results can be submitted to our CDash server at:
- cdash.hdfgroup.uiuc.edu.
- Please read the HDF and CDash document at:
- www.hdfgroup.org/CDash/HowToSubmit.
-
- 4. See the appendix at the bottom of this file for examples of using
- a ctest script for building and testing.
-
+ A. Windows Quick Step Building HDF5 Libraries with CMake Using VS2010
+
+ Go through these steps:
+
+ 1. Locate the source files in:
+ c:\MyHDFstuff\hdf5
+
+ 2. Create a build folder at:
+ c:\MyHDFstuff\hdf5\build
+
+ 3. Open a command prompt at:
+ c:\MyHDFstuff\hdf5\build
+
+ 4. Configure the C library, tools and tests with this command:
+ cmake -G "Visual Studio 10" -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..
+
+ 3. Build the C library, tools and tests with this command:
+ cmake --build . --config Release
+
+ 4. Test the C library and tools with this command:
+ ctest . -C Release
+
+ 5. Create an install image with this command:
+ cpack -C Release CPackConfig.cmake
+
+ 6. Install with this command:
+ HDF5-1.8.11-win32.exe
+
+ B. Linux Quick Step Building HDF5 Libraries with CMake Using GCC
+
+ Go through these steps:
+
+ 1. Locate the source files in:
+ ~\MyHDFstuff\hdf5
+
+ 2. Create a build folder at:
+ ~\MyHDFstuff\hdf5\build
+
+ 3. Open a command prompt at:
+ ~\MyHDFstuff\hdf5\build
+
+ 4. Configure the C library, tools and tests with this command:
+ cmake -G "Unix Makefiles" -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..
+
+ 3. Build the C library, tools and tests with this command:
+ cmake --build . --config Release
+
+ 4. Test the C library and tools with this command:
+ ctest . -C Release
+
+ 5. Create an install image with this command:
+ cpack -C Release CPackConfig.cmake
+
+ 6. Install with this command:
+ HDF5-1.8.11-Linux.sh
+
========================================================================
-I. Preconditions
+II. Preconditions
========================================================================
1. We suggest you obtain the latest CMake for windows from the Kitware
@@ -77,37 +121,33 @@ I. Preconditions
an install image executable.
-
-========================================================================
-II. Windows Quick Step Building HDF5 Libraries with CMake Using VS2010
-========================================================================
-
-Go through these steps:
-
- 1. Locate the source files in:
- c:\MyHDFstuff\hdf5
-
- 2. Create a build folder at:
- c:\MyHDFstuff\hdf5\build
-
- 3. Open a command prompt at:
- c:\MyHDFstuff\hdf5\build
-
- 4. Configure the C library, tools and tests with this command:
- cmake -G "Visual Studio 10" -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..
-
- 3. Build the C library, tools and tests with this command:
- cmake --build . --config Release
-
- 4. Test the C library and tools with this command:
- ctest . -C Release
-
- 5. Create an install image with this command:
- cpack -C Release CPackConfig.cmake
-
- 6. Install with this command:
- HDF5-1.8.11-win32.exe
-
+Notes: More information about using CMake can be found at the KitWare site,
+ www.cmake.org.
+
+ CMake uses the command line; however, the visual CMake tool is
+ recommended for the configuration step. The steps are similar for
+ all the operating systems supported by CMake.
+
+ NOTES:
+ 1. Using CMake for building and using HDF5 is under active development.
+ While we have attempted to provide error-free files, please
+ understand that development with CMake has not been extensively
+ tested outside of HDF. The CMake specific files may change
+ before the next release.
+
+ 2. CMake support for HDF5 development should be usable on any
+ system where CMake is supported. Please send us any comments on
+ how CMake support can be improved on any system. Visit the
+ KitWare site for more information about CMake.
+
+ 3. Build and test results can be submitted to our CDash server at:
+ cdash.hdfgroup.uiuc.edu.
+ Please read the HDF and CDash document at:
+ www.hdfgroup.org/CDash/HowToSubmit.
+
+ 4. See the appendix at the bottom of this file for examples of using
+ a ctest script for building and testing.
+
diff --git a/release_docs/INSTALL_Windows.txt b/release_docs/INSTALL_Windows.txt
index b78f14c..1581c14 100644
--- a/release_docs/INSTALL_Windows.txt
+++ b/release_docs/INSTALL_Windows.txt
@@ -7,4 +7,4 @@
We now recommend that users build, test and install HDF5 using CMake.
Instructions for building and testing HDF5 using CMake can be found in
-the CMake.txt file found in this folder.
+the INSTALL_CMake.txt file found in this folder.
diff --git a/release_docs/USING_CMake.txt b/release_docs/USING_HDF5_CMake.txt
index 24c66de..2b3c02b 100644
--- a/release_docs/USING_CMake.txt
+++ b/release_docs/USING_HDF5_CMake.txt
@@ -25,13 +25,7 @@ Notes: This short instruction is written for users who want to quickly
where CMake is supported. Please send us any comments on how
CMake support can be improved on any system.
- 3. HDF5 library build and test results can be submitted to our
- CDash server at:
- cdash.hdfgroup.uiuc.edu.
- Please read the HDF and CDash document at:
- www.hdfgroup.org/CDash/HowToSubmit.
-
- 4. See the appendix at the bottom of this file for an example
+ 3. See the appendix at the bottom of this file for an example
of using a ctest script for building and testing. See
CMake.txt for more information.
@@ -218,9 +212,9 @@ IV. APPENDIX
========================================================================
Below is an example of the ctest script used by The HDF Group. See the
-Appendix in the CMake.txt file for the CTestScript.cmake file used by this
-script. Adjust the values as necessary. Note that the source folder is
-entered on the command line and the build folder is created as a sub-folder.
+Appendix in the INSTALL_CMake.txt file for the CTestScript.cmake file used
+by this script. Adjust the values as necessary. Note that the source folder
+is entered on the command line and the build folder is created as a sub-folder.
Windows should adjust the forward slash to double backslashes, except for
the HDF_DIR environment variable.
diff --git a/release_docs/USING_Windows.txt b/release_docs/USING_HDF5_VS.txt
index f12bfa7..bd928bc 100644
--- a/release_docs/USING_Windows.txt
+++ b/release_docs/USING_HDF5_VS.txt
@@ -1,34 +1,13 @@
***********************************************************************
-* HDF5 Build and Install Instructions for Windows *
+* HDF5 Build and Install Suggestions for Windows and Visual Studio *
* (Full Version) *
***********************************************************************
-We now recommend that users build, test and install HDF5 using CMake.
+These suggestions are for Visual Studio users.
Instructions for building and testing HDF5 applications using CMake can
-be found in the CMake.txt and USING_CMake.txt files found in this folder.
-
-
-========================================================================
- Section VI: Misc.
-========================================================================
-
-1. Helpful Pointers
-
-Here are some helpful notes if you are not familiar with
-using the Visual C++ Development Environment.
-
- 1.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://www.hdfgroup.org/windows/faq.html
-
- For all other general questions, you can look in the general FAQ:
-
- http://hdfgroup.org/HDF5-FAQ.html
+be found in the USING_CMake.txt file found in this folder.
The following two sections are helpful if you do not use CMake to build
your applications.
@@ -37,20 +16,20 @@ your applications.
Using Visual Studio 2010 with HDF5 Libraries built with Visual Studio 2010
========================================================================
- 2. Set up path for external libraries and headers
+ 1. Set up path for external libraries and headers
The path settings will need to be in project property sheets per project.
Go to "Project" and select "Properties", find "Configuration Properties",
and then "VC++ Directories".
- 2.1 If you are building on 64-bit Windows, find the "Platform" dropdown
+ 1.1 If you are building on 64-bit Windows, find the "Platform" dropdown
and select "x64".
- 2.2 Add the header path to the "Include Directories" setting.
+ 1.2 Add the header path to the "Include Directories" setting.
- 2.3 Add the library path to the "Library Directories" setting.
+ 1.3 Add the library path to the "Library Directories" setting.
- 2.4 Select Linker->Input and beginning with the
+ 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++
@@ -63,32 +42,47 @@ Using Visual Studio 2010 with HDF5 Libraries built with Visual Studio 2010
Using Visual Studio 2008 with HDF5 Libraries built with Visual Studio 2008
==========================================================================
- 3. Set up path for external libraries and headers
+ 2. Set up path for external libraries and headers
Invoke Microsoft Visual Studio and go to "Tools" and select "Options",
find "Projects", and then "VC++ Directories".
- 3.1 If you are building on 64-bit Windows, find the "Platform" dropdown
+ 2.1 If you are building on 64-bit Windows, find the "Platform" dropdown
and select "x64".
- 3.2 Find the box "Show directories for", choose "Include files", add the
+ 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.
- 3.3 Find the box "Show directories for", choose "Library files", add the
+ 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.
- 3.4 If using Fortran libraries, you will also need to setup the path
+ 2.4 If using Fortran libraries, you will also need to setup the path
for the Intel Fortran compiler.
- 3.5 Select Project->Properties->Linker->Input and beginning with the
+ 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:
szip.lib zlib.lib hdf5dll.lib hdf5_cppdll.lib
+
+========================================================================
+3. Helpful Pointers
+========================================================================
+
+ 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://www.hdfgroup.org/windows/faq.html
+
+ For all other general questions, you can look in the general FAQ:
+
+ http://hdfgroup.org/HDF5-FAQ.html
************************************************************************
Please send email to help@hdfgroup.org for further assistance.