[libc-commits] [libc] [libc][docs] add note on gcc overlay release build (PR #89314)

[Michael Jones via libc-commits]

https://github.com/michaelrj-google created https://github.com/llvm/llvm-project/pull/89314

There's an issue when building with gcc in overlay mode and release mode
that causes build errors. This patch adds a note to the compiler support
site about this.


>From 9dd37501c6cfb55d4305fea4128290453426c9d3 Mon Sep 17 00:00:00 2001
From: Michael Jones <michaelrj at google.com>
Date: Thu, 18 Apr 2024 14:15:38 -0700
Subject: [PATCH] [libc][docs] add note on gcc overlay release build

There's an issue when building with gcc in overlay mode and release mode
that causes build errors. This patch adds a note to the compiler support
site about this.
---
 libc/docs/compiler_support.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libc/docs/compiler_support.rst b/libc/docs/compiler_support.rst
index 00234c22dc2e6f..3e2ab3056273da 100644
--- a/libc/docs/compiler_support.rst
+++ b/libc/docs/compiler_support.rst
@@ -17,6 +17,10 @@ For platforms where only ``GCC`` is natively available but maximum performance
 is required it is possible to bootstrap ``Clang`` with ``GCC`` and then use
 ``Clang`` to build the '`libc``" project.
 
+IMPORTANT NOTE: There is currently an issue when doing an overlay build in
+release mode with GCC. If you want to build with GCC, please either build in
+debug mode or use fullbuild mode. Otherwise, please use clang.
+
 Minimum supported versions
 ==========================