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

Disable hl tools by default #2313

Merged
merged 5 commits into from
Dec 17, 2022
Merged

Conversation

byrnHDF
Copy link
Contributor

@byrnHDF byrnHDF commented Dec 16, 2022

No description provided.

@@ -301,6 +301,14 @@ Bug Fixes since HDF5-1.13.3 release

Configuration
-------------
- Change the default for building the high-level tools
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if it might be good to call out which tools are getting disabled here by default since I imagine some folks would want to know that building of h5watch is opt-in after this.

Copy link
Member

Choose a reason for hiding this comment

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

Agree. The tools are gif2hdf and hdf2gif as well as h5watch

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -301,6 +301,14 @@ Bug Fixes since HDF5-1.13.3 release

Configuration
-------------
- Change the default for building the high-level tools

The gif2hdf5, hdf2gif and h5watch high-level tools are deprecated and will be removed
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is h5watch really deprecated?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All three tools get disabled.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could split the line to make h5watch in a sentence by itself. A bit confusing though.

byrnHDF added a commit to byrnHDF/hdf5 that referenced this pull request Dec 16, 2022
@epourmal
Copy link

epourmal commented Dec 16, 2022 via email

@derobins
Copy link
Member

We shouldn’t be removing h5watch. What is the reason?

On Fri, Dec 16, 2022 at 3:26 PM Allen Byrne @.> wrote: @.* commented on this pull request. ------------------------------ In release_docs/RELEASE.txt <#2313 (comment)>: > @@ -301,6 +301,14 @@ Bug Fixes since HDF5-1.13.3 release Configuration ------------- + - Change the default for building the high-level tools + + The gif2hdf5, hdf2gif and h5watch high-level tools are deprecated and will be removed All three tools get disabled. — Reply to this email directly, view it on GitHub <#2313 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADLFT3L4OBKE22FLRHISYL3WNTM7FANCNFSM6AAAAAATBJDVC4 . You are receiving this because you are subscribed to this thread.Message ID: @.***>

It's just an artifact from disabling the gif tools. It's not being deprecated. The text just needs some improvement.

Copy link
Collaborator

@lrknox lrknox left a comment

Choose a reason for hiding this comment

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

See RELEASE note suggestions. At least the names should be corrected. The new option works for autotools configure. I assume disabling hl-tools will disable all three irrespective of the new option, but haven't tried that yet.

- Change the default for building the high-level tools

The gif2hdf5 and hdf2gif high-level tools are deprecated and will be removed
in a future release. The default build setting for them have been changed from enabled
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
in a future release. The default build setting for them have been changed from enabled
in a future release. The default build setting for them has been changed from enabled

to disabled. A user can enable the build of these tools if needed.
autotools: --enable-hlgiftools
cmake: HDF5_BUILD_HL_GIF_TOOLS=ON

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The gif2h5 and h52gif tools were previously enabled or disabled by the --enable-hltools / HDF5_BUILD_HL_TOOLS option. That option also controlled building and installing the h5watch tool, which will continue to be built and installed by default but may be disabled using that option.

@@ -301,6 +301,16 @@ Bug Fixes since HDF5-1.13.3 release

Configuration
-------------
- Change the default for building the high-level tools

The gif2hdf5 and hdf2gif high-level tools are deprecated and will be removed
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The gif2hdf5 and hdf2gif high-level tools are deprecated and will be removed
The gif2h5 and h52gif high-level tools are deprecated and will be removed

derobins pushed a commit that referenced this pull request Dec 17, 2022
* Disable hl tools by default #2313

* Only gif tools are deprecated

* Update autotools
@derobins derobins merged commit 149b8e9 into HDFGroup:develop Dec 17, 2022
derobins added a commit to derobins/hdf5 that referenced this pull request Dec 20, 2022
c1e44d3 Fix doxygen warnings and remove javadocs (HDFGroup#2324)
149b8e9 Disable hl tools by default (HDFGroup#2313)
derobins added a commit that referenced this pull request Dec 21, 2022
* Brings the following changesets over from develop:

b9244a8 Align arg types of H5D_chunk_iter_op_t with H5Dget_chunk_info (#2074)
70cf2c3 Removed idioms and misc. text clean-up (#2320)
8102fa8 Only document Fortran functions (#2319)
784061b moved onion VFD to FAPL group (#2321)
6b6bcde Hdffv 11052 (#2315)
10c693a Update hdf5_header.html
0cb5808 Hdffv 11052 (#2303)
a1c81ed added doc. warning for H5Literate_async return value (#2295)
502b32b Updated H5ES documenation (#2293)
a903600 Fix for HDFFV-11052: h5debug fails on a corrupted file (h5_nrefs_POC)… (#2291)

* Brings the following changes over from develop:

c1e44d3 Fix doxygen warnings and remove javadocs (#2324)
149b8e9 Disable hl tools by default (#2313)
@byrnHDF byrnHDF deleted the develop-hl-default branch January 27, 2023 13:42
brtnfld pushed a commit to brtnfld/hdf5 that referenced this pull request May 17, 2023
* Disable hl tools by default

* identify the tools

* Only GIF tools are depecated

* Add new option

* Update autotools
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants