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

Add helpful text to h5clear #3054

Closed
derobins opened this issue Jun 6, 2023 · 0 comments
Closed

Add helpful text to h5clear #3054

derobins opened this issue Jun 6, 2023 · 0 comments
Assignees
Labels
Component - Tools Command-line tools like h5dump, includes high-level tools Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Type - Improvement Improvements that don't add a new feature or functionality
Milestone

Comments

@derobins
Copy link
Member

derobins commented Jun 6, 2023

h5clear is used to remove the superblock mark that prevents opening a file without SWMR. This mark can be left if a process doesn't shut down cleanly.

The current h5clear usage output doesn't indicate what it's for. We should add this and make it very clear that h5clear is not a general repair tool and cannot fix file corruption.

@derobins derobins added Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Component - Tools Command-line tools like h5dump, includes high-level tools Type - Improvement Improvements that don't add a new feature or functionality labels Jun 6, 2023
hyoklee added a commit to hyoklee/hdf5 that referenced this issue Oct 11, 2023
@derobins derobins added this to the 1.14.3 milestone Oct 17, 2023
@bmribler bmribler assigned bmribler and unassigned glennsong09 Oct 17, 2023
bmribler added a commit to bmribler/hdf5_bmr23 that referenced this issue Oct 23, 2023
- Added text to the usage of h5clear to explain that this tool is not for fixing
corrupted files but simply for helping in the inspection of the damage.
- Fixed expected output for testing the modified usage.

Fixed GH HDFGroup#3054
derobins pushed a commit that referenced this issue Oct 23, 2023
- Added text to the usage of h5clear to explain that this tool is not for fixing
corrupted files but simply for helping in the inspection of the damage.
- Fixed expected output for testing the modified usage.

Fixed GH #3054
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Tools Command-line tools like h5dump, includes high-level tools Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Development

No branches or pull requests

3 participants