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 defines for OQS version components #2000

Merged
merged 5 commits into from
Nov 26, 2024
Merged

Add defines for OQS version components #2000

merged 5 commits into from
Nov 26, 2024

Conversation

dstebila
Copy link
Member

Fixes #1993.

Note that I had to use #define rather than #cmakedefine in oqsconfig.h.cmake to avoid it not setting the macros when the values are equal to a false-y value like 0 or "".

@dstebila dstebila added this to the 0.12.0 milestone Nov 19, 2024
@dstebila dstebila self-assigned this Nov 19, 2024
@dstebila dstebila requested a review from baentsch as a code owner November 19, 2024 18:16
@dstebila dstebila requested a review from SWilson4 November 19, 2024 18:16
CMakeLists.txt Outdated Show resolved Hide resolved
src/oqsconfig.h.cmake Outdated Show resolved Hide resolved
tests/system_info.c Show resolved Hide resolved
Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

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

I'd think it'd be prudent document (progression and change logic of) these defines somewhere such as for users to know what they can rely on (e.g., is "OQS_VERSION_PRE_RELEASE" undefined an indication of a release?). Unsure where to best place it, though: Maybe in "CONFIGURE.md" or as comment atop "oqs.h"?

tests/system_info.c Show resolved Hide resolved
@dstebila
Copy link
Member Author

I'd think it'd be prudent document (progression and change logic of) these defines somewhere such as for users to know what they can rely on (e.g., is "OQS_VERSION_PRE_RELEASE" undefined an indication of a release?). Unsure where to best place it, though: Maybe in "CONFIGURE.md" or as comment atop "oqs.h"?

I've now added documentation comments in oqsconfig.h.cmake, which then get copied into the generated oqsconfig.h.

dstebila and others added 4 commits November 24, 2024 11:22
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
Co-authored-by: Spencer Wilson <spencer.wilson@uwaterloo.ca>
Signed-off-by: Douglas Stebila <dstebila@users.noreply.github.com>
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
Co-authored-by: Spencer Wilson <spencer.wilson@uwaterloo.ca>
Signed-off-by: Douglas Stebila <dstebila@users.noreply.github.com>
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
src/oqsconfig.h.cmake Outdated Show resolved Hide resolved
Signed-off-by: Douglas Stebila <dstebila@users.noreply.github.com>
@dstebila dstebila merged commit 3224d55 into main Nov 26, 2024
80 checks passed
@dstebila dstebila deleted the ds-version-defines branch November 26, 2024 13:12
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.

Create version #defines
3 participants