diff options
author | Yang Tse <yangsita@gmail.com> | 2013-01-06 19:06:49 +0100 |
---|---|---|
committer | Yang Tse <yangsita@gmail.com> | 2013-01-09 00:49:50 +0100 |
commit | 5a053ffe80289b8472f88d7f11f29fbc98d4d9fd (patch) | |
tree | 56a9a2ecdf9f5920a7d211f63c71baaf09b3a162 /docs | |
parent | e2bcd2ab9e5ad894a57756fa660d2a07b69171f4 (diff) |
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.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/INSTALL | 2 | ||||
-rw-r--r-- | docs/examples/Makefile.am | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/INSTALL b/docs/INSTALL index 0ed15ca29..a39f19c78 100644 --- a/docs/INSTALL +++ b/docs/INSTALL @@ -464,7 +464,7 @@ Win32 possibilities: - Modify lib/config-win32.h - - Modify lib/setup.h + - Modify lib/curl_setup.h - Modify lib/Makefile.vc6 - Add defines to Project/Settings/C/C++/General/Preprocessor Definitions in the vc6libcurl.dsw/vc6libcurl.dsp Visual C++ 6 IDE project. diff --git a/docs/examples/Makefile.am b/docs/examples/Makefile.am index 865f09371..cbfdac502 100644 --- a/docs/examples/Makefile.am +++ b/docs/examples/Makefile.am @@ -31,7 +31,7 @@ EXTRA_DIST = README Makefile.example Makefile.inc Makefile.m32 \ # 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 AM_CPPFLAGS = -I$(top_builddir)/include/curl \ |