[libc] Add a section about supported compilers in the documentation
authorGuillaume Chatelet <gchatelet@google.com>
Thu, 5 Jan 2023 13:35:09 +0000 (13:35 +0000)
committerGuillaume Chatelet <gchatelet@google.com>
Fri, 6 Jan 2023 09:30:50 +0000 (09:30 +0000)
Context https://github.com/llvm/llvm-project/issues/59368

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

libc/docs/compiler_support.rst [new file with mode: 0644]
libc/docs/index.rst

diff --git a/libc/docs/compiler_support.rst b/libc/docs/compiler_support.rst
new file mode 100644 (file)
index 0000000..a139cd9
--- /dev/null
@@ -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``
index 31bc1e2..ba7a04e 100644 (file)
@@ -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