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.

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

Test and document path handling of H5Lcreate_* API #3829

Merged
merged 5 commits into from
Nov 11, 2023

Conversation

mattjala
Copy link
Contributor

@mattjala mattjala commented Nov 3, 2023

The docs incorrectly say that H5Lcreate_soft can't take a path as its link name, and don't mention absolute path handling in any of the H5Lcreate_* documentation.

Fix #3827.

@mattjala mattjala added Merge - To 1.14 Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Component - Documentation Doxygen, markdown, etc. Type - Bug / Bugfix Please report security issues to [email protected] instead of creating an issue on GitHub labels Nov 3, 2023
src/H5Lpublic.h Outdated Show resolved Hide resolved
src/H5Lpublic.h Outdated Show resolved Hide resolved
src/H5Lpublic.h Outdated Show resolved Hide resolved
@mattjala mattjala changed the title Document path handling of H5Lcreate_* API Test and document path handling of H5Lcreate_* API Nov 9, 2023
@mattjala mattjala added the Component - Testing Code in test or testpar directories, GitHub workflows label Nov 9, 2023
@mattjala
Copy link
Contributor Author

mattjala commented Nov 9, 2023

Added tests in links.c that all link creation functions correctly handle relative and absolute paths as provided link names.

test/links.c Outdated
}

/*-------------------------------------------------------------------------
* Function: ext_link_path_handling
Copy link
Collaborator

Choose a reason for hiding this comment

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

ud_link_path_handling

Copy link
Collaborator

@jhendersonHDF jhendersonHDF left a comment

Choose a reason for hiding this comment

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

Minor comment; otherwise looks good

@lrknox lrknox merged commit 5e0b59a into HDFGroup:develop Nov 11, 2023
45 checks passed
@mattjala mattjala deleted the soft_link_path_doc branch October 29, 2024 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc. Component - Testing Code in test or testpar directories, GitHub workflows Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Type - Bug / Bugfix Please report security issues to [email protected] instead of creating an issue on GitHub
Projects
None yet
Development

Successfully merging this pull request may close these issues.

H5Lcreate_soft succeeds despite link_name being a path
5 participants