Skip to content

Conversation

@byrnHDF
Copy link
Collaborator

@byrnHDF byrnHDF commented May 8, 2025

No description provided.

set (ENV{LD_LIBRARY_PATH} "$ENV{LD_LIBRARY_PATH}:${TEST_LIBRARY_DIRECTORY}")
if (TEST_LIBRARY_DIRECTORY) # Directory to add to PATH
if (WIN32)
set (ENV{PATH} "$ENV{PATH};${TEST_LIBRARY_DIRECTORY}")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Kinda inconsistent to have some with _DIR and some with _DIRECTORY, isn't it?

Copy link
Collaborator Author

@byrnHDF byrnHDF May 13, 2025

Choose a reason for hiding this comment

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

TEST_LIBRARY_DIRECTORY has been around for a long time in these macros and this one is different then the others, probably. This is one option that adds to the ENV PATH.

echo " -showconfig Show the HDF4 library configuration summary"
echo " "
echo " <pkg-config line> - the pkg-config compile line options for the compiler"
echo " that was used to compile HDF4."
Copy link
Collaborator

Choose a reason for hiding this comment

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

"to compile HDF4."? What does that mean? HDF4 library? HDF4 application?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The compiler used to build HDF4.

export PKG_CONFIG_PATH=$dir/lib/pkgconfig
usage() {
# "How-to use" message.
echo "usage: $prg [OPTIONS] <pkg-config line>"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it $prg or $pkg? Is it short for program?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

$prg is the script; h4cc, etc

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes it is the name of the program being executed.

################################################################################

ALIASES += cpp_c_api_note="\attention \Bold{C++ Developers using HDF5 C-API functions beware:}\n Several functions in this C-API take function pointers or callbacks as arguments. Examples include H5Pset_elink_cb(), H5Pset_type_conv_cb(), H5Tconvert(), and H5Ewalk2(). Application code must ensure that those callback functions return normally such to allow the HDF5 to manage its resources and maintain a consistent state. For instance, those functions must not use the C \c setjmp / \c longjmp mechanism to leave those callback functions. Within the context of C++, any exceptions thrown within the callback function must be caught, such as with a \TText{catch(…)} statement. Any exception state can be placed within the provided user data function call arguments, and may be thrown again once the calling function has returned. Exceptions raised and not handled inside the callback are not supported as it might leave the HDF5 library in an inconsistent state. Similarly, using C++20 coroutines cannot be used as callbacks, since they do not support plain return statements. If a callback function yields execution to another C++20 coroutine calling HDF5 functions as well, this may lead to undefined behavior."
ALIASES += par_compr_note="\attention If you are planning to use compression with parallel HDF5, ensure that calls to H5Dwrite() occur in collective mode. In other words, all MPI ranks (in the relevant communicator) call H5Dwrite() and pass a dataset transfer property list with the MPI-IO collective option property set to #H5FD_MPIO_COLLECTIVE_IO.\n Note that data transformations are currently \Bold{not} supported when writing to datasets in parallel and with compression enabled."
Copy link
Collaborator

Choose a reason for hiding this comment

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

There are a bunch more hdf5 in this file.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Doxygen support was never finished, pending further development.

Copy link
Collaborator Author

@byrnHDF byrnHDF Jun 9, 2025

Choose a reason for hiding this comment

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

Right - doxygen is for the next major release. These files are just placeholders.

@bmribler bmribler self-requested a review June 10, 2025 14:51
@lrknox lrknox merged commit 4a86db1 into HDFGroup:master Jun 11, 2025
28 checks passed
@byrnHDF byrnHDF deleted the master-cmake-upd branch June 11, 2025 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants