[libc] Fail fast when building standalone #119426
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carlocab
commented
Dec 10, 2024
| @@ -1,6 +1,12 @@ | |||
| cmake_minimum_required(VERSION 3.20.0) | |||
| set(LLVM_SUBPROJECT_TITLE "libc") | |||
|
|
|||
| if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) | |||
| message(FATAL_ERROR "Builds rooted in the libc directory are not supported. " | |||
There was a problem hiding this comment.
Seems nicer to me to error out, but I'm open to changing this to a warning instead.
|
@llvm/pr-subscribers-libc Author: Carlo Cabrera (carlocab) ChangesBuilding with the source directory rooted in the libc subdirectory isn't Let's fail fast with a helpful error message instead to help users Full diff: https://github.com/llvm/llvm-project/pull/119426.diff 1 Files Affected:
diff --git a/libc/CMakeLists.txt b/libc/CMakeLists.txt
index 6d48489284faef..3ad549a66f14e6 100644
--- a/libc/CMakeLists.txt
+++ b/libc/CMakeLists.txt
@@ -1,6 +1,12 @@
cmake_minimum_required(VERSION 3.20.0)
set(LLVM_SUBPROJECT_TITLE "libc")
+if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
+ message(FATAL_ERROR "Builds rooted in the libc directory are not supported. "
+ "Please see the documentation at https://libc.llvm.org/usage_modes.html for links to build "
+ "instructions depending how you plan to use libc.")
+endif()
+
# Include LLVM's cmake policies.
if(NOT DEFINED LLVM_COMMON_CMAKE_UTILS)
set(LLVM_COMMON_CMAKE_UTILS ${CMAKE_CURRENT_SOURCE_DIR}/../cmake)
|
carlocab
force-pushed
the
libc-standalone-error
branch
from
750beba to
0a88f17
Compare
Building with the source directory rooted in the libc subdirectory isn't tested in CI and can lead to subtle build problems (cf. llvm#118871). Let's fail fast with a helpful error message instead to help users configure libc correctly. Co-authored-by: Nick Desaulniers <[email protected]>
carlocab
force-pushed
the
libc-standalone-error
branch
from
0a88f17 to
24c3680
Compare
nickdesaulniers
approved these changes
Dec 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Building with the source directory rooted in the libc subdirectory isn't
tested in CI and can lead to subtle build problems (cf. #118871).
Let's fail fast with a helpful error message instead to help users
configure libc correctly.