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

Jump to bottom

H5Pset_efile_prefix documentation error #1759

Closed
gheber opened this issue May 10, 2022 · 2 comments
Closed

H5Pset_efile_prefix documentation error #1759

gheber opened this issue May 10, 2022 · 2 comments
Assignees
@bmribler
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 1. High 🔼 These are important issues that should be resolved in the next release Type - Bug Please report security issues to help@hdfgroup.org instead of creating an issue on GitHub
Milestone
1.14.4

Comments

@gheber
Copy link
Member

gheber commented May 10, 2022

External datasets relative to current directory or HDF5 file as documented?

Examining the source code indicates the default prefix is the current directory of the program and NOT “the same directory as the HDF5 file”.
@mkitti
Copy link
Contributor

mkitti commented May 11, 2022

Thanks, Gerd. To clarify the situation, the existing and intended behavior is that the default external dataset prefix is the current working directory of the calling program's current process. This is the case when the prefix is not set, set to an empty string, or set to "." via H5Pset_efile_prefix.

To make the location of the external dataset file relative to the HDF5 file, the misdocumented default, H5Pset_efile_prefix should be set to "${ORIGIN}".

@mkitti
Copy link
Contributor

mkitti commented May 30, 2022

I believe this is the text that needs to be edited.

hdf5/src/H5Ppublic.h

Lines 7351 to 7353 in a124f02

* \li The default behavior of the library is to search for the
* dataset’s external storage raw data files in the same
* directory as the HDF5 file which contains the dataset.

@gheber gheber added Component - Documentation Doxygen, markdown, etc. and removed documentation labels Mar 3, 2023
@derobins derobins added Priority - 1. High 🔼 These are important issues that should be resolved in the next release Type - Bug Please report security issues to help@hdfgroup.org instead of creating an issue on GitHub labels May 3, 2023
@derobins derobins added this to the 1.14.3 milestone Oct 9, 2023
@derobins derobins assigned bmribler and unassigned vchoi-hdfgroup Oct 13, 2023
@derobins derobins modified the milestones: 1.14.3, 1.14.4 Oct 24, 2023
bmribler added a commit to bmribler/hdf5_bmr23 that referenced this issue Mar 21, 2024
@bmribler
Fix H5Pset_efile_prefix documentation error
e6391d4 
Fixes GH issue HDFGroup#1759
@bmribler bmribler mentioned this issue Mar 21, 2024
Merged
derobins pushed a commit that referenced this issue Mar 21, 2024
@bmribler
Fix H5Pset_efile_prefix documentation error (#4206)
20c570b 
Fixes GH issue #1759
lrknox pushed a commit to lrknox/hdf5 that referenced this issue Mar 25, 2024
@bmribler @lrknox
Fix H5Pset_efile_prefix documentation error (HDFGroup#4206)
f2d2675 
Fixes GH issue HDFGroup#1759
lrknox added a commit that referenced this issue Mar 25, 2024
@lrknox
Sync develop changes March 20 - March 25 to hdf5_1_14. (#4241)
3c86f0f 
* Call memset before stat calls (#4202)

The buffers passed to stat-like calls are only partially filled in by
the call, leaving ununitialized memory areas when the stat buffers are
created on the stack.

This change memsets the buffers to 0 before the stat calls, quieting
the -fsanitze=memory complaints.

* Remove unused CMake configuration checks (#4199)

* Update link to Chunking in HDF5 page (#4203)

* Fix H5Pset_efile_prefix documentation error (#4206)

Fixes GH issue #1759

* Suggested header footer for NEWSLETTER (#4204)

* Suggested header footer for NEWSLETTER

* Updates

* Add NEWSLETTER.txt to h5vers script

* Fix grammar in README.md release template (#4201)

* Add back snapshot names (#4198)

* Use tar.gz extension for ABI reports (#4205)

* Fix issue with Subfiling VFD and multiple opens of same file (#4194)

* Fix issue with Subfiling VFD and multiple opens of same file

* Update H5_subfile_fid_to_context to return error value instead of ID

* Add helper routine to initialize open file mapping

* Reverts AC_SYS_LARGEFILE change (#4213)

We previously replaced local macros with AC_SYS_LARGEFILE, which is
unfortunately buggy on some systems and does not correctly set the
necessary defines, despite successfully detecting them.

This restores the previous macro hacks to acsite.m4

* Propagate group creation properties to intermediate groups (#4139)

* Add clarification for current behavior of H5Get_objtype_by_idx() (#4120)

* Addressed Fortran  issues with promoted integers and reals via compilation flags (#4209)

* addressed issue wit promoted integers and reals

* added option to use mpi_f08

* Summarize the library version table (#4212)

Fixes GH-3773

* Fix URLs (#4210)

Also removed Copyright.html context because it's no longer valid.

* Fix 'make check-vfd' target for Autotools (#4211)

Changes Autotools testing to use HDF5_TEST_DRIVER environment
variable to avoid running tests that don't work well with several
VFDs

Restores old h5_get_vfd_fapl() testing function to setup a FAPL
with a particular VFD

Adds a macro for the default VFD name

* Revert "Addressed Fortran  issues with promoted integers and reals via compil…" (#4220)

This reverts commit 06c42ff.

* Backup and clear CMAKE_C_FLAGS before performing _Float16 configure checks (#4217)

* Fix broken links (#4224)

* Fix broken URLs in documentation (#4214)

Fixes GH-3881 partially.  There are pages that need to be recreated.

* Avoid file size checks in C++ testhdf5 for certain VFDs (#4226)

* Fix an issue with type size assumptions in h5dumpgentest (#4222)

* Fix issue with -Werror cleanup sed command in configure.ac (#4223)

* Fix Java JNI warnings (#4229)

* Rework snapshots/release workflows for consistent args (#4227)

* Fixed a cache assert with too-large metadata objects (#4231)

If the library tries to load a metadata object that is above the
library's hard-coded limits, the size will trip an assert in debug
builds. In HDF5 1.14.4, this can happen if you create a very large
number of links in an old-style group that uses local heaps.

The library will now emit a normal error when it tries to load a
metadata object that is too large.

Partially addresses GitHub #3762

* Set DXPL in API context for native VOL attribute I/O calls (#4228)

* Initialize a variable in C++ testhdf5's tattr.cpp (#4232)

* Addressed Fortran issues with promoted integers and reals via compilation flags, part 2 (#4221)

* addressed issue wit promoted integers and reals

* fixed h5fcreate_f

* added option to use mpi_f08

* change the kind of logical in the parallel tests

* addressed missing return value from callback

* Use cp -rp in test_plugin.sh (#4233)

When building with debug symbols on MacOS, the cp -p commands in
test_plugin.sh will attempt to copy the .dSYM directories with
debugging info, which will fail since -r is missing.

Using cp -rp is harmless and allows the test to run

Fixes HDFFV-10542

* Clean up types in h5test.c (#4235)

Reduces warnings on 32-bit and LLP64 systems

* Fix example links (#4237)

* Fix links md files (#4239)

* Add markdown link checker action (#4219)

* Match minimum CMake version to 3.18 (#4215)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bmribler bmribler

Labels
Component - Documentation Doxygen, markdown, etc. Priority - 1. High 🔼 These are important issues that should be resolved in the next release Type - Bug Please report security issues to help@hdfgroup.org instead of creating an issue on GitHub
Projects
None yet
Milestone
1.14.4
Development

No branches or pull requests
5 participants
@derobins @gheber @mkitti @bmribler @vchoi-hdfgroup