Prevent VCS thrashing - Use platform-independent paths in OpenVRSettings #112
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
`OpenVRSettings` rewrites the `Assets/XR/Settings/Open VR Settings.asset` on project startup; it continues where the original fix to ValveSoftware#11 left off. This change avoids inconsistent serialization across platforms, preventing VCS conflicts between team-members across Linux / Windows / Mac editor targets. As the Unity built-in VCS integration does not understand the concept of path equivalence, this avoids conflicts in naive "sync" workflows and unnecessary differences in working trees. Serialized formats for cross-platform files should not use `System.IO.Path.DirectorySeparatorChar` unless they replace it during encoding and substitute the consistent variant during decoding. As all target platforms for the editor support forward-slash paths, a constant avoids the whole issue. Additionally, this PR: - Eliminates an unnecessary side-effect-free computation of a new path when not in the editor - Corrects inconsistent usage of indentation (`Awake` was indented with tabs while the rest was spaces)
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.
OpenVRSettingsrewrites theAssets/XR/Settings/Open VR Settings.asseton project startup; it continues where the original fix to #11 left off.This change avoids inconsistent serialization across platforms, preventing VCS conflicts between team-members across Linux / Windows / Mac editor targets.
As the Unity built-in VCS integration does not understand the concept of path equivalence, this avoids conflicts in naive "sync" workflows and unnecessary differences in working trees.
Serialized formats for cross-platform files should not use
System.IO.Path.DirectorySeparatorCharunless they replace it during encoding and substitute the consistent variant during decoding. As all target platforms for the editor support forward-slash paths, a constant avoids the whole issue.Additionally, this PR:
Awakewas indented with tabs while the rest was spaces)