[c++] Define and expose PULSAR_VERSION macro #12769
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
massakam
commented
Nov 12, 2021
| @@ -20,7 +20,7 @@ | |||
| file(GLOB PULSAR_SOURCES *.cc *.h lz4/*.cc lz4/*.h checksum/*.cc checksum/*.h stats/*.cc stats/*.h c/*.cc c/*.h auth/*.cc auth/*.h auth/athenz/*.cc auth/athenz/*.h) | |||
|
|
|||
| execute_process(COMMAND python ${CMAKE_SOURCE_DIR}/../src/get-project-version.py OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE PV) | |||
| set (CMAKE_CXX_FLAGS " ${CMAKE_CXX_FLAGS} -D_PULSAR_VERSION_=\\\"${PV}\\\"") | |||
| set (CMAKE_CXX_FLAGS " ${CMAKE_CXX_FLAGS} -D_PULSAR_VERSION_INTERNAL_=\\\"${PV}\\\"") | |||
There was a problem hiding this comment.
I renamed this existing macro to avoid confusion with the macro added this time.
merlimat
approved these changes
Nov 14, 2021
| #define LIB_VERSION_INTERNAL_H_ | ||
|
|
||
| #ifndef _PULSAR_VERSION_INTERNAL_ | ||
| #define _PULSAR_VERSION_INTERNAL_ "1.17" |
There was a problem hiding this comment.
1.17 is a concrete (and very old) version. Should we instead use something link unknown or undefined instead?
There was a problem hiding this comment.
@merlimat Changed the default value to unknown.
nkurihar
approved these changes
Nov 17, 2021
eolivelli
pushed a commit
to eolivelli/pulsar
that referenced
this pull request
Nov 29, 2021
* Define and expose PULSAR_VERSION macro * Change default value of _PULSAR_VERSION_INTERNAL_ to unknown
|
Add Ping @315157973 since you're the release manager of Pulsar 2.8.2. |
BewareMyPower
pushed a commit
that referenced
this pull request
Dec 10, 2021
* Define and expose PULSAR_VERSION macro * Change default value of _PULSAR_VERSION_INTERNAL_ to unknown
BewareMyPower
added a commit
that referenced
this pull request
Dec 15, 2021
…3324) ### Motivation When I build C++ tests on my local env, the following error happened. ``` tests/VersionTest.cc:19:10: fatal error: 'pulsar/Version.h' file not found #include <pulsar/Version.h> ``` It's because I specified another directory as CMake directory. ```bash mkdir _builds && cd _builds && cmake .. ``` After #12769, the `Version.h` is generated under `${CMAKE_BINARY_DIR}/include/pulsar` directory but it's not included in `CMakeLists.txt`. CI works well because it's built in the default CMake directory so that `CMAKE_BINARY_DIR` is the same with `CMAKE_SOURCE_DIR`, which is included. ### Modifications Add the `${CMAKE_BINARY_DIR}/include` to `included_directories`.
fxbing
pushed a commit
to fxbing/pulsar
that referenced
this pull request
Dec 19, 2021
* Define and expose PULSAR_VERSION macro * Change default value of _PULSAR_VERSION_INTERNAL_ to unknown
fxbing
pushed a commit
to fxbing/pulsar
that referenced
this pull request
Dec 19, 2021
…ache#13324) ### Motivation When I build C++ tests on my local env, the following error happened. ``` tests/VersionTest.cc:19:10: fatal error: 'pulsar/Version.h' file not found #include <pulsar/Version.h> ``` It's because I specified another directory as CMake directory. ```bash mkdir _builds && cd _builds && cmake .. ``` After apache#12769, the `Version.h` is generated under `${CMAKE_BINARY_DIR}/include/pulsar` directory but it's not included in `CMakeLists.txt`. CI works well because it's built in the default CMake directory so that `CMAKE_BINARY_DIR` is the same with `CMAKE_SOURCE_DIR`, which is included. ### Modifications Add the `${CMAKE_BINARY_DIR}/include` to `included_directories`.
codelipenghui
pushed a commit
that referenced
this pull request
Dec 21, 2021
* Define and expose PULSAR_VERSION macro * Change default value of _PULSAR_VERSION_INTERNAL_ to unknown (cherry picked from commit 2dcf7e9)
codelipenghui
pushed a commit
that referenced
this pull request
Dec 21, 2021
…3324) ### Motivation When I build C++ tests on my local env, the following error happened. ``` tests/VersionTest.cc:19:10: fatal error: 'pulsar/Version.h' file not found #include <pulsar/Version.h> ``` It's because I specified another directory as CMake directory. ```bash mkdir _builds && cd _builds && cmake .. ``` After #12769, the `Version.h` is generated under `${CMAKE_BINARY_DIR}/include/pulsar` directory but it's not included in `CMakeLists.txt`. CI works well because it's built in the default CMake directory so that `CMAKE_BINARY_DIR` is the same with `CMAKE_SOURCE_DIR`, which is included. ### Modifications Add the `${CMAKE_BINARY_DIR}/include` to `included_directories`. (cherry picked from commit ca37e67)
zymap
pushed a commit
that referenced
this pull request
Dec 23, 2021
…3324) ### Motivation When I build C++ tests on my local env, the following error happened. ``` tests/VersionTest.cc:19:10: fatal error: 'pulsar/Version.h' file not found #include <pulsar/Version.h> ``` It's because I specified another directory as CMake directory. ```bash mkdir _builds && cd _builds && cmake .. ``` After #12769, the `Version.h` is generated under `${CMAKE_BINARY_DIR}/include/pulsar` directory but it's not included in `CMakeLists.txt`. CI works well because it's built in the default CMake directory so that `CMAKE_BINARY_DIR` is the same with `CMAKE_SOURCE_DIR`, which is included. ### Modifications Add the `${CMAKE_BINARY_DIR}/include` to `included_directories`. (cherry picked from commit ca37e67)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Pulsar Node.js client library is a wrapping of the C++ client library. If we add a new feature to the Node.js client that uses a recently implemented C function, users will be forced to upgrade the C++ client, even if they don't use that feature. Otherwise, a compile error will occur when installing the Node.js client.
Modifications
To solve the above issue, define and expose a macro named
PULSAR_VERSIONin the C++ client. The value ofPULSAR_VERSIONis an integer determined by the following calculation:For example, if the version of Pulsar is 2.8.1,
PULSAR_VERSIONis2008001.On the Node.js client side, we will no longer have to force users to upgrade the C++ client by using this macro as follows:
Verifying this change
Does this pull request potentially affect one of the following parts:
Documentation
no-need-doc