Change platform code for "OSX" to "macOS" or similar

[aaronfranke]

Background and Motivation

The name "OSX" is no longer correct. The name "Mac OS X" has been deprecated since 2016 when Apple rebranded their Mac operating system to "macOS". However, in addition to this, the name "OSX" is now just flat out wrong, since the "X" stands for "10", but macOS Big Sur is version 11.0.

Proposed API

Renaming "OSX" and "osx" to either "macOS" or "MacOS" or "macos" or similar would solve this problem.

This proposal does not have specific signature requirements.

Usage Examples

N/A

Alternative Designs

"macOS" (stylized), "MacOS" (PascalCase), "macos" (lowercase), and "MACOS" (uppercase) are all similar designs that would be appropriate depending on the desired naming convention.

Risks

This would break compatibility, but wrappers and aliases can be kept as needed, and upgrading shouldn't be too big of an issue.

[Dotnet-GitSync-Bot]

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

[huoyaoyuan]

#43313 (comment)

[iMonZ]

This is very important for .NET 6.
"osx" could be the vintage x86 support
and "macOS" could be the new universal binary combined with arm64 and x86_64.
So please add this to the .NET 6 release so that the new macOS support is complete.
Could someone add this to the .NET 6 release log instead of "future"?

[joperezr]

@ericstj If we were to do this, would we need support for it from the NuGet or the SDK side or would it mostly just involve changes in our Microsoft.NETCore.Platforms package?

[ericstj]

WRT the RID graph: I believe we could either decide to make macos import osx or vice versa. We'd need to decide what we actually build for our portable mac builds or runtime packs and host and use that. I believe that's mostly within our control.

Next is defining those who synthesize RIDs: so host would need to change, probably build scripts. The SDK has a static list of known RIDs for the host and runtime packs that would need to change. Customer's building self-contained apps that want to target a portable Mac RID would also need to update (EG: osx-x64 -> macos-x64).

There's probably a ton of related stuff that would also need to change.

runtime/src/libraries/System.Runtime.InteropServices.RuntimeInformation/src/System/Runtime/InteropServices/RuntimeInformation/OSPlatform.cs

Line 14 in d77854a

public static OSPlatform OSX { get; } = new OSPlatform("OSX");

Perhaps we can ignore

runtime/src/libraries/System.Private.CoreLib/src/System/PlatformID.cs

Line 16 in d77854a

[EditorBrowsable(EditorBrowsableState.Never)] MacOSX = 6,

We'd need to scrutinize every place that uses osx and decide what would be appropriate.

@wfurt @sdmaclea @richlander what's your thinking around this?

[iMonZ]

Can this issue be added to the .NET 6.0 milestone?

[joperezr]

@iMonZ before we do that we want to see what does @richlander @terrajobst @wfurt @sdmaclea think about it and then we can start planning the work and see if it is feasible to have it in scope for 6.0.

[aaronfranke]

@joperezr .NET 6 has been released. Can we have this done for .NET 7?

As a quick reminder, the longer we wait to do this, the more things are developed using the old name, which means that in general it becomes more difficult to change the name as time goes on.

[yaakov-h]

FWIW at least, the SupportedOSPlatform analyser already treats the two interchangeably, so you can use [SupportedOSPlatform("macos")] today.

Also, macOS is now version 12, so X is two generations out of date.

[joperezr]

@terrajobst thoughts?

[jeffhandley]

I'm going to put this into the .NET 7 milestone, and I'll connect with @ericstj and @terrajobst more on it. If we do move this forward, we'll need a pretty clear set of acceptance criteria to help us validate that the changes work throughout all end-to-end scenarios.

[ericstj]

cc @eerhardt @vitek-karas

[terrajobst]

I'm not opposed to be doing this, but it would help to see a proposed design for this. Which enums would we need to introduce & hide, which checks would need be augmented?

Rough sketch:

Behavior changes

• OperatingSystem.Platform would need to return PlatformID.MacOS on macOS (breaking change)
• OperatingSystem.IsOSPlatform[AtLeast]("macOS") would return true on macOS
• RuntimeInformation.IsOSPlatform(OSPlatform.MacOS) would return true on macOS

Hidden

• PlatformID.MacOSX
• OSPlatform.OSX

Added

• PlatformID.MacOS
• OSPlatform.MacOS