echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Xcode: Restore suppression of header maps

Browse Source 
In commit 8527f42b96 (Xcode: Explicitly disable deprecated user include
path feature, 2023-01-31, v3.26.0-rc1~7^2) we dropped the Xcode build
setting `USE_HEADERMAP = NO` because Xcode 14's "Build Documentation"
feature (`xcodebuild RUN_DOCUMENTATION_COMPILER=YES`) fails in some
cases without header maps.  However, enabling header maps causes Xcode
to add `-iquote .../foo.hmap` and `-I .../bar.hmap` flags that can
change the intended header file search order based on the contents of
the header maps.  This can break existing projects.  Restore the
`USE_HEADERMAP = NO` setting to fix the header file search order.

Further investigation will be needed to resolve the problematic cases
with the Xcode 14 "Build Documentation" feature.  Meanwhile projects
encountering such cases can set the `XCODE_ATTRIBUTE_USE_HEADERMAP`
target property to `YES` themselves.

Fixes: #24418
Issue: #24379
This commit is contained in:
Brad King 2023-02-16 16:53:52 -05:00
parent 2a758e34ea
commit 841272eb35
5 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Source/cmGlobalXCodeGenerator.cxx
View File

@ -2977,6 +2977,7 @@ void cmGlobalXCodeGenerator::CreateBuildSettings(cmGeneratorTarget* gtgt,
buildSettings->AddAttribute("SECTORDER_FLAGS", this->CreateString(""));
buildSettings->AddAttribute("ALWAYS_SEARCH_USER_PATHS",
this->CreateString("NO"));
buildSettings->AddAttribute("USE_HEADERMAP", this->CreateString("NO"));
cmXCodeObject* group = this->CreateObject(cmXCodeObject::OBJECT_LIST);
group->AddObject(this->CreateString("$(inherited)"));
buildSettings->AddAttribute("WARNING_CFLAGS", group);

5
Tests/CMakeCommands/target_include_directories/CMakeLists.txt
View File

@ -83,3 +83,8 @@ get_target_property(_res imp INCLUDE_DIRECTORIES)
if (_res)
message(SEND_ERROR "include_directories populated the INCLUDE_DIRECTORIES target property")
endif()
# Test selecting lexicographically-later header of same name via include order.
# Xcode 'USE_HEADERMAP = YES' breaks this.
add_library(same STATIC same.c same_one/same.h same_two/same.h)
target_include_directories(same PRIVATE same_two)

7
Tests/CMakeCommands/target_include_directories/same.c Normal file
View File

@ -0,0 +1,7 @@
#include "same.h"
#ifndef CORRECT_SAME_H_INCLUDED
# error "Correct \"same.h\" not included!"
#endif
void same(void)
{
}

1
Tests/CMakeCommands/target_include_directories/same_one/same.h Normal file
View File

@ -0,0 +1 @@
#error "Wrong \"same.h\" included!"

1
Tests/CMakeCommands/target_include_directories/same_two/same.h Normal file
View File

@ -0,0 +1 @@
#define CORRECT_SAME_H_INCLUDED