[Xamarin.Android.Build.Tasks] Make XA0115 error more actionable #2967
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
brendanzagaeski
requested review from
dellis1972,
jonathanpeppers and
jonpryor
as code owners
brendanzagaeski
force-pushed
the
armeabi-removal-message-3
branch
from
3a997ed
to
36105e2
Compare
jonpryor
reviewed
Apr 11, 2019
| @@ -7,9 +7,13 @@ property will need to be updated to remove it before they will build | |||
| successfully with newer versions of Xamarin.Android. The newer armeabi-v7a ABI | |||
| should now be used instead. The `$(AndroidSupportedAbis)` setting can be found | |||
| in the **Advanced** section of the **Android Options** project properties in | |||
| Visual Studio and **Android Build** project properties in Visual Studio for Mac. | |||
| Visual Studio and the **Advanced** tab of the **Android Build** project | |||
There was a problem hiding this comment.
We have an entire file (and eventually URL) here. Let's take advantage of it. :-)
Please add separate # Sections so separately address Visual Studio for Windows vs. macOS. Screenshots may be helpful.
|
|
||
| Example message: | ||
| - `Invalid value 'armeabi' in $(AndroidSupportedAbis). This ABI is no longer supported. Please update your project properties.` | ||
|
|
||
| * `Invalid value 'armeabi' in $(AndroidSupportedAbis). This ABI is no longer supported. Please update your project properties to remove the old value. If the properties page does not show an 'armeabi' checkbox, un-check and re-check one of the other ABIs and save the changes.` |
There was a problem hiding this comment.
I think you should also show an example of the XML in the csproj file. Sometimes that will be clear to devs, because they will view the diff of their csproj in whichever source control they use.
Context: https://forums.xamarin.com/discussion/146174/vs2019-error-this-abi-is-no-longer-supported Context: https://developercommunity.visualstudio.com/comments/485766/view.html Change the wording of the armeabi build error to make it more actionable at the cost of also making it a bit longer. In addition to the questions about this error from users on the forums and Developer Community, another motivation for this change is that compared to back when I added the original wording for this message, I have now had more practice updating other error messages and thinking about how to make them as actionable as possible on their own. Unfortunately the correct action to take in the IDE in this case is a little confusing because the property page in Visual Studio on Windows is currently different from the property page in Visual Studio for Mac. For example, in Visual Studio for Mac, the **Advanced** tab of the **Android Build** page will show a checkbox for `armeabi` if that setting is present in the `$(AndroidSupportedAbis)` property in the `.csproj` file, so users can just un-check that option to remove the `armeabi` value. But on Windows, the **Advanced** modal window under the **Android Options** page now *never* shows a checkbox for `armeabi`, so the easiest way to remove the value is to change and change back one of the other ABIs and save the properties. That rewrites `$(AndroidSupportedAbis)` to contain only the values that are *shown* as selected in the modal window.
brendanzagaeski
force-pushed
the
armeabi-removal-message-3
branch
from
36105e2
to
cde1b90
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Context: https://forums.xamarin.com/discussion/146174/vs2019-error-this-abi-is-no-longer-supported
Context: https://developercommunity.visualstudio.com/comments/485766/view.html
Change the wording of the armeabi build error to make it more actionable
at the cost of also making it a bit longer.
In addition to the questions about this error from users on the forums
and Developer Community, another motivation for this change is that
compared to back when I added the original wording for this message, I
have now had more practice updating other error messages and thinking
about how to make them as actionable as possible on their own.
Unfortunately the correct action to take in the IDE in this case is a
little confusing because the property page in Visual Studio on Windows
is currently different from the property page in Visual Studio for Mac.
For example, in Visual Studio for Mac, the Advanced tab of the
Android Build page will show a checkbox for
armeabiif thatsetting is present in the
$(AndroidSupportedAbis)property in the.csprojfile, so users can just un-check that option to remove thearmeabivalue. But on Windows, the Advanced modal window underthe Android Options page now never shows a checkbox for
armeabi,so the easiest way to remove the value is to change and change back one
of the other options and save the properties. That rewrites
$(AndroidSupportedAbis)to contain only the values that are shown asselected in the modal window.