[mono-api-html] Expand "ignore" functionality #7154
Merged
Conversation
This file contains hidden or 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
Context: dotnet/android#1078 xamarin-android uses `mono-api-html` and `mono-api-info` in order to perform API comparisons; see e.g. 4e45904. A recent problem has arisen regarding "inter-API-level diffs": there are many API changes which we consider to be acceptable, and thus would like to ignore. Unfortunately, `mono-api-html` doesn't support ignoring many of these constructs, e.g. base class changes: <h3>Type Changed: Android.Preferences.CheckBoxPreference</h3> Modified base type: <span class='removed removed-inline removed-breaking-inline'>Android.Preferences.Preference</span> <span class='added '>Android.Preferences.TwoStatePreference</span> and property type changes: <h3>Type Changed: Android.Views.InputEvent</h3> <p>Modified properties:</p> <pre> <div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> int DeviceId { get; } </div><div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> InputSourceType Source { get; } Overhaul the `mono-api-html` "ignore" infrastructure: * Introduce ignore "scoping". Previously, the ignore options would only match the *member* text against any provided regular expression. Thus, `mono-api-html -r ToString` would ignore *all* members containing `ToString`. Furthermore, there was no way to restrict the ignore to a particular type. Expand the regex semantics so that the declaring type is used as a "prefix" for the to-be-matched text. For example, if a class `Example` is removed, `mono-api-html` will now match the following value against any `-r` regular expressions: Example: Removed type * Add a `mono-api-html -v` option, to control output verbosity. When specified, `mono-api-html` will print out available `-r`/etc. option values: $ mono-api-html expected.xml new.xml -v Possible -a value: Android.Resource: Added fields: public static const int AccessibilityEventTypes; Possible -r value: Android.Preferences.CheckBoxPreference: Modified base type: 'Android.Preferences.Preference' to 'Android.Preferences.TwoStatePreference' Possible -r value: Android.Views.InputEvent: Modified properties: public int DeviceId { get; } Possible -n value: Android.Views.UnavailableException: Added type ... Additionally, allow `mono-api-html` to take a `Mono.Options.ResponseFileSource`, which allows `@response-files` to be used as command-line options.
marek-safar
approved these changes
Feb 20, 2018
Member
|
@monojenkins backport to 2018-02 |
Member
|
@monojenkins backport to master |
Contributor
|
Backporting to master failed, the patch results in conflicts: Please backport manually! |
Contributor
|
Backporting to 2018-02 failed, the patch results in conflicts: Please backport manually! |
jonpryor
added a commit
to jonpryor/mono
that referenced
this pull request
Feb 21, 2018
Context: dotnet/android#1078 xamarin-android uses `mono-api-html` and `mono-api-info` in order to perform API comparisons; see e.g. 4e45904. A recent problem has arisen regarding "inter-API-level diffs": there are many API changes which we consider to be acceptable, and thus would like to ignore. Unfortunately, `mono-api-html` doesn't support ignoring many of these constructs, e.g. base class changes: <h3>Type Changed: Android.Preferences.CheckBoxPreference</h3> Modified base type: <span class='removed removed-inline removed-breaking-inline'>Android.Preferences.Preference</span> <span class='added '>Android.Preferences.TwoStatePreference</span> and property type changes: <h3>Type Changed: Android.Views.InputEvent</h3> <p>Modified properties:</p> <pre> <div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> int DeviceId { get; } </div><div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> InputSourceType Source { get; } Overhaul the `mono-api-html` "ignore" infrastructure: * Introduce ignore "scoping". Previously, the ignore options would only match the *member* text against any provided regular expression. Thus, `mono-api-html -r ToString` would ignore *all* members containing `ToString`. Furthermore, there was no way to restrict the ignore to a particular type. Expand the regex semantics so that the declaring type is used as a "prefix" for the to-be-matched text. For example, if a class `Example` is removed, `mono-api-html` will now match the following value against any `-r` regular expressions: Example: Removed type * Add a `mono-api-html -v` option, to control output verbosity. When specified, `mono-api-html` will print out available `-r`/etc. option values: $ mono-api-html expected.xml new.xml -v Possible -a value: Android.Resource: Added fields: public static const int AccessibilityEventTypes; Possible -r value: Android.Preferences.CheckBoxPreference: Modified base type: 'Android.Preferences.Preference' to 'Android.Preferences.TwoStatePreference' Possible -r value: Android.Views.InputEvent: Modified properties: public int DeviceId { get; } Possible -n value: Android.Views.UnavailableException: Added type ... Additionally, allow `mono-api-html` to take a `Mono.Options.ResponseFileSource`, which allows `@response-files` to be used as command-line options.
monojenkins
pushed a commit
to monojenkins/mono
that referenced
this pull request
Feb 21, 2018
Context: dotnet/android#1078 xamarin-android uses `mono-api-html` and `mono-api-info` in order to perform API comparisons; see e.g. 4e45904. A recent problem has arisen regarding "inter-API-level diffs": there are many API changes which we consider to be acceptable, and thus would like to ignore. Unfortunately, `mono-api-html` doesn't support ignoring many of these constructs, e.g. base class changes: <h3>Type Changed: Android.Preferences.CheckBoxPreference</h3> Modified base type: <span class='removed removed-inline removed-breaking-inline'>Android.Preferences.Preference</span> <span class='added '>Android.Preferences.TwoStatePreference</span> and property type changes: <h3>Type Changed: Android.Views.InputEvent</h3> <p>Modified properties:</p> <pre> <div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> int DeviceId { get; } </div><div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> InputSourceType Source { get; } Overhaul the `mono-api-html` "ignore" infrastructure: * Introduce ignore "scoping". Previously, the ignore options would only match the *member* text against any provided regular expression. Thus, `mono-api-html -r ToString` would ignore *all* members containing `ToString`. Furthermore, there was no way to restrict the ignore to a particular type. Expand the regex semantics so that the declaring type is used as a "prefix" for the to-be-matched text. For example, if a class `Example` is removed, `mono-api-html` will now match the following value against any `-r` regular expressions: Example: Removed type * Add a `mono-api-html -v` option, to control output verbosity. When specified, `mono-api-html` will print out available `-r`/etc. option values: $ mono-api-html expected.xml new.xml -v Possible -a value: Android.Resource: Added fields: public static const int AccessibilityEventTypes; Possible -r value: Android.Preferences.CheckBoxPreference: Modified base type: 'Android.Preferences.Preference' to 'Android.Preferences.TwoStatePreference' Possible -r value: Android.Views.InputEvent: Modified properties: public int DeviceId { get; } Possible -n value: Android.Views.UnavailableException: Added type ... Additionally, allow `mono-api-html` to take a `Mono.Options.ResponseFileSource`, which allows `@response-files` to be used as command-line options.
akoeplinger
pushed a commit
that referenced
this pull request
Feb 22, 2018
Context: dotnet/android#1078 xamarin-android uses `mono-api-html` and `mono-api-info` in order to perform API comparisons; see e.g. 4e45904. A recent problem has arisen regarding "inter-API-level diffs": there are many API changes which we consider to be acceptable, and thus would like to ignore. Unfortunately, `mono-api-html` doesn't support ignoring many of these constructs, e.g. base class changes: <h3>Type Changed: Android.Preferences.CheckBoxPreference</h3> Modified base type: <span class='removed removed-inline removed-breaking-inline'>Android.Preferences.Preference</span> <span class='added '>Android.Preferences.TwoStatePreference</span> and property type changes: <h3>Type Changed: Android.Views.InputEvent</h3> <p>Modified properties:</p> <pre> <div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> int DeviceId { get; } </div><div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> InputSourceType Source { get; } Overhaul the `mono-api-html` "ignore" infrastructure: * Introduce ignore "scoping". Previously, the ignore options would only match the *member* text against any provided regular expression. Thus, `mono-api-html -r ToString` would ignore *all* members containing `ToString`. Furthermore, there was no way to restrict the ignore to a particular type. Expand the regex semantics so that the declaring type is used as a "prefix" for the to-be-matched text. For example, if a class `Example` is removed, `mono-api-html` will now match the following value against any `-r` regular expressions: Example: Removed type * Add a `mono-api-html -v` option, to control output verbosity. When specified, `mono-api-html` will print out available `-r`/etc. option values: $ mono-api-html expected.xml new.xml -v Possible -a value: Android.Resource: Added fields: public static const int AccessibilityEventTypes; Possible -r value: Android.Preferences.CheckBoxPreference: Modified base type: 'Android.Preferences.Preference' to 'Android.Preferences.TwoStatePreference' Possible -r value: Android.Views.InputEvent: Modified properties: public int DeviceId { get; } Possible -n value: Android.Views.UnavailableException: Added type ... Additionally, allow `mono-api-html` to take a `Mono.Options.ResponseFileSource`, which allows `@response-files` to be used as command-line options.
akoeplinger
pushed a commit
that referenced
this pull request
Feb 22, 2018
Context: dotnet/android#1078 xamarin-android uses `mono-api-html` and `mono-api-info` in order to perform API comparisons; see e.g. 4e45904. A recent problem has arisen regarding "inter-API-level diffs": there are many API changes which we consider to be acceptable, and thus would like to ignore. Unfortunately, `mono-api-html` doesn't support ignoring many of these constructs, e.g. base class changes: <h3>Type Changed: Android.Preferences.CheckBoxPreference</h3> Modified base type: <span class='removed removed-inline removed-breaking-inline'>Android.Preferences.Preference</span> <span class='added '>Android.Preferences.TwoStatePreference</span> and property type changes: <h3>Type Changed: Android.Views.InputEvent</h3> <p>Modified properties:</p> <pre> <div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> int DeviceId { get; } </div><div data-is-breaking> public <span class='added added-breaking-inline'>abstract</span> InputSourceType Source { get; } Overhaul the `mono-api-html` "ignore" infrastructure: * Introduce ignore "scoping". Previously, the ignore options would only match the *member* text against any provided regular expression. Thus, `mono-api-html -r ToString` would ignore *all* members containing `ToString`. Furthermore, there was no way to restrict the ignore to a particular type. Expand the regex semantics so that the declaring type is used as a "prefix" for the to-be-matched text. For example, if a class `Example` is removed, `mono-api-html` will now match the following value against any `-r` regular expressions: Example: Removed type * Add a `mono-api-html -v` option, to control output verbosity. When specified, `mono-api-html` will print out available `-r`/etc. option values: $ mono-api-html expected.xml new.xml -v Possible -a value: Android.Resource: Added fields: public static const int AccessibilityEventTypes; Possible -r value: Android.Preferences.CheckBoxPreference: Modified base type: 'Android.Preferences.Preference' to 'Android.Preferences.TwoStatePreference' Possible -r value: Android.Views.InputEvent: Modified properties: public int DeviceId { get; } Possible -n value: Android.Views.UnavailableException: Added type ... Additionally, allow `mono-api-html` to take a `Mono.Options.ResponseFileSource`, which allows `@response-files` to be used as command-line options.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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: dotnet/android#1078
xamarin-android uses
mono-api-htmlandmono-api-infoin order toperform API comparisons; see e.g. 4e45904.
A recent problem has arisen regarding "inter-API-level diffs": there
are many API changes which we consider to be acceptable, and thus
would like to ignore. Unfortunately,
mono-api-htmldoesn't supportignoring many of these constructs, e.g. base class changes:
and property type changes:
Overhaul the
mono-api-html"ignore" infrastructure:Introduce ignore "scoping". Previously, the ignore options would
only match the member text against any provided regular
expression. Thus,
mono-api-html -r ToStringwould ignore allmembers containing
ToString. Furthermore, there was no way torestrict the ignore to a particular type. Expand the regex
semantics so that the declaring type is used as a "prefix" for the
to-be-matched text. For example, if a class
Exampleis removed,mono-api-htmlwill now match the following value against any-rregular expressions:Add a
mono-api-html -voption, to control output verbosity.When specified,
mono-api-htmlwill print out available-r/etc.option values:
Additionally, allow
mono-api-htmlto take aMono.Options.ResponseFileSource, which allows@response-filestobe used as command-line options.