From 5a053ffe80289b8472f88d7f11f29fbc98d4d9fd Mon Sep 17 00:00:00 2001 From: Yang Tse Date: Sun, 6 Jan 2013 19:06:49 +0100 Subject: build: fix circular header inclusion with other packages This commit renames lib/setup.h to lib/curl_setup.h and renames lib/setup_once.h to lib/curl_setup_once.h. Removes the need and usage of a header inclusion guard foreign to libcurl. [1] Removes the need and presence of an alarming notice we carried in old setup_once.h [2] ---------------------------------------- 1 - lib/setup_once.h used __SETUP_ONCE_H macro as header inclusion guard up to commit ec691ca3 which changed this to HEADER_CURL_SETUP_ONCE_H, this single inclusion guard is enough to ensure that inclusion of lib/setup_once.h done from lib/setup.h is only done once. Additionally lib/setup.h has always used __SETUP_ONCE_H macro to protect inclusion of setup_once.h even after commit ec691ca3, this was to avoid a circular header inclusion triggered when building a c-ares enabled version with c-ares sources available which also has a setup_once.h header. Commit ec691ca3 exposes the real nature of __SETUP_ONCE_H usage in lib/setup.h, it is a header inclusion guard foreign to libcurl belonging to c-ares's setup_once.h The renaming this commit does, fixes the circular header inclusion, and as such removes the need and usage of a header inclusion guard foreign to libcurl. Macro __SETUP_ONCE_H no longer used in libcurl. 2 - Due to the circular interdependency of old lib/setup_once.h and the c-ares setup_once.h header, old file lib/setup_once.h has carried back from 2006 up to now days an alarming and prominent notice about the need of keeping libcurl's and c-ares's setup_once.h in sync. Given that this commit fixes the circular interdependency, the need and presence of mentioned notice is removed. All mentioned interdependencies come back from now old days when the c-ares project lived inside a curl subdirectory. This commit removes last traces of such fact. --- tests/libtest/CMakeLists.txt | 2 +- tests/libtest/Makefile.am | 4 ++-- tests/libtest/chkhostname.c | 2 +- tests/libtest/sethostname.c | 2 +- tests/libtest/test.h | 4 ++-- tests/libtest/testutil.c | 2 +- tests/libtest/testutil.h | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) (limited to 'tests/libtest') diff --git a/tests/libtest/CMakeLists.txt b/tests/libtest/CMakeLists.txt index 896686bd8..733cdd31b 100644 --- a/tests/libtest/CMakeLists.txt +++ b/tests/libtest/CMakeLists.txt @@ -5,7 +5,7 @@ function(SETUP_TEST TEST_NAME) # ARGN are the files in the test string(TOUPPER ${TEST_NAME} UPPER_TEST_NAME) include_directories( - ${CURL_SOURCE_DIR}/lib # To be able to reach "setup_once.h" + ${CURL_SOURCE_DIR}/lib # To be able to reach "curl_setup_once.h" ${CURL_BINARY_DIR}/lib # To be able to reach "curl_config.h" ${CURL_BINARY_DIR}/include # To be able to reach "curl/curlbuild.h" ) diff --git a/tests/libtest/Makefile.am b/tests/libtest/Makefile.am index df13df111..ba4097f8e 100644 --- a/tests/libtest/Makefile.am +++ b/tests/libtest/Makefile.am @@ -27,10 +27,10 @@ AUTOMAKE_OPTIONS = foreign nostdinc # might possibly already be installed in the system. # # $(top_builddir)/include/curl for generated curlbuild.h included from curl.h -# $(top_builddir)/include for generated curlbuild.h included from lib/setup.h +# $(top_builddir)/include for generated curlbuild.h inc. from lib/curl_setup.h # $(top_srcdir)/include is for libcurl's external include files # $(top_builddir)/lib is for libcurl's generated lib/curl_config.h file -# $(top_srcdir)/lib is for libcurl's lib/setup.h and other "borrowed" files +# $(top_srcdir)/lib for libcurl's lib/curl_setup.h and other "borrowed" files # $(top_builddir)/ares is for in-tree c-ares's generated ares_build.h file # $(top_srcdir)/ares is for in-tree c-ares's external include files diff --git a/tests/libtest/chkhostname.c b/tests/libtest/chkhostname.c index a18c92e8f..168294ab6 100644 --- a/tests/libtest/chkhostname.c +++ b/tests/libtest/chkhostname.c @@ -19,7 +19,7 @@ * KIND, either express or implied. * ***************************************************************************/ -#include "setup.h" +#include "curl_setup.h" #include "curl_gethostname.h" diff --git a/tests/libtest/sethostname.c b/tests/libtest/sethostname.c index f131fe9fb..9da6a6730 100644 --- a/tests/libtest/sethostname.c +++ b/tests/libtest/sethostname.c @@ -19,7 +19,7 @@ * KIND, either express or implied. * ***************************************************************************/ -#include "setup.h" +#include "curl_setup.h" #include "sethostname.h" diff --git a/tests/libtest/test.h b/tests/libtest/test.h index fcc91ad8b..5de8c7c75 100644 --- a/tests/libtest/test.h +++ b/tests/libtest/test.h @@ -20,14 +20,14 @@ * ***************************************************************************/ -/* Now include the setup.h file from libcurl's private libdir (the source +/* Now include the curl_setup.h file from libcurl's private libdir (the source version, but that might include "curl_config.h" from the build dir so we need both of them in the include path), so that we get good in-depth knowledge about the system we're building this on */ #define CURL_NO_OLDIES -#include "setup.h" +#include "curl_setup.h" #include diff --git a/tests/libtest/testutil.c b/tests/libtest/testutil.c index 3ad18c987..b18a60734 100644 --- a/tests/libtest/testutil.c +++ b/tests/libtest/testutil.c @@ -19,7 +19,7 @@ * KIND, either express or implied. * ***************************************************************************/ -#include "setup.h" +#include "curl_setup.h" #include "testutil.h" #include "memdebug.h" diff --git a/tests/libtest/testutil.h b/tests/libtest/testutil.h index 0c6be2fc4..a236970a6 100644 --- a/tests/libtest/testutil.h +++ b/tests/libtest/testutil.h @@ -21,7 +21,7 @@ * KIND, either express or implied. * ***************************************************************************/ -#include "setup.h" +#include "curl_setup.h" struct timeval tutil_tvnow(void); -- cgit v1.2.3