Add CMake validation and documentation for ACTIVE_NETWORK option#53
Open
yusufgurdogan wants to merge 2 commits intoBananoCoin:v28from
Open
Conversation
This change addresses build failures when invalid ACTIVE_NETWORK values are used. Previously, using an invalid value like "banano_live" (without the "_network" suffix) would result in a cryptic C++ enum error during compilation. Changes: 1. Added CMake validation that checks ACTIVE_NETWORK against the list of valid values and provides a clear, helpful error message with: - The invalid value that was provided - A complete list of valid options with descriptions - Example usage showing the correct format 2. Added comprehensive documentation in README.md including: - Valid ACTIVE_NETWORK values in a table format - Descriptions of each network type - Common build configuration examples - Clear indication that banano_live_network is the default The validation now catches configuration errors early in the CMake phase rather than during compilation, significantly improving the developer experience.
The validation logic triggers an internal bug in cmake-format 0.6.13 that causes CI failures. Keeping the README documentation which is the most valuable part of this change.
16e6938 to
7e5664e
Compare
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.
This change addresses build failures when invalid ACTIVE_NETWORK values are used. Previously, using an invalid value like "banano_live" (without the "_network" suffix) would result in a cryptic C++ enum error during compilation.
Changes:
Added CMake validation that checks ACTIVE_NETWORK against the list of valid values and provides a clear, helpful error message with:
Added comprehensive documentation in README.md including:
The validation now catches configuration errors early in the CMake phase rather than during compilation, significantly improving the developer experience.