zookeeper-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andschwa <...@git.apache.org>
Subject [GitHub] zookeeper pull request #382: ZOOKEEPER-2905: Don't include `config.h` in `zo...
Date Mon, 25 Sep 2017 23:00:24 GMT
GitHub user andschwa opened a pull request:

    https://github.com/apache/zookeeper/pull/382

    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.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/andschwa/zookeeper ZOOKEEPER-2905-3.5

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/zookeeper/pull/382.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #382
    
----
commit daac5254a1a7472089f6950f60e4a4a1a3fa1f0e
Author: Andrew Schwartzmeyer <andrew@schwartzmeyer.com>
Date:   2017-08-30T23:15:28Z

    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.

----


---

Mime
View raw message