Avoid modifying source files in tests/standalone if they have not changed #3072
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.
This fixes a problem relating to the build script of the
crates/tests/standalone
crate. This build script runs bindgen on a variety of inputs and generates source code.The problem is that the build script modifies source code during a build script, and does so unconditionally. Because this process is relatively slow, these filesystem writes sometimes interfere with Git operations, because Git sees the intermediate (partially modified) state of these source files. This has been a big hassle for me in running Git operations.
The solution is to provide an optional behavior for
windows-bindgen
, which will cause it to check the existing contents of a file and will only overwrite the file if the file's contents have changed. If they are the same, no further action is taken. This is not ideal -- it's not a good idea to have builds modifying source code -- but at least it only does so when the contents need to change. This avoids a lot of conflicts with Rust Analyzer, Git, etc.