Add a placeholder for the test-suite-externals directory #186
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
When setting up external sources within llvm-test-suite, that can either be done by checking out those sources in the test-suite-externals directory, or by setting a CMake variable to point at the source directory elsewhere. As the git repo itself doesn't contain any files in the test-suite-externals directory, no such directory exists in users checkouts, unless they manually create it (which feels brittle and can be prone to mistypings etc). Therefore, add a placeholder dummy file to force git to create the directory, making it more obvious to users where they can place external sources. The directory is ignored via .gitignore, so files or directories in this tree don't get added accidentally.
sjoerdmeijer
approved these changes
Dec 9, 2024
|
Won't this break checkouts for users already having a test-suite-externals directory in their clone? |
No - this doesn't come with an explicit intent of "create a new directory", it'll just add the |
fhahn
approved these changes
Dec 9, 2024
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 setting up external sources within llvm-test-suite, that can either be done by checking out those sources in the test-suite-externals directory, or by setting a CMake variable to point at the source directory elsewhere.
As the git repo itself doesn't contain any files in the test-suite-externals directory, no such directory exists in users checkouts, unless they manually create it (which feels brittle and can be prone to mistypings etc).
Therefore, add a placeholder dummy file to force git to create the directory, making it more obvious to users where they can place external sources. The directory is ignored via .gitignore, so files or directories in this tree don't get added accidentally.