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 BUILD_TESTS Flag to Readme for CMake [skip ci] #5973

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

wienans
Copy link
Contributor

@wienans wienans commented Feb 12, 2024

See title as i was developing on Linux didn't found the option for building the test binary. With some feedback and examination of the Actions i found that the BUILD_TESTS flag should be enabled. Added that to Readme.

@firewave firewave changed the title Add BUILD_TESTS Flag to Readme for CMake Add BUILD_TESTS Flag to Readme for CMake [skip ci] Feb 12, 2024
@firewave
Copy link
Collaborator

firewave commented Feb 12, 2024

Thanks for your contribution.

I wanted to comment that this does not need to be documented as it is a regular CMake option but that is not correct.

The option I was thinking of if actually BUILD_TESTING: https://cmake.org/cmake/help/latest/module/CTest.html. We should deprecate the existing one and move to the common one.

As there are many more options you could set the documentation should point to the option() entries in cmake/options.cmake. Unfortunately there appears to be no way to generate a list of those. Calling cmake -LAH also includes all cached variables which makes things more complicated.

@danmar danmar merged commit 8c87b4b into danmar:main Feb 12, 2024
64 checks passed
@wienans wienans deleted the patch-1 branch February 12, 2024 16:29
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.

3 participants