Skip to content

Commit

Permalink
Ensure that public headers are prefixed with 'InfluxDB".
Browse files Browse the repository at this point in the history
In vcpkg's registry, before microsoft/vcpkg-tool#1483 , we missed that `influxdb-cxx` conflicts with `libproxy`, because the former spells the header `include/Proxy.h` while the latter spells it `include/proxy.h`. This caused the ports to silently damage each other on case insensitive file systems, such as on Windows and macOS.

Given that the names "Proxy.h", "Transport.h", and "Point.h" are all extremely likely to conflict with other users, and `influxdb-cxx` already seems to have  a convention for header names to be prefixed with "InfluxDB", we, the vcpkg registry maintainers, believe it would be best if these headers were renamed to resolve the conflict.
  • Loading branch information
BillyONeal committed Oct 9, 2024
1 parent 267b551 commit 13e89e2
Show file tree
Hide file tree
Showing 17 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions include/InfluxDB.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
#include <vector>
#include <deque>

#include "Transport.h"
#include "Point.h"
#include "InfluxDBTransport.h"
#include "InfluxDBPoint.h"
#include "influxdb_export.h"

namespace influxdb
Expand Down
4 changes: 2 additions & 2 deletions include/InfluxDBBuilder.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
#define INFLUXDATA_INFLUXDBBUILDER_H

#include "InfluxDB.h"
#include "Transport.h"
#include "Proxy.h"
#include "InfluxDBTransport.h"
#include "InfluxDBProxy.h"
#include "influxdb_export.h"
#include <chrono>

Expand Down
2 changes: 1 addition & 1 deletion include/InfluxDBFactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
#define INFLUXDATA_INFLUXDB_FACTORY_H

#include "InfluxDB.h"
#include "Transport.h"
#include "InfluxDBTransport.h"
#include "influxdb_export.h"

namespace influxdb
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion include/Transport.h → include/InfluxDBTransport.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

#include "InfluxDBException.h"
#include "influxdb_export.h"
#include "Proxy.h"
#include "InfluxDBProxy.h"

namespace influxdb
{
Expand Down
4 changes: 2 additions & 2 deletions src/BoostSupport.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@

#pragma once

#include "Transport.h"
#include "Point.h"
#include "InfluxDBTransport.h"
#include "InfluxDBPoint.h"
#include "UriParser.h"
#include <memory>
#include <string>
Expand Down
2 changes: 1 addition & 1 deletion src/HTTP.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#ifndef INFLUXDATA_TRANSPORTS_HTTP_H
#define INFLUXDATA_TRANSPORTS_HTTP_H

#include "Transport.h"
#include "InfluxDBTransport.h"
#include <memory>
#include <string>
#include <chrono>
Expand Down
2 changes: 1 addition & 1 deletion src/LineProtocol.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

#pragma once

#include "Point.h"
#include "InfluxDBPoint.h"

#include <string>

Expand Down
2 changes: 1 addition & 1 deletion src/Point.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/// \author Adam Wegrzynek <adam.wegrzynek@cern.ch>
///

#include "Point.h"
#include "InfluxDBPoint.h"
#include <chrono>
#include <memory>
#include <sstream>
Expand Down
2 changes: 1 addition & 1 deletion src/Proxy.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#include "Proxy.h"
#include "InfluxDBProxy.h"

namespace influxdb
{
Expand Down
2 changes: 1 addition & 1 deletion src/TCP.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
#ifndef INFLUXDATA_TRANSPORTS_TCP_H
#define INFLUXDATA_TRANSPORTS_TCP_H

#include "Transport.h"
#include "InfluxDBTransport.h"

#include <boost/asio.hpp>
#include <chrono>
Expand Down
2 changes: 1 addition & 1 deletion src/UDP.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#ifndef INFLUXDATA_TRANSPORTS_UDP_H
#define INFLUXDATA_TRANSPORTS_UDP_H

#include "Transport.h"
#include "InfluxDBTransport.h"

#include <boost/asio.hpp>
#include <chrono>
Expand Down
2 changes: 1 addition & 1 deletion src/UnixSocket.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#ifndef INFLUXDATA_TRANSPORTS_UNIX_H
#define INFLUXDATA_TRANSPORTS_UNIX_H

#include "Transport.h"
#include "InfluxDBTransport.h"

#include <boost/asio.hpp>
#include <string>
Expand Down
2 changes: 1 addition & 1 deletion test/PointTest.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#include "Point.h"
#include "InfluxDBPoint.h"
#include <limits>
#include <catch2/catch_test_macros.hpp>
#include <catch2/matchers/catch_matchers_all.hpp>
Expand Down
2 changes: 1 addition & 1 deletion test/ProxyTest.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#include "Proxy.h"
#include "InfluxDBProxy.h"
#include <catch2/matchers/catch_matchers_all.hpp>
#include <catch2/catch_test_macros.hpp>

Expand Down
2 changes: 1 addition & 1 deletion test/mock/TransportMock.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

#pragma once

#include "Transport.h"
#include "InfluxDBTransport.h"
#include <catch2/catch_test_macros.hpp>
#include <catch2/trompeloeil.hpp>

Expand Down

0 comments on commit 13e89e2

Please sign in to comment.