zookeeper-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ph...@apache.org
Subject zookeeper git commit: ZOOKEEPER-2905: Don't include `config.h` in `zookeeper.h`
Date Wed, 27 Sep 2017 22:18:51 GMT
Repository: zookeeper
Updated Branches:
  refs/heads/master 523b7fb2c -> 0fee90568

ZOOKEEPER-2905: Don't include `config.h` in `zookeeper.h`

In ZOOKEEPER-2841 I fixed the inclusion of project-specific porting code
that were included in the public headers, which then broke upstream
projects (in my case, Mesos).

Unfortunately, I inadvertently created a very similar problem, and it
wasn't evident until the build was coupled with another project with the
same bug. More specifically, when including ZooKeeper in Mesos, and
including Google's Glog in Mesos, both projects define the macros
`VERSION`, `PACKAGE_VERSION`, and `PACKAGE_TARNAME`, and do so publicly.
This is commonly defined in `config.h` by Autotools (and by CMake for
ZooKeeper for compatibility), and is not a problem unless included
publicly, such as in `zookeeper.h`, and by more than one project.

When refactoring, I saw two includes in `zookeeper.h` that instead of
being guarded by e.g. `#ifdef HAVE_SYS_SOCKET_H` were guarded by
`#ifndef WIN32`. I erroneously added `#include "config.h"` and guarded
the includes "properly" with a feature guard. However, configuration
files such as `config.h` and `winconfig.h` etc. must never be included
in publicly in `zookeeper.h`, for the reasons given above.

This patch reverts the bug, and instead includes `config.h` in
`zookeeper.c`, where it is not exposed to other projects.

Author: Andrew Schwartzmeyer <andrew@schwartzmeyer.com>

Reviewers: Patrick Hunt <phunt@apache.org>

Closes #383 from andschwa/ZOOKEEPER-2905-master

Change-Id: I7c94bbf9dd8a4bd0548fbf07cbb3ff1f0c3bbe06

Project: http://git-wip-us.apache.org/repos/asf/zookeeper/repo
Commit: http://git-wip-us.apache.org/repos/asf/zookeeper/commit/0fee9056
Tree: http://git-wip-us.apache.org/repos/asf/zookeeper/tree/0fee9056
Diff: http://git-wip-us.apache.org/repos/asf/zookeeper/diff/0fee9056

Branch: refs/heads/master
Commit: 0fee905684a82eefb2d7d4a999290fb2f2378b41
Parents: 523b7fb
Author: Andrew Schwartzmeyer <andrew@schwartzmeyer.com>
Authored: Wed Sep 27 15:18:15 2017 -0700
Committer: Patrick Hunt <phunt@apache.org>
Committed: Wed Sep 27 15:18:15 2017 -0700

 src/c/include/zookeeper.h | 8 ++------
 src/c/src/zookeeper.c     | 1 +
 2 files changed, 3 insertions(+), 6 deletions(-)

diff --git a/src/c/include/zookeeper.h b/src/c/include/zookeeper.h
index dc2e0c9..af601f1 100644
--- a/src/c/include/zookeeper.h
+++ b/src/c/include/zookeeper.h
@@ -21,13 +21,9 @@
 #include <stdlib.h>
-#include "config.h"
+/* we must not include config.h as a public header */
+#ifndef WIN32
 #include <sys/socket.h>
 #include <sys/time.h>

diff --git a/src/c/src/zookeeper.c b/src/c/src/zookeeper.c
index ca2e75b..8c77243 100644
--- a/src/c/src/zookeeper.c
+++ b/src/c/src/zookeeper.c
@@ -24,6 +24,7 @@
 #define USE_IPV6
+#include "config.h"
 #include <zookeeper.h>
 #include <zookeeper.jute.h>
 #include <proto.h>

View raw message