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

Run-time API for compile-time provenance #1732

Open
2 tasks
jedbrown opened this issue Jan 16, 2025 · 0 comments
Open
2 tasks

Run-time API for compile-time provenance #1732

jedbrown opened this issue Jan 16, 2025 · 0 comments

Comments

@jedbrown
Copy link
Member

xSDK policy specifies

M8. Each package must provide a runtime API, for example a function call, to return the current
version number
of the software and indicate what configure/CMAKE and compiler options were used
to build the package. For development versions of the software, each package must provide the
current commit ID in the repository. With this information users should be able to rebuild the package
in the same state. We do not currently require that version information for all dependent packages be
provided, so it may not be possible to rebuild the entire software stack in the same state.

We provide CeedGetVersion() for release versions, but need to add:

  • CeedGetGitVersion() to return the output of git describe (or git rev-parse @). This should also probably indicate whether the build tree is dirty (since then it's not defined by the version, but I don't think we should refuse to build if the tree is dirty).
  • CeedGetBuildConfiguration() (name could be different) that reports compiler versions and flags.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant