[include-cleaner] Add --fail-on-changes option #140123
Open
Conversation
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
|
@llvm/pr-subscribers-clang-tools-extra Author: Daan De Meyer (DaanDeMeyer) ChangesWhen integrating clang-include-cleaner into a test suite, it's useful to have it exit with a nonzero exit status when there are suggested changes to includes so let's add --fail-on-changes to make that possible. Full diff: https://github.com/llvm/llvm-project/pull/140123.diff 1 Files Affected:
diff --git a/clang-tools-extra/include-cleaner/tool/IncludeCleaner.cpp b/clang-tools-extra/include-cleaner/tool/IncludeCleaner.cpp
index 372ab5fa2706e..47e1400d8ccb2 100644
--- a/clang-tools-extra/include-cleaner/tool/IncludeCleaner.cpp
+++ b/clang-tools-extra/include-cleaner/tool/IncludeCleaner.cpp
@@ -115,6 +115,11 @@ cl::opt<bool> DisableRemove{
cl::init(false),
cl::cat(IncludeCleaner),
};
+cl::opt<bool> FailOnChanges{
+ "fail-on-changes",
+ cl::desc("Exit with a non-zero exit code if changes are suggested"),
+ cl::cat(IncludeCleaner),
+};
std::atomic<unsigned> Errors = ATOMIC_VAR_INIT(0);
@@ -410,5 +415,5 @@ int main(int argc, const char **argv) {
}
}
}
- return ErrorCode || Errors != 0;
+ return ErrorCode || Errors != 0 || (FailOnChanges && Factory.editedFiles().size() != 0);
}
|
|
✅ With the latest revision this PR passed the C/C++ code formatter. |
When integrating clang-include-cleaner into a test suite, it's useful to have it exit with a nonzero exit status when there are suggested changes to includes so let's add --fail-on-changes to make that possible.
6f2a50a to
6e465cd
Compare
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.
When integrating clang-include-cleaner into a test suite, it's useful to have it exit with a nonzero exit status when there are suggested changes to includes so let's add --fail-on-changes to make that possible.