generated from NOAA-OWP/owp-open-source-project-template
-
Notifications
You must be signed in to change notification settings - Fork 63
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
Runtime debug information #679
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
program--
added
enhancement
New feature or request
build
Issues related to CMake and building ngen
labels
Nov 20, 2023
program--
commented
Nov 20, 2023
program--
commented
Nov 20, 2023
program--
commented
Nov 20, 2023
program--
commented
Nov 20, 2023
PhilMiller
reviewed
Nov 20, 2023
PhilMiller
reviewed
Nov 20, 2023
Other than my comment on |
PhilMiller
reviewed
Nov 20, 2023
PhilMiller
reviewed
Nov 21, 2023
PhilMiller
reviewed
Nov 21, 2023
Co-authored-by: Phil Miller - NOAA <philip.miller@noaa.gov>
PhilMiller
approved these changes
Nov 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the capability to call
ngen --info
to provide debugging information regarding the user's environment at runtime, instead of only at build-time. This is to address the main concern of providing support to users where the capabilities of their executable are not provided, i.e. NGIAB containers.Example Output
Additions
ngen::exec_info
that hasconstexpr
information for version, flags, configure-time build summary, and a runtime summary function.Changes
CMakeLists.txt
to capture the output of the build summary.CMakeLists.txt
to configure the header at the end of the file, rather than after project definition.#include <list>
toinclude/core/nexus/HY_PointHydroNexusRemote.hpp
as this gave a compilation issue with clang 16.ngen::main()
to support callingngen --info
without running a workflow.Testing
Manually tested output of
ngen info
using GCC 13, clang 16, and IntelLLVM.Notes/TODO
Getting information about t-route when
NGEN_WITH_ROUTING=ON
would be useful, however, it's a bit tricky since t-route does not version its python package, and since it defaults to an editable install. May need a bit more thinking about how this would be implemented, i.e. hash all package files to get a combined "package hash"?A follow-on PR organizing the
main
function is probably needed, I think we should begin taking a look at how to better organize our CLI component, e.g. use GNUgetopt
?Checklist