Fix compile errors after renaming files, related to unsaved changes in the sketch #4358
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
When a sketch has unsaved changes, a temporary copy of the sketch is made with those changes applied. This copy is then passed to arduino-builder. Previously, this temporary copy was kept around and only deleted when the IDE was closed. However, all files were written to it again on every build, so keeping the old files around did not serve any real purpose. When a file was renamed in the IDE, the original name would still be present in the temporary copy, and could cause linker errors because both were compiled. This commit makes sure the temporary copy is deleted after every build, instead of at IDE exit, which fixes this problem with renames. When a file is deleted from the sketch, the file would also be deleted from the temporary copy, presumably to fix this same problem for deletes (but renames were forgotten). With this commit, this special handling for deleting files is no longer needed, so it is removed. This fixes arduino#4335
When a sketch has unsaved changes, a temporary copy of the sketch is made with those changes applied. This copy is then passed to arduino-builder. Previously, the name of this directory contained a hash of the main sketch filename, so the same directory would be used between builds. Now that this directory is deleted after every build, it can just use a randomized directory name, which is what this commit does. Addtionally, the prefix used for generating the name is changed from "arduino_" to "arduino_modified_sketch_" to make it slightly clearer what the directory is for (just in case it somehow survives the build, or a user sees it during the build).
|
If a sketch has many .cpp files, will this change force them to all be rebuild even if only the main .ino has changed? |
|
Nope, currently arduino-builder currently compares the contents of all files in this temporary directory with their copies in the build directory, and only copies/recompiles them if they actually changed (disregarding the timestamps on the files). See these comments for some more details: This PR does not implement the additional improvement suggested in the first comment, it just fixes the problem without needing changes to arduino-builder. |
|
LGTM 👍 |
cmaglie
added
Component: IDE
Closed
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.
Fix #4335 by always deleting the temporary sketch copy after every build. With that, the name of that directory can be random again, instead of needing to be deterministic using a hash of the main sketch filename.