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

Add documentation (H5FD) #4269

Merged
merged 6 commits into from
Apr 1, 2024
Merged

Add documentation (H5FD) #4269

merged 6 commits into from
Apr 1, 2024

Conversation

bmribler
Copy link
Contributor

No description provided.

lrknox
lrknox reviewed Mar 28, 2024
View reviewed changes
src/H5FDdevelop.h Outdated Show resolved Hide resolved
lrknox
lrknox reviewed Mar 28, 2024
View reviewed changes
src/H5FDdevelop.h Outdated Show resolved Hide resolved
lrknox
lrknox reviewed Mar 28, 2024
View reviewed changes
src/H5FDdevelop.h Outdated Show resolved Hide resolved
lrknox
lrknox reviewed Mar 28, 2024
View reviewed changes
src/H5FDdevelop.h Outdated Show resolved Hide resolved
qkoziol
qkoziol reviewed Mar 28, 2024
View reviewed changes
Copy link
Contributor

@qkoziol qkoziol left a comment

Choose a reason for hiding this comment

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

Updating the comments is fine, but the new ones are redundantly similar. Maybe just leave the comments out entirely?

@derobins derobins added Merge - To 1.14 Priority - 2. Medium ⏹ It would be nice to have this in the next release Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality labels Mar 28, 2024
derobins
derobins reviewed Mar 28, 2024
View reviewed changes
src/H5FDdevelop.h
H5FD_mem_t fl_map[H5FD_MEM_NTYPES];
/**< Free-list map */
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't these be before the struct member?

Copy link
Contributor Author

@bmribler bmribler Mar 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

These are inline, so should be after, I believe. Because some have long comment and have to be on the next line, so I just wanted to make them all consistent.

bmribler and others added 4 commits March 28, 2024 10:25
@bmribler @lrknox
Update src/H5FDdevelop.h
62991af 
Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
@bmribler @lrknox
Update src/H5FDdevelop.h
4ef51cf 
Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
@bmribler @lrknox
Update src/H5FDdevelop.h
d89b4e2 
Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
@bmribler @lrknox
Update src/H5FDdevelop.h
d1a353f 
Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
@bmribler
Copy link
Contributor Author

Updating the comments is fine, but the new ones are redundantly similar. Maybe just leave the comments out entirely?

Thanks Quincey, but I don't quite understand your suggestion... The new ones are going to be in the documentation, where each item can be shown independently. Does this help in explaining the redundant similarity? If not, could you tell me what you meant?

@qkoziol
Copy link
Contributor

qkoziol commented Mar 28, 2024

Updating the comments is fine, but the new ones are redundantly similar. Maybe just leave the comments out entirely?

Thanks Quincey, but I don't quite understand your suggestion... The new ones are going to be in the documentation, where each item can be shown independently. Does this help in explaining the redundant similarity? If not, could you tell me what you meant?

Ah, OK, didn't realize that they could be displayed individually. Looks good then. :-)

@lrknox lrknox merged commit f24e811 into HDFGroup:develop Apr 1, 2024
54 checks passed
lrknox pushed a commit to lrknox/hdf5 that referenced this pull request Apr 1, 2024
@bmribler @lrknox
Add documentation (H5FD) (HDFGroup#4269)
0c5dbed
derobins added a commit that referenced this pull request Apr 1, 2024
@lrknox @derobins
@hyoklee @brtnfld @byrnHDF @jhendersonHDF @bmribler @fortnern
Sync develop changes March 28 - April 1 to 1 14 (#4297)
9f7b987 
* Relaxed behavior of H5Pset_page_buffer_size() when opening files (#4280)

This API call sets the size of a file's page buffer cache. This call
was extremely strict about matching its parameters to the file strategy
and page size used to create the file, requiring a separate open of the
file to obtain these parameters.

These requirements have been relaxed when using the fapl to open
a previously-created file:

* When opening a file that does not use the H5F_FSPACE_STRATEGY_PAGE
  strategy, the setting is ignored and the file will be opened, but
  without a page buffer cache. This was previously an error.

* When opening a file that has a page size larger than the desired
  page buffer cache size, the page buffer cache size will be increased
  to the file's page size. This was previously an error.

The behavior when creating a file using H5Pset_page_buffer_size() is
unchanged.

Fixes GitHub issue #3382

* chore: improve error message (#4287)

close #192

* changed to if string contains instead (#4286)

* Fix off_t straggers (#4291)

Convert off_t to HDoff_t (mainly for Windows):

* h5jam
* h5unjam
* chunk_info test

* Add missing foreach for VFD and Pasthrough runs (#4292)

* Fixes for file format security issues (#4283)

* Add configure options for disabling extension features (#4277)

Add configure option to enable or disable extension features in general

Add configure option to enable or disable _Float16 support

Add new config options to various settings files

* Add documentation (H5FD) (#4269)

* Use AOCC 4.2 and OpenMPI 4.1.6 (#4290)

* Fix problems with background buffers and array datatypes (#4218)

* Fix bug in array conversion with strided background buffer. Convert some
memmove calls to non-overlapping buffers to memcpy.

* Revert inappropriate use of mempy to memmove in H5T__conv_array

* Add testing

* Add RELEASE.txt note and overwrite test case.

* Synch workflows and require apt-get update (#4294)

* Fix Figure 9. table format in HDF5 Groups User Guide (#4295)

---------

Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com>
Co-authored-by: H. Joe Lee <hyoklee@hdfgroup.org>
Co-authored-by: Scot Breitenfeld <brtnfld@hdfgroup.org>
Co-authored-by: Allen Byrne <50328838+byrnHDF@users.noreply.github.com>
Co-authored-by: jhendersonHDF <jhenderson@hdfgroup.org>
Co-authored-by: bmribler <39579120+bmribler@users.noreply.github.com>
Co-authored-by: Neil Fortner <fortnern@gmail.com>
qkoziol pushed a commit to qkoziol/hdf5 that referenced this pull request Apr 2, 2024
@bmribler @qkoziol
Add documentation (H5FD) (HDFGroup#4269)
d2c2f5b
@bmribler bmribler deleted the add_doc_H5FD branch October 30, 2024 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qkoziol qkoziol qkoziol left review comments

@derobins derobins derobins left review comments

@byrnHDF byrnHDF byrnHDF approved these changes

@lrknox lrknox lrknox approved these changes

@fortnern fortnern Awaiting requested review from fortnern fortnern is a code owner

@jhendersonHDF jhendersonHDF Awaiting requested review from jhendersonHDF jhendersonHDF is a code owner

@vchoi-hdfgroup vchoi-hdfgroup Awaiting requested review from vchoi-hdfgroup vchoi-hdfgroup is a code owner

@glennsong09 glennsong09 Awaiting requested review from glennsong09 glennsong09 is a code owner

@mattjala mattjala Awaiting requested review from mattjala mattjala is a code owner

@brtnfld brtnfld Awaiting requested review from brtnfld brtnfld is a code owner

Assignees
No one assigned
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Improvement Improvements that don't add a new feature or functionality
Projects
Downstream HDF5 Merges
Status: Needs Merged
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bmribler @qkoziol @derobins @lrknox @byrnHDF