Align build options and README with Beman Standard#246
Merged
steve-downey merged 4 commits intoJul 23, 2026
Merged
Conversation
neatudarius
marked this pull request as ready for review
July 16, 2026 07:11
neatudarius
force-pushed
the
cmake/skip-examples-standard-option
branch
from
July 16, 2026 07:12
9db915b to
4b2b763
Compare
Add Dependencies/Build Environment documentation per exemplar #417 so libraries satisfy beman-tidy cpp.min_std_version (#362) and document cmake.skip_tests/cmake.skip_examples options.
neatudarius
force-pushed
the
cmake/skip-examples-standard-option
branch
from
July 16, 2026 07:33
4b2b763 to
a5cdd62
Compare
2 tasks
neatudarius
changed the title
Keep the Dependencies list under How to Build per review feedback. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns this library’s CMake configuration knobs and build documentation with the Beman “standard” option naming expected by upcoming beman-tidy features, ensuring consistent CI/build behavior across the ecosystem.
Changes:
- Renames the test-build CMake option to
BEMAN_OPTIONAL_BUILD_TESTSand adds a new optionBEMAN_OPTIONAL_BUILD_EXAMPLES. - Gates
examples/onBEMAN_OPTIONAL_BUILD_EXAMPLES. - Updates README build/dependency documentation to reference the new option names and adds a “Build Environment” section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Documents build environment requirements and updates CMake option names for skipping tests/examples. |
| CMakeLists.txt | Introduces Beman-aligned build options and conditionally includes tests/examples based on those options. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
14
to
24
| option( | ||
| OPTIONAL_ENABLE_TESTING | ||
| "Enable building tests and test infrastructure" | ||
| BEMAN_OPTIONAL_BUILD_TESTS | ||
| "Enable building tests and test infrastructure. Default: ${PROJECT_IS_TOP_LEVEL}. Values: { ON, OFF }." | ||
| ${PROJECT_IS_TOP_LEVEL} | ||
| ) | ||
|
|
||
| option( | ||
| BEMAN_OPTIONAL_BUILD_EXAMPLES | ||
| "Enable building examples. Default: ${PROJECT_IS_TOP_LEVEL}. Values: { ON, OFF }." | ||
| ${PROJECT_IS_TOP_LEVEL} | ||
| ) |
Member
Author
There was a problem hiding this comment.
@steve-downey , I'm still proposing to do this change and align to the Beman Standard now. Do you agree?
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
CMakeLists.txt:18
- Renaming
OPTIONAL_ENABLE_TESTINGtoBEMAN_OPTIONAL_BUILD_TESTSis a breaking change for consumers that still pass-DOPTIONAL_ENABLE_TESTING=...(CMake will accept the cache entry but it will no longer affect the build). Consider adding a small compatibility shim that maps the old cache variable to the new option with a deprecation warning, so older build scripts/presets continue to work.
option(
BEMAN_OPTIONAL_BUILD_TESTS
"Enable building tests and test infrastructure. Default: ${PROJECT_IS_TOP_LEVEL}. Values: { ON, OFF }."
${PROJECT_IS_TOP_LEVEL}
)
| ) | ||
|
|
||
| if(OPTIONAL_ENABLE_TESTING) | ||
| if(BEMAN_OPTIONAL_BUILD_TESTS) |
steve-downey
approved these changes
Jul 23, 2026
This file contains hidden or 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
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.
Related to upcoming new beman-tidy features:
Changes in this library need to be fixed before releasing new beman-tidy including these features.