Update gitignore (again) #7
Merged
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
I think these are the basic folders/files we can ignore for all projects. Since we don't provide CMakePresets.json, ignore the user presets will allow users to create their own preset file and use it for the project. We could even add a "starter" one in the exemplar.
camio
reviewed
Sep 26, 2024
.gitignore
Outdated
| *build | ||
| *out |
There was a problem hiding this comment.
Can you explain the motivation for this entry?
There was a problem hiding this comment.
From what I've seen, it's idiomatic at times to use out/build as an output directory; especially when using CMake presets. This allows you to put your installation directory inside out as well (for testing purposes) without polluting your system environment.
So in some hypothetical preset:
{
"configurePresets" : [
{
"name": "base",
"hidden": true,
"generator": "Ninja",
"binaryDir": "${sourceDir}/out/build/${presetName}",
"installDir": "${sourceDir}/out/install/${presetName}",
"cacheVariables": {
"BUILD_TESTING": "ON",
"CMAKE_CXX_STANDARD": "23",
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
},
"architecture": {
"strategy": "external",
"value": "x64"
},
"toolset": {
"strategy": "external",
"value": "x64"
}
}
]
}| *build | ||
| *out | ||
| CMakeUserPresets.json |
There was a problem hiding this comment.
Would this entry better reside in a global .gitignore file (like where .*.swp would go)?
There was a problem hiding this comment.
We could, but then you rely on the developer to have that set up properly.
|
This looks ready to merge. |
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 think these are the basic folders/files we can ignore for all projects. Since we don't provide CMakePresets.json, ignore the user presets will allow users to create their own preset file and use it for the project. We could even add a "starter" one in the exemplar.