Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install texts #4010

Merged
merged 7 commits into from
Feb 14, 2024
Merged

Update install texts #4010

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2467957
Update installation documents
Feb 13, 2024
cfc9803
Update INSTALL_CMake.txt as necessary
Feb 13, 2024
33d7047
Change option to match other options
Feb 13, 2024
90b37c4
Make cmake options consistent
Feb 13, 2024
97d261d
Update remaining docs that use HDF5_USE_GNU_DIRS
Feb 13, 2024
0b8b919
Update options in HDFMacros in HDF5Examples
Feb 13, 2024
fab6508
Updated INSTALL_Autotools.txt to INSTALL_Auto.txt to align with HDF4 …
Feb 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions config/cmake/HDFMacros.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ macro (HDFTEST_COPY_FILE src dest target)
endmacro ()

macro (HDF_DIR_PATHS package_prefix)
option (HDF5_USE_GNU_DIRS "TRUE to use GNU Coding Standard install directory variables, FALSE to use historical settings" FALSE)
option (HDF5_USE_GNU_DIRS "ON to use GNU Coding Standard install directory variables, OFF to use historical settings" OFF)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an equivalent option in ExamplesCache.cmake file.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And there is an HDFMacros.cmake file in HDF5Examples/config/cmake folder

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated these two files.

if (HDF5_USE_GNU_DIRS)
include(GNUInstallDirs)
if (NOT ${package_prefix}_INSTALL_BIN_DIR)
Expand Down Expand Up @@ -400,7 +400,7 @@ macro (HDF_DIR_PATHS package_prefix)
endif ()

if (APPLE)
option (${package_prefix}_BUILD_FRAMEWORKS "TRUE to build as frameworks libraries, FALSE to build according to BUILD_SHARED_LIBS" FALSE)
option (${package_prefix}_BUILD_FRAMEWORKS "ON to build as frameworks libraries, OFF to build according to BUILD_SHARED_LIBS" OFF)
endif ()

if (NOT ${package_prefix}_INSTALL_BIN_DIR)
Expand Down Expand Up @@ -449,10 +449,10 @@ macro (HDF_DIR_PATHS package_prefix)
message(STATUS "Final: ${${package_prefix}_INSTALL_DOC_DIR}")

# Always use full RPATH, i.e. don't skip the full RPATH for the build tree
set (CMAKE_SKIP_BUILD_RPATH FALSE)
set (CMAKE_SKIP_BUILD_RPATH OFF)
# when building, don't use the install RPATH already
# (but later on when installing)
set (CMAKE_INSTALL_RPATH_USE_LINK_PATH FALSE)
set (CMAKE_INSTALL_RPATH_USE_LINK_PATH OFF)
# add the automatically determined parts of the RPATH
# which point to directories outside the build tree to the install RPATH
set (CMAKE_BUILD_WITH_INSTALL_RPATH ON)
Expand Down
8 changes: 0 additions & 8 deletions release_docs/INSTALL → release_docs/INSTALL_Autotools.txt
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some changes to this file along the same lines as I did in HDF4.
The other files are good.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #4013

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can move your GNU_DIRS changes to HDF4.

Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ CONTENTS

2. Quick installation
2.1. Windows
2.2. RedStorm (Cray XT3)

3. HDF5 dependencies
3.1. Zlib
Expand Down Expand Up @@ -84,13 +83,6 @@ CONTENTS
Users of Microsoft Windows should see the INSTALL_Windows files for
detailed instructions.

2.2. RedStorm (Cray XT3)
Users of the Red Storm machine, after reading this file, should read
the Red Storm section in the INSTALL_parallel file for specific
instructions for the Red Storm machine. The same instructions would
probably work for other Cray XT3 systems, but they have not been
verified.


3. HDF5 dependencies
3.1. Zlib
Expand Down
22 changes: 12 additions & 10 deletions release_docs/INSTALL_CMake.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,13 +788,14 @@ if (WINDOWS)
DISABLE_PDB_FILES "Do not install PDB files" OFF

---------------- HDF5 Build Options ---------------------
HDF5_BUILD_CPP_LIB "Build HDF5 C++ Library" OFF
HDF5_BUILD_EXAMPLES "Build HDF5 Library Examples" ON
HDF5_BUILD_FORTRAN "Build FORTRAN support" OFF
HDF5_BUILD_JAVA "Build JAVA support" OFF
HDF5_BUILD_HL_LIB "Build HIGH Level HDF5 Library" ON
HDF5_BUILD_TOOLS "Build HDF5 Tools" ON
HDF5_BUILD_HL_GIF_TOOLS "Build HIGH Level HDF5 GIF Tools" OFF
HDF5_BUILD_CPP_LIB "Build HDF5 C++ Library" OFF
HDF5_BUILD_EXAMPLES "Build HDF5 Library Examples" ON
HDF5_BUILD_FORTRAN "Build FORTRAN support" OFF
HDF5_BUILD_JAVA "Build JAVA support" OFF
HDF5_BUILD_HL_LIB "Build HIGH Level HDF5 Library" ON
HDF5_BUILD_TOOLS "Build HDF5 Tools" ON
HDF5_BUILD_HL_GIF_TOOLS "Build HIGH Level HDF5 GIF Tools" OFF
HDF5_BUILD_PARALLEL_TOOLS "Build Parallel HDF5 Tools" OFF

---------------- HDF5 Folder Build Options ---------------------
Defaults relative to $<INSTALL_PREFIX>
Expand All @@ -809,8 +810,8 @@ else ()
HDF5_INSTALL_DATA_DIR "share"
HDF5_INSTALL_DOC_DIR "HDF5_INSTALL_DATA_DIR"

HDF5_USE_GNU_DIRS "TRUE to use GNU Coding Standard install directory variables,
FALSE to use historical settings" FALSE
HDF5_USE_GNU_DIRS "ON to use GNU Coding Standard install directory variables,
OFF to use historical settings" OFF
Defaults as defined by the `GNU Coding Standards`
HDF5_INSTALL_BIN_DIR "bin"
HDF5_INSTALL_LIB_DIR "lib"
Expand Down Expand Up @@ -839,6 +840,7 @@ HDF5_ENABLE_EMBEDDED_LIBINFO "embed library info into executables"
HDF5_ENABLE_PREADWRITE "Use pread/pwrite in sec2/log/core VFDs in place of read/write (when available)" ON
HDF5_ENABLE_TRACE "Enable API tracing capability" OFF
HDF5_ENABLE_USING_MEMCHECKER "Indicate that a memory checker is used" OFF
HDF5_ENABLE_MAP_API "Build the map API" OFF
HDF5_GENERATE_HEADERS "Rebuild Generated Files" ON
HDF5_BUILD_GENERATORS "Build Test Generators" OFF

Expand Down Expand Up @@ -904,7 +906,7 @@ if (BUILD_TESTING)
---------------- External Library Options ---------------------
HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building (NO GIT TGZ)" "NO"
HDF5_ENABLE_PLUGIN_SUPPORT "Enable PLUGIN Filters" OFF
HDF5_ENABLE_SZIP_SUPPORT "Use SZip Filter" ON
HDF5_ENABLE_SZIP_SUPPORT "Use SZip Filter" OFF
HDF5_ENABLE_Z_LIB_SUPPORT "Enable Zlib Filters" ON

ZLIB_USE_EXTERNAL "Use External Library Building for ZLIB" OFF
Expand Down
Loading