Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document API platform differences #21115

Closed
karelz opened this issue Apr 14, 2017 · 9 comments
Closed

Document API platform differences #21115

karelz opened this issue Apr 14, 2017 · 9 comments
Assignees
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code
Milestone

Comments

@karelz
Copy link
Member

karelz commented Apr 14, 2017

We need to document API differences:

  1. Between .NET platforms -- .NET Framework vs. .NET Core vs. .NET Native vs. Xamarin/Mono, and
  2. Between OS's -- Windows vs. Linux vs. Mac

The documentation should be exposed as platform-compat tooling and also as standalone HTML.

@karelz karelz self-assigned this Apr 14, 2017
@karelz
Copy link
Member Author

karelz commented Apr 14, 2017

Update also porting.md - AppDomains with link to differences.

@karelz karelz changed the title Document API differences Document API platform differences Apr 14, 2017
@tarekgh
Copy link
Member

tarekgh commented Apr 14, 2017

@karelz do you think this can be done in v2.0 time frame? I think this will need sometime to cover such differences

@karelz
Copy link
Member Author

karelz commented Apr 14, 2017

This should happen in 2.0 timeframe - it is part of the platform end-to-end. It might be exemption to ZBB on 5/10 though.

@karelz
Copy link
Member Author

karelz commented Apr 21, 2017

BTW: The content/list of differences is now being collected here: https://github.com/dotnet/corefx/wiki/ApiCompat

@ViktorHofer
Copy link
Member

ViktorHofer commented Apr 29, 2017

@karelz Post-ZBB label maybe?

@karelz
Copy link
Member Author

karelz commented Apr 30, 2017

Yep, good catch. Thanks @ViktorHofer!

@tarekgh
Copy link
Member

tarekgh commented May 23, 2017

@karelz are you following in this? will be able to close it before the end of the week?

@karelz
Copy link
Member Author

karelz commented May 23, 2017

I will follow up. Documentation changes can happen after Escrow ;) as they don't require code change.

@karelz karelz assigned karelz and unassigned karelz Oct 25, 2017
@karelz
Copy link
Member Author

karelz commented Nov 20, 2017

The tooling was released as preview via nuget: https://blogs.msdn.microsoft.com/dotnet/2017/10/31/introducing-api-analyzer/

Source code is here: https://github.com/dotnet/platform-compat

@karelz karelz closed this as completed Nov 20, 2017
@msftgits msftgits transferred this issue from dotnet/corefx Jan 31, 2020
@msftgits msftgits added this to the 2.1.0 milestone Jan 31, 2020
@ghost ghost locked as resolved and limited conversation to collaborators Dec 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

No branches or pull requests

4 participants