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

Unclear which prop-list args are unused in H5Acreate2 #3493

Closed
markcmiller86 opened this issue Sep 3, 2023 · 1 comment · Fixed by #3598
Closed

Unclear which prop-list args are unused in H5Acreate2 #3493

markcmiller86 opened this issue Sep 3, 2023 · 1 comment · Fixed by #3598
Assignees
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Bug / Bugfix Please report security issues to [email protected] instead of creating an issue on GitHub

Comments

@markcmiller86
Copy link
Contributor

Describe the bug

H5Acreate2() has args defined as

hid_t H5Acreate2 ( hid_t loc_id,
    const char * attr_name,
    hid_t type_id,
    hid_t space_id,
    hid_t acpl_id,
    hid_t aapl_id
  )

The docs say that acpl is currently unused. I think there are places in the code that say this. However, there is no table of properites for attribute access in the docs. Only for attribute creation which suggests to me that acpl is used and aapl is currently not used. I am not able to find any instance of H5Acreate2() in tests that pass anything other than H5P_DEFAULT for both acpl and aapl.

I believe the docs and code are in error in saying acpl is unused. I think the unused arg is aapl.

I started to try to submit a PR and then got lost in finding where the statement The acpl parameter is currently not used; specify H5P_DEFAULT actually lives in the sources.

@glennsong09 glennsong09 added Component - Documentation Doxygen, markdown, etc. Type - Bug / Bugfix Please report security issues to [email protected] instead of creating an issue on GitHub Priority - 2. Medium ⏹ It would be nice to have this in the next release labels Sep 5, 2023
@jhendersonHDF
Copy link
Collaborator

Thanks for reporting @markcmiller86. Indeed, aapl_id is the parameter that is not used; I think this was a copy-paste issue from the docs for H5Acreate1. For future reference, here is a link to where the command for generating the The acpl parameter is currently not used; specify H5P_DEFAULT line comes from. the \plist_unused{} command just substitutes whatever it is passed into there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Bug / Bugfix Please report security issues to [email protected] instead of creating an issue on GitHub
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants