Change option version #16373
Change option version #16373
Conversation
| @@ -55,15 +55,15 @@ public class CodeStyleOptions | |||
| public static readonly PerLanguageOption<CodeStyleOption<bool>> PreferIntrinsicPredefinedTypeKeywordInDeclaration = new PerLanguageOption<CodeStyleOption<bool>>(nameof(CodeStyleOptions), nameof(PreferIntrinsicPredefinedTypeKeywordInDeclaration), defaultValue: TrueWithNoneEnforcement, | |||
| storageLocations: new OptionStorageLocation[]{ | |||
| new EditorConfigStorageLocation("dotnet_style_predefined_type_for_locals_parameters_members"), | |||
| new RoamingProfileStorageLocation("TextEditor.%LANGUAGE%.Specific.PreferIntrinsicPredefinedTypeKeywordInDeclaration")}); | |||
| new RoamingProfileStorageLocation("TextEditor.%LANGUAGE%.Specific.PreferIntrinsicPredefinedTypeKeywordInDeclaration.Dev15")}); | |||
There was a problem hiding this comment.
Given this would be used for any mythical post-Dev15 thing, perhaps call it it .CodeStyle or something as a more agnostic suffix?
(I'm getting visions of Common7 all over again.)
There was a problem hiding this comment.
I'm happy to change it. I chose Dev15 because this option will only be persisted to machines with Dev15 or newer. Code Style is fine though.
|
How does this work with "Reset Settings", and the shipping .vssettings files? They go through the automation object - will they still be applied properly? |
|
Should target |
in Dev14 these options were persisted as booleans. They are now persisted as xml in Dev15. The fix is to not have the persistence keys overlap, ensuring Dev14 will not try to deserialize Dev15 options and vice versa
jmarolf
force-pushed
the
bugix/options-serialization
branch
from
400b1e4
to
d8a1b96
Compare
|
@Pilchie .vssettings files will need to be updated if we want reset to work. If you Reset Settings in VS 2017 it does not change any of the code style settings. With this change the default settings |
|
retest linux_debug_prtest please |
|
@jasonmalinowski care to take another look? @jmarolf made the suggested rename. @MattGertz for shiproom consideration. |
|
@jmarolf, just so I understand, we're renaming the .vssettings file since the underlying format changed (Boolean to codestyle) that even if we didn't rename it they wouldn't practically apply from one to the other? Since there are extra type guards I don't think the .vssettings change is necessary. And if we care about applying old team settings forward, actually hinders fixing that. But I'm not sure it's important either way. |
|
Approved to merge |
Customer scenario
Customer changes setting on a VS 2017 Machine and then their settings on their VS 2015 machine stop syncing and they receive an error message
Customer changes setting on a VS 2015 Machine and then their settings on their VS 2017 machine stop syncing and they receive an error message
Bugs this fixes:
#13556
#15076
#273302
Workarounds, if any
Do not roam any settings between VS 2015 or VS 2017. If you roam settings on VS 2015 do not roam them on VS 2017.
Risk
Low, we are changing a key name.
Performance impact
None, we are changing a key name.
Is this a regression from a previous update?
Yes, you could previously roam settings between versions
Root cause analysis:
in Dev14 these options were persisted as booleans. They are now persisted as xml in Dev15. The fix is to not have the persistence keys overlap, ensuring Dev14 will not try to deserialize Dev15 options and vice versa
How was the bug found?
Customer reported and found via ad-hoc testing
@Pilchie @jasonmalinowski @dotnet/roslyn-ide