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 presets cookbook and use cases #5323

Open
wants to merge 18 commits into
base: develop
Choose a base branch
from

Conversation

byrnHDF
Copy link
Contributor

@byrnHDF byrnHDF commented Feb 18, 2025

This adds three example CMakeUserPresets.json use cases and exposes the basic settings/options used by the CMakePresets.json file.

Doxygen updated to 1.13.2 - CI versions changed
Also fixes doxygen links so linkchecker and doxygen do not fail

@@ -208,7 +208,7 @@ list the specific new feature that they were added for.
\subsubsection subsubsec_rel_spec_112_change_0versus10_6_compat API Compatibility
See API Compatibility Macros in HDF5 for details on using HDF5 version 1.12 with previous releases.

[Compatibility report for Release 1.12.0 versus Release 1.10.6](Compatibility report for Release 1.12.0 versus Release 1.10.6)
[Compatibility report for Release 1.12.0 versus Release 1.10.6]()
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right - I plan a followup PR to address all the pre-1.14 reports - this change was just to fix the linkchecker temporarily.

# of a run, in case a WARN_LOGFILE is defined the warning messages will be
# besides being in the defined file also be shown at the end of a run, unless
# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
# the behavior will remain as with the setting FAIL_ON_WARNINGS.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Overly long sentence here, it may be easier to understand if it is structured as a bulleted list with as many levels of indentation as needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These are doxygen comments and were copied verbatim to match doxygen defaults - thereby not creating unneeded conflicts when doxygen changes things in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants