Skip to content

Document CMake options in a central location#6294

Merged
lrknox merged 1 commit intoHDFGroup:developfrom
jhendersonHDF:document_cmake_options
Mar 27, 2026
Merged

Document CMake options in a central location#6294
lrknox merged 1 commit intoHDFGroup:developfrom
jhendersonHDF:document_cmake_options

Conversation

@jhendersonHDF
Copy link
Copy Markdown
Collaborator

@jhendersonHDF jhendersonHDF commented Mar 17, 2026

No description provided.

@jhendersonHDF jhendersonHDF added the Component - Documentation Doxygen, markdown, etc. label Mar 17, 2026
@github-project-automation github-project-automation bot moved this to To be triaged in HDF5 - TRIAGE & TRACK Mar 17, 2026
jhendersonHDF
jhendersonHDF commented Mar 17, 2026
View reviewed changes
.github/workflows/netcdf.yml
-G Ninja \
--log-level=VERBOSE \
-DCMAKE_BUILD_TYPE=Release \
-DHDF5_ONLY_SHARED_LIBS:BOOL=ON \
Copy link
Copy Markdown
Collaborator Author

@jhendersonHDF jhendersonHDF Mar 17, 2026

Choose a reason for hiding this comment

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

HDF5_ONLY_SHARED_LIBS is an option mostly used internally and I'd like to avoid continuing to promote setting it since it confuses things and has odd interactions with cmake GUI programs.

jhendersonHDF
jhendersonHDF commented Mar 17, 2026
View reviewed changes
CMakeBuildOptions.cmake

option (HDF5_ENABLE_TRACE "Enable API tracing capability" OFF)
mark_as_advanced (HDF5_ENABLE_TRACE)
if (HDF5_ENABLE_TRACE)
Copy link
Copy Markdown
Collaborator Author

@jhendersonHDF jhendersonHDF Mar 17, 2026

Choose a reason for hiding this comment

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

This option no longer does anything.

jhendersonHDF
jhendersonHDF commented Mar 17, 2026
View reviewed changes
CMakeBuildOptions.cmake
option (HDF5_ENABLE_EMBEDDED_LIBINFO "Embed library info into executables" ON)
option (HDF5_ENABLE_EMBEDDED_LIBINFO "Embed library info into executables" OFF)
mark_as_advanced (HDF5_ENABLE_EMBEDDED_LIBINFO)
if (HDF5_ENABLE_EMBEDDED_LIBINFO)
Copy link
Copy Markdown
Collaborator Author

@jhendersonHDF jhendersonHDF Mar 17, 2026

Choose a reason for hiding this comment

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

This option doesn't do anything and it's not clear that it ever did.

jhendersonHDF
jhendersonHDF commented Mar 17, 2026
View reviewed changes
release_docs/INSTALL_CMake_options.md
Copy link
Copy Markdown
Collaborator Author

@jhendersonHDF jhendersonHDF Mar 17, 2026

Choose a reason for hiding this comment

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

While the CMake options were mostly documented in INSTALL_CMAKE.md, several were missing or were otherwise poorly documented. This documents most of them in a single place, with the main exception being that the filter options are discussed more in INSTALL_Filters.md since there is some complication/confusion around the interactions of the different options.

@jhendersonHDF jhendersonHDF marked this pull request as ready for review March 17, 2026 00:31
@brtnfld
Copy link
Copy Markdown
Collaborator

brtnfld commented Mar 17, 2026

I'm also wondering if these options should be moved to advanced?

HDF5_ENABLE_DEPRECATED_SYMBOLS
HDF5_ENABLE_NONSTANDARD_FEATURES
HDF5_ENABLE_NONSTANDARD_FEATURE_FLOAT16

niche features
HDFS, DIRECT, ROS3, MIRROR VFDs
HDF5_ENABLE_PLUGIN_SUPPORT

developer/CI
HDF5_DISABLE_COMPILER_WARNINGS
HDF5_ENABLE_WARNINGS_AS_ERRORS
HDF5_ENABLE_DEV_WARNINGS
HDF5_ENABLE_ALL_WARNINGS
HDF5_ENABLE_PROFILING
HDF5_ENABLE_OPTIMIZATION
HDF5_BUILD_DOC

@lrknox lrknox moved this from To be triaged to In progress in HDF5 - TRIAGE & TRACK Mar 17, 2026
@lrknox lrknox added this to the HDF5 2.2.0 milestone Mar 17, 2026
@jhendersonHDF
Copy link
Copy Markdown
Collaborator Author

jhendersonHDF commented Mar 17, 2026

I'm also wondering if these options should be moved to advanced?

HDF5_ENABLE_DEPRECATED_SYMBOLS HDF5_ENABLE_NONSTANDARD_FEATURES HDF5_ENABLE_NONSTANDARD_FEATURE_FLOAT16

niche features HDFS, DIRECT, ROS3, MIRROR VFDs HDF5_ENABLE_PLUGIN_SUPPORT

developer/CI HDF5_DISABLE_COMPILER_WARNINGS HDF5_ENABLE_WARNINGS_AS_ERRORS HDF5_ENABLE_DEV_WARNINGS HDF5_ENABLE_ALL_WARNINGS HDF5_ENABLE_PROFILING HDF5_ENABLE_OPTIMIZATION HDF5_BUILD_DOC

I think a reasonable case could be made for all of them except maybe HDF5_BUILD_DOC I'd leave visible.

@brtnfld
Copy link
Copy Markdown
Collaborator

brtnfld commented Mar 20, 2026

I think a reasonable case could be made for all of them except maybe HDF5_BUILD_DOC I'd leave visible.

Were you planning to do that in this PR?

@jhendersonHDF
Copy link
Copy Markdown
Collaborator Author

jhendersonHDF commented Mar 20, 2026

I think a reasonable case could be made for all of them except maybe HDF5_BUILD_DOC I'd leave visible.

Were you planning to do that in this PR?

I'll do this in a separate PR since it's mostly unrelated

brtnfld
brtnfld previously approved these changes Mar 20, 2026
View reviewed changes
lrknox
lrknox reviewed Mar 26, 2026
View reviewed changes
lrknox
lrknox reviewed Mar 26, 2026
View reviewed changes
lrknox
lrknox reviewed Mar 26, 2026
View reviewed changes
@jhendersonHDF jhendersonHDF force-pushed the document_cmake_options branch from 05a0060 to 7e9c85a Compare March 27, 2026 02:02
@jhendersonHDF jhendersonHDF requested review from brtnfld and lrknox March 27, 2026 02:09
@lrknox lrknox merged commit 994dbf6 into HDFGroup:develop Mar 27, 2026
137 checks passed
@github-project-automation github-project-automation bot moved this from In progress to Done in HDF5 - TRIAGE & TRACK Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brtnfld brtnfld brtnfld approved these changes

@lrknox lrknox lrknox approved these changes

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

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

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

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

@bmribler bmribler Awaiting requested review from bmribler bmribler 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

Assignees

@brtnfld brtnfld

@lrknox lrknox

@bmribler bmribler

Labels

Component - Documentation Doxygen, markdown, etc.

Projects

HDF5 - TRIAGE & TRACK
Status: Done

Milestone

HDF5 2.2.0

Development

Successfully merging this pull request may close these issues.

4 participants

@jhendersonHDF @brtnfld @lrknox @bmribler