Add defines for OQS version components #2000
Conversation
There was a problem hiding this comment.
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"?
| @@ -219,7 +219,11 @@ static void print_oqs_configuration(void) { | |||
| * USE_SANITIZER: -fsanitize= option present in compile options | |||
| * OQS_ENABLE_TEST_CONSTANT_TIME: only shown below | |||
| */ | |||
| printf("OQS version: %s\n", OQS_VERSION_TEXT); | |||
| #if defined(OQS_VERSION_PRE_RELEASE) | |||
There was a problem hiding this comment.
Is the idea to completely drop this define when doing a release then? Or if just setting an empty pre-release string is that equal to!defined? Maybe worth while adding proposed wording for the changes to the Release wiki in the comment?
There was a problem hiding this comment.
I've updated the release wiki to explain what's going on here. I don't have an opinion one way or the other whether it is better for OQS_VERSION_PRE_RELEASE to be defined-but-empty or undefined for releases.
I've now added documentation comments in |
Signed-off-by: Douglas Stebila <[email protected]>
Co-authored-by: Spencer Wilson <[email protected]> Signed-off-by: Douglas Stebila <[email protected]> Signed-off-by: Douglas Stebila <[email protected]>
Co-authored-by: Spencer Wilson <[email protected]> Signed-off-by: Douglas Stebila <[email protected]> Signed-off-by: Douglas Stebila <[email protected]>
Signed-off-by: Douglas Stebila <[email protected]>
dstebila
force-pushed
the
ds-version-defines
branch
from
cba50f9
to
33065bc
Compare
Fixes #1993.
Note that I had to use
#definerather than#cmakedefinein oqsconfig.h.cmake to avoid it not setting the macros when the values are equal to a false-y value like0or"".