-
Notifications
You must be signed in to change notification settings - Fork 150
Rename the TESTING_BUILD macro to be _azure_TESTING_BUILD to highlight this is internal only and reduce chances of collision. #5390
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
Conversation
this is internal only and reduce chances of collision.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove any mentions of BUILD_TESTING cmake flag in our docs and cmake options. I've found two:
azure-sdk-for-cpp/CONTRIBUTING.md
Lines 135 to 137 in 93d8c12
<td>BUILD_TESTING</td> <td>Generates Unit Test for compilation. CMake will automatically download and build g-test.<br>After Compiling, use `ctest` to run Unit Test.</td> <td>OFF</td> option(BUILD_TESTING "Build test cases" OFF)
There probably should be a paragraph saying that when the project is build with unit tests, those SDK binaries that you get as a result of such build, should not be used by customer's code. They are for unit tests only.
I would not want to remove it from the contribution guide because then no new contribute or member of the project would know where to go to figure out steps to build the tests. The contributing guide is for that exact purpose. Instead, as part of #5335, I will add a note to clarify it isn't meant to be used in production when consuming the SDK, and only meant for contributors to the repo.
Agreed. |
antkmsft
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I think that'd work too.
…o UpdateCompilerDef
…highlight (Azure#5390)" This reverts commit 256c2df.
…R_TESTS` (#5416) * Revert "Remove the use of ifdef for TESTING_BUILD in KeyVault clients, where (#5406)" This reverts commit 2d8c940. * Revert "Rename the TESTING_BUILD macro to be _azure_TESTING_BUILD to highlight (#5390)" This reverts commit 256c2df. * Revert "Use new macros in existing surface area, so that classes marked as final don't have virtual methods. (#5389)" This reverts commit 3d7eadd. * Revert "For new surface area, classes marked as final should not have virtual methods. (#5331)" This reverts commit ddd0f4b. --------- Co-authored-by: Anton Kolesnyk <[email protected]>
Fixes #5334