Replace ‘nightly_protocol_features’ with ‘nightly’ feature #6782
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
The ‘nightly_protocol’ and ‘nightly_protocol_features’ Cargo features are a bit confusing to new and old developers alike. They two are almost always paired together which raises the question why they are separate features. What’s worse, in test we often test for the ‘nightly_protocol’ feature with the assumption that ‘nightly_protocol_features’ is enabled as well. This may result in people trying to run tests with only the former feature and getting bogus test failures. But that’s not all. What makes situation even more confusing is that ‘nightly_protocol_features’ enables ‘nightly_protocol’ in most of the Cargo configuration. To simplify the most common case where both features are enabled, rename ‘nightly_protocol_features’ to ‘nightly’ and change it so that it always forces ‘nightly_protocol’ feature on. The less common case where a single protocol feature is tested (i.e. ’--features nightly_protocol,some_nightly_feature’) isn’t affected at all.
matklad
reviewed
May 11, 2022
matklad
approved these changes
May 11, 2022
|
Sorry, I broke your code by adding more cfg in a recent PR. This one: https://github.com/near/nearcore/pull/6784/files#diff-94a2066d3f4b7aa8071b052bdbbdf0e8b90e77f79c46a3c1358d3c10e863511cR240 |
rtsai123
approved these changes
May 13, 2022
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.
The ‘nightly_protocol’ and ‘nightly_protocol_features’ Cargo features
are a bit confusing to new and old developers alike. They two are
almost always paired together which raises the question why they are
separate features.
What’s worse, in test we often test for the ‘nightly_protocol’ feature
with the assumption that ‘nightly_protocol_features’ is enabled as
well. This may result in people trying to run tests with only the
former feature and getting bogus test failures.
But that’s not all. What makes situation even more confusing is that
‘nightly_protocol_features’ enables ‘nightly_protocol’ in most of the
Cargo configuration.
To simplify the most common case where both features are enabled,
rename ‘nightly_protocol_features’ to ‘nightly’ and change it so that
it always forces ‘nightly_protocol’ feature on.
The less common case where a single protocol feature is tested
(i.e. ’--features nightly_protocol,some_nightly_feature’) isn’t
affected at all.