Skip to content

[docs] Document the missing availability platforms and environments #104653

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

Merged
merged 1 commit into from
Aug 27, 2024

Conversation

ian-twilightcoder
Copy link
Contributor

@ian-twilightcoder ian-twilightcoder commented Aug 17, 2024

Update the availability attribute documentation to include all of the missing platforms, and add in the environments.

@llvmbot llvmbot added clang Clang issues not falling into any other category clang:frontend Language frontend issues, e.g. anything involving "Sema" labels Aug 17, 2024
@llvmbot
Copy link
Member

llvmbot commented Aug 17, 2024

@llvm/pr-subscribers-clang

Author: Ian Anderson (ian-twilightcoder)

Changes

Add the supported application extension and Mac Catalyst platforms to the availability attribute documentation.


Full diff: https://github.com/llvm/llvm-project/pull/104653.diff

1 Files Affected:

  • (modified) clang/include/clang/Basic/AttrDocs.td (+11)
diff --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td
index 19cbb9a0111a2..a97f479e18c91 100644
--- a/clang/include/clang/Basic/AttrDocs.td
+++ b/clang/include/clang/Basic/AttrDocs.td
@@ -1637,12 +1637,20 @@ specifies availability for the current target platform, the availability
 attributes are ignored. Supported platforms are:
 
 ``ios``
+``ios_app_extension``
   Apple's iOS operating system. The minimum deployment target is specified
   as part of the ``-target *arch*-apple-ios*version*`` command line argument.
   Alternatively, it can be specified by the ``-mtargetos=ios*version*``
   command-line argument.
 
+``maccatalyst``
+``maccatalyst_app_extension``
+  Apple's Mac Catalyst development environment for its macOS operating system.
+  The minimum deployment target is specified as part of the
+  ``-target *arch*-apple-ios*version*-macabi`` command line argument.
+
 ``macos``
+``macos_app_extension``
   Apple's macOS operating system. The minimum deployment target is specified
   as part of the ``-target *arch*-apple-macos*version*`` command line argument.
   Alternatively, it can be specified by the ``-mtargetos=macos*version*``
@@ -1650,18 +1658,21 @@ attributes are ignored. Supported platforms are:
   backward-compatibility reasons, but it is deprecated.
 
 ``tvos``
+``tvos_app_extension``
   Apple's tvOS operating system. The minimum deployment target is specified
   as part of the ``-target *arch*-apple-tvos*version*`` command line argument.
   Alternatively, it can be specified by the ``-mtargetos=tvos*version*``
   command-line argument.
 
 ``watchos``
+``watchos_app_extension``
   Apple's watchOS operating system. The minimum deployment target is specified
   as part of the ``-target *arch*-apple-watchos*version*`` command line argument.
   Alternatively, it can be specified by the ``-mtargetos=watchos*version*``
   command-line argument.
 
 ``visionos``
+``visionos_app_extension``
   Apple's visionOS operating system. The minimum deployment target is specified
   as part of the ``-target *arch*-apple-visionos*version*`` command line argument.
   Alternatively, it can be specified by the ``-mtargetos=visionos*version*``

@ian-twilightcoder ian-twilightcoder changed the title [docs] Document the missing Apple availability platforms [docs] Document the missing availability platforms and environments Aug 26, 2024
@hekota
Copy link
Member

hekota commented Aug 26, 2024

Thanks @ian-twilightcoder! Would you also like to add a note that the environment parameter is currently supported only for the ShaderModel platform?

Update the availability attribute documentation to include all of the missing platforms, and add in the environments.
@ian-twilightcoder ian-twilightcoder merged commit 79154a9 into llvm:main Aug 27, 2024
6 of 8 checks passed
@ian-twilightcoder ian-twilightcoder deleted the availability_docs branch August 27, 2024 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang:frontend Language frontend issues, e.g. anything involving "Sema" clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants