[libc-commits] [libc] 062a7ea - [libc] Add a section about supported compilers in the documentation

[Guillaume Chatelet via libc-commits]

Author: Guillaume Chatelet
Date: 2023-01-06T09:30:50Z
New Revision: 062a7ea591ad87e4ecf4629362e89b8b0719435a

URL: https://github.com/llvm/llvm-project/commit/062a7ea591ad87e4ecf4629362e89b8b0719435a
DIFF: https://github.com/llvm/llvm-project/commit/062a7ea591ad87e4ecf4629362e89b8b0719435a.diff

LOG: [libc] Add a section about supported compilers in the documentation

Context https://github.com/llvm/llvm-project/issues/59368

Differential Revision: https://reviews.llvm.org/D141045

Added: 
    libc/docs/compiler_support.rst

Modified: 
    libc/docs/index.rst

Removed: 
    


################################################################################
diff  --git a/libc/docs/compiler_support.rst b/libc/docs/compiler_support.rst
new file mode 100644
index 0000000000000..a139cd93c8d23
--- /dev/null
+++ b/libc/docs/compiler_support.rst
@@ -0,0 +1,17 @@
+.. _compiler_support:
+
+================
+Compiler Support
+================
+
+As of now only ``Clang`` is fully supported.
+
+We are in the process of supporting ``GCC`` but some memory function implementations rely on `compiler intrinsics`__ that are not currently available in ``GCC``.
+As such we cannot guarantee optimal performance for these functions.
+
+.. __: https://clang.llvm.org/docs/LanguageExtensions.html#guaranteed-inlined-copy
+
+Minimum version
+===============
+
+ - ``Clang 11``

diff  --git a/libc/docs/index.rst b/libc/docs/index.rst
index 31bc1e2ce8f39..ba7a04e31e232 100644
--- a/libc/docs/index.rst
+++ b/libc/docs/index.rst
@@ -69,6 +69,7 @@ stages there is no ABI stability in any form.
    :maxdepth: 1
    :caption: Development
 
+   compiler_support
    build_and_test
    developer_guides
    porting