Skip to content

Commit

Permalink
Add documentation about OQS_VERSION macros
Browse files Browse the repository at this point in the history
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
  • Loading branch information
dstebila committed Nov 24, 2024
1 parent 47df8b5 commit 33065bc
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/oqsconfig.h.cmake
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
// SPDX-License-Identifier: MIT

/**
* Version of liboqs as a string. Equivalent to {MAJOR}.{MINOR}.{PATCH}{PRE_RELEASE}
*/
#cmakedefine OQS_VERSION_TEXT "@OQS_VERSION_TEXT@"
/**
* Version levels of liboqs as integers.
*/
#define OQS_VERSION_MAJOR @OQS_VERSION_MAJOR@
#define OQS_VERSION_MINOR @OQS_VERSION_MINOR@
#define OQS_VERSION_PATCH @OQS_VERSION_PATCH@
/**
* OQS_VERSION_PRE_RELEASE is defined if this is a pre-release version of liboqs, otherwise it is empty.
* Examples: "-dev" or "-rc1".
*/
#cmakedefine OQS_VERSION_PRE_RELEASE "@OQS_VERSION_PRE_RELEASE@"

#cmakedefine OQS_COMPILE_BUILD_TARGET "@OQS_COMPILE_BUILD_TARGET@"
#cmakedefine OQS_DIST_BUILD 1
#cmakedefine OQS_DIST_X86_64_BUILD 1
Expand Down

0 comments on commit 33065bc

Please sign in to comment.