summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharlie Swanson <charlie.swanson@mongodb.com>2023-02-10 10:49:02 -0500
committerGitHub <noreply@github.com>2023-02-10 10:49:02 -0500
commit5750f0d4dd1a5b89b814ab77a3555a81a31666c1 (patch)
tree5c110ed71b5d68cf32d02cd09a5c9a188574264b
parentf15f2bf8958557b4e8fccc6e8e1c7c8c5834d209 (diff)
downloadmongo-5750f0d4dd1a5b89b814ab77a3555a81a31666c1.tar.gz
Add some feature flag tagging explanation
-rw-r--r--src/mongo/db/repl/FCV_AND_FEATURE_FLAG_README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/mongo/db/repl/FCV_AND_FEATURE_FLAG_README.md b/src/mongo/db/repl/FCV_AND_FEATURE_FLAG_README.md
index cf5fa1a54fa..c3ca6448e21 100644
--- a/src/mongo/db/repl/FCV_AND_FEATURE_FLAG_README.md
+++ b/src/mongo/db/repl/FCV_AND_FEATURE_FLAG_README.md
@@ -423,7 +423,10 @@ be enabled by default for testing purposes on the Evergreen variants marked as "
* If you have a JS test that depends on this feature flag being enabled, tag with a tag of the same
name as the feature flag in the format `featureFlagXX` (for example, `featureFlagToaster`). This
ensures that the test will only be run on the "all feature flags" variants where the feature flag is
-enabled.
+enabled. This works by virtue of the feature flag being declared in the codebase which will
+cause it to make its way into the all_feature_flags.txt file used by resmoke.py to control either
+which flags to enable for "all feature flags", or which tags (e.g. featureFlagXX) to skip when it is
+not running "all feature flags."
* Parallel test suite does not honor feature flag tags, due to which some tests may be
unexpectedly run in non-feature-flag build variants. If you want to skip such tests in
parallel suite, please add them to the exclusion list [here](https://github.com/mongodb/mongo/blob/eb75b6ccc62f7c8ea26a57c1b5eb96a41809396a/jstests/libs/parallelTester.js#L149).