Skip to content

Suppress warning about missing SDKSettings.json for non-Darwin platforms #1619

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

Conversation

kateinoigakukun
Copy link
Member

The SDKSettings.json file is only used for Darwin platforms, so we should not emit a warning about it being missing for non-Darwin platforms.

The SDKSettings.json file is only used for Darwin platforms, so we should
not emit a warning about it being missing for non-Darwin platforms.
@kateinoigakukun kateinoigakukun requested a review from artemcm May 21, 2024 05:22
@kateinoigakukun
Copy link
Member Author

@swift-ci test

@al45tair
Copy link
Contributor

al45tair commented Jun 3, 2024

Interesting. The other option would be to put an SDKSettings.json file in your SDK. I believe the minimal set of keys is

{
  "DisplayName": "<display name here>",
  "Version": "<SDK version>",
  "VersionMap": {},
  "CanonicalName": "<canonical name here>"
}

Everything else is optional. I don't have a strong opinion either way; @MaxDesiatov, WDYT? At least in principle, it would be nice to have Xcode support for the SDKs at some point, and including an SDKSettings.json file might make sense for that?

@MaxDesiatov
Copy link
Contributor

It feels weird to me to require all Swift SDKs to include Darwin-specific stuff in them. I'd rather see the file itself marked as optional and not trigger any warnings anymore.

@MaxDesiatov MaxDesiatov added the bug Something isn't working label Jun 3, 2024
@kateinoigakukun
Copy link
Member Author

Placing SDKSettings.json in SDKs is definitely an option, but we can't always modify SDK contents (e.g. Android NDK is not under our control. / root directory can be used as SDK on non-darwin systems)
So I think making the file itself optional seems reasonable on non-Darwin platforms. For future IDE support, we can provide such metadata from Swift SDK's metadata file.

@kateinoigakukun kateinoigakukun merged commit 06d4c79 into swiftlang:main Jun 3, 2024
3 checks passed
@kateinoigakukun kateinoigakukun deleted the yt/supress-sdk-settings-warning branch June 3, 2024 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants