[llvm][llvm-lit] Hide --use-unique-output-file-name from --help #114812
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
I was too hasty landing an option whose only known use at this time is LLVM's own CI. We may be able to remove it before the next branch that would be the next llvm-lit release outside of llvm, but the timing may not work out. So I am hiding the option in case that were to happen.
|
@llvm/pr-subscribers-testing-tools Author: David Spickett (DavidSpickett) ChangesI was too hasty landing an option whose only known use at this time is LLVM's own CI. We may be able to remove it before the next branch that would be the next llvm-lit release outside of llvm, but the timing may not work out. So I am hiding the option in case that were to happen. Full diff: https://github.com/llvm/llvm-project/pull/114812.diff 1 Files Affected:
diff --git a/llvm/utils/lit/lit/cl_arguments.py b/llvm/utils/lit/lit/cl_arguments.py
index 3e5488f388ccfa..a401c9a09e081b 100644
--- a/llvm/utils/lit/lit/cl_arguments.py
+++ b/llvm/utils/lit/lit/cl_arguments.py
@@ -175,12 +175,15 @@ def parse_args():
type=lit.reports.TimeTraceReport,
help="Write Chrome tracing compatible JSON to the specified file",
)
+ # This option only exists for the benefit of LLVM's Buildkite CI pipelines.
+ # As soon as it is not needed, it should be removed. Its help text would be:
+ # When enabled, lit will add a unique element to the output file name,
+ # before the extension. For example "results.xml" will become
+ # "results.<something>.xml". The "<something>" is not ordered in any
+ # way and is chosen so that existing files are not overwritten. [Default: Off]
execution_group.add_argument(
"--use-unique-output-file-name",
- help="When enabled, lit will add a unique element to the output file name, "
- 'before the extension. For example "results.xml" will become '
- '"results.<something>.xml". The "<something>" is not ordered in any '
- "way and is chosen so that existing files are not overwritten. [Default: Off]",
+ help=argparse.SUPPRESS,
action="store_true",
)
execution_group.add_argument(
|
|
Has there been some opposition to the option being public, or was your intention always for it to be internal to LLVM only? |
It's a bit of both, I shouldn't have merged it as soon as I did. My intention was that it would be broadly useful but at this time there is only one known user of it, which would be us i the Buildkite CI. This was raised on follow up patches: #113447 (comment) My survey of use on GitHub showed that while it has been a problem for external lit users, they have usually solved it by refactoring the pipeline which brings other benefits with it (#113447 (comment)). This is something LLVM should do as well, but I'm told we may be moving the CI soon, so if I want to improve things in the short term I needed something low impact. I went through a bunch of alternatives that didn't need a new option, but there was only one other viable option which is wrapping lit in another script. Small chance we go with that and I revert the option altogether, still waiting for confirmation either way on that. So this time I will not be so hasty merging this :) If this goes ahead, my plan would be to remove this option as soon as LLVM's own CI does not need it. Hiding it means if it ends up in lit 20 on pypi then we have done as much as we can to make sure external users don't rely on it. |
ldionne
approved these changes
Nov 4, 2024
boomanaiden154
approved these changes
Nov 10, 2024
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/183/builds/6149 Here is the relevant piece of the build log for the reference |
Groverkss
pushed a commit
to iree-org/llvm-project
that referenced
this pull request
Nov 15, 2024
…#114812) I was too hasty landing an option whose only known use at this time is LLVM's own CI. We may be able to remove it before the next branch that would be the next llvm-lit release outside of llvm, but the timing may not work out. So I am hiding the option in case that were to happen.
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.
I was too hasty landing an option whose only known use at this time is LLVM's own CI.
We may be able to remove it before the next branch that would be the next llvm-lit release outside of llvm, but the timing may not work out.
So I am hiding the option in case that were to happen.