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

Updated INSTALL file #3972

Merged
merged 1 commit into from
Feb 8, 2024
Merged

Updated INSTALL file #3972

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 3 additions & 10 deletions release_docs/INSTALL
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.

There is more issues in this file, mostly with portal urls. But also the file types on GH are .zip or tar.gz

Copy link
Contributor

Choose a reason for hiding this comment

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

And also outdated platforms (Cray XT3)

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This file provides instructions for installing the HDF5 software.
For help with installing, questions can be posted to the HDF Forum or sent to the HDF Helpdesk:

HDF Forum: https://forum.hdfgroup.org/
HDF Helpdesk: https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk
HDF Helpdesk: https://hdfgroup.atlassian.net/servicedesk/customer/portals

CONTENTS
--------
Expand Down Expand Up @@ -51,10 +51,8 @@ CONTENTS
*****************************************************************************

1. Obtaining HDF5
The latest supported public release of HDF5 is available from
https://www.hdfgroup.org/downloads/hdf5/. For Unix and UNIX-like
platforms, it is available in tar format compressed with gzip.
For Microsoft Windows, it is in ZIP format.
The latest supported public releases of HDF5 are available on
https://github.com/HDFGroup/hdf5.
Comment on lines -54 to +55
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this correct? There seems to be a difference between the archives published via GitHub and those on the website. The releases on GitHub are archived git repositories (they include a .git directory) and have a top-level directory named hdfsrc instead of hdf5-${version}.

Contrary to this file (release_docs/INSTALL), the root README file points to the hdfgroup.org website for downloads.



2. Quick installation
Expand All @@ -63,18 +61,13 @@ CONTENTS
and support programs. For example, to install HDF5 version X.Y.Z at
location /usr/local/hdf5, use the following steps.

$ gunzip < hdf5-X.Y.Z.tar.gz | tar xf -
$ cd hdf5-X.Y.Z
$ ./configure --prefix=/usr/local/hdf5 <more configure_flags>
$ make
$ make check # run test suite.
$ make install
$ make check-install # verify installation.

Some versions of the tar command support the -z option. In such cases,
the first step above can be simplified to the following:

$ tar zxf hdf5-X.Y.Z.tar.gz

<configure_flags> above refers to the configure flags appropriate
to your installation. For example, to install HDF5 with the
Expand Down