Introduce docs from CPP Driver and adjust

.gitignore

@@ -8,3 +8,5 @@ cmake-build-debug/
 version
 docs/_build
 log/
+docs/source/api
+doxygen/xml

CMakeLists.txt

@@ -42,12 +42,10 @@ option(CASS_INSTALL_HEADER_IN_SUBDIR "Install header file under 'include/cassand
 option(CASS_INSTALL_PKG_CONFIG "Install pkg-config file(s)" ON)
 option(CASS_MULTICORE_COMPILATION "Enable multicore compilation" ON)
 option(CASS_USE_BOOST_ATOMIC "Use Boost atomics library" OFF)
-option(CASS_USE_KERBEROS "Use Kerberos" OFF)
 option(CASS_USE_LIBSSH2 "Use libssh2 for integration tests" OFF)
 option(CASS_USE_OPENSSL "Use OpenSSL" ON)
 option(CASS_USE_STATIC_LIBS "Link static libraries when building executables" OFF)
 option(CASS_USE_STD_ATOMIC "Use std::atomic library" ON)
-option(CASS_USE_ZLIB "Use zlib" OFF)
 option(CASS_USE_TIMERFD "Use timerfd (Linux only)" ON)
 option(CASS_USE_LIBUV "Use libuv" OFF)
 
@@ -65,7 +63,6 @@ endif()
 
 if(CASS_BUILD_INTEGRATION_TESTS OR CASS_BUILD_UNIT_TESTS)
   set(CASS_USE_OPENSSL ON) # Required for tests
-  set(CASS_USE_KERBEROS ON) # Required for tests
   set(CASS_USE_LIBUV ON)
 endif()
 

README.md

@@ -1,6 +1,6 @@
 # ScyllaDB Cpp-Rust Driver
 ___
-Wrapper around ScyllaDB's rust-driver compatible with Datastax cpp-driver.
+Wrapper around [ScyllaDB's Rust Driver](https://cpp-rust-driver.docs.scylladb.com/stable), which is API-compatible with both ScyllaDB and Datastax C/C++ Driver and may be considered a drop-in replacement (with some minor limitations, see [Limitations](#limitations)).
 
 #### Note: It is work in progress, bug reports and pull requests are welcome!
 
@@ -137,7 +137,7 @@ int main() {
 ___
 
 The driver inherits almost all the features of C/C++ and Rust drivers, such as:
- * [Asynchronous API](http://datastax.github.io/cpp-driver/topics/#futures)
+ * [Asynchronous API](https://cpp-rust-driver.docs.scylladb.com/stable/topics/#futures)
  * Shard-aware routing
  * Simple, Prepared and Batch statements
  * Query paging
@@ -146,9 +146,9 @@ The driver inherits almost all the features of C/C++ and Rust drivers, such as:
  * Retry policies
  * SSL
  * Authentication
- * [Tuples](http://datastax.github.io/cpp-driver/topics/basics/tuples/) and [UDTs](http://datastax.github.io/cpp-driver/topics/basics/user_defined_types/)
- * [Nested collections](http://datastax.github.io/cpp-driver/topics/basics/binding_parameters/#nested-collections)
- * [Data types](http://datastax.github.io/cpp-driver/topics/basics/data_types/)
+ * [Tuples](https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/data-types/tuples/) and [UDTs](http://https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/data-types/user-defined-types/)
+ * [Nested collections](https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/binding-parameters/#nested-collections)
+ * [Data types](https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/data-types/)
  * Schema metadata (keyspace metadata, materialized views, etc.)
 
 # Limitations
@@ -395,7 +395,7 @@ Some tests are added to GitHub Actions workflows and are used to test every pull
 
 To build and run the integration tests several requirements need to be met:
 
-* Install `libuv`, `openssl` and `kerberos` on your system:
+* Install `libuv` and `openssl` on your system:
 
 ```shell
 # On Ubuntu

cmake/Dependencies.cmake

@@ -107,51 +107,6 @@ if(CASS_USE_OPENSSL)
   set(CASS_LIBS ${CASS_LIBS} ${OPENSSL_LIBRARIES})
 endif()
 
-#------------------------
-# ZLIB
-#------------------------
-
-if(CASS_USE_ZLIB)
-  if(NOT ZLIB_LIBRARY_NAME)
-    # Setup the root directory for zlib
-    set(ZLIB_ROOT "${PROJECT_SOURCE_DIR}/lib/zlib/"
-                  "${PROJECT_SOURCE_DIR}/build/libs/zlib/")
-    set(ZLIB_ROOT ${ZLIB_ROOT} ${ZLIB_ROOT_DIR} $ENV{ZLIB_ROOT_DIR})
-
-    # Ensure zlib was found (assign zlib include/libraries or present warning)
-    find_package(ZLIB)
-    if(ZLIB_FOUND)
-      # Determine if the static library needs to be used for Windows
-      if(WIN32 AND CASS_USE_STATIC_LIBS)
-        string(REPLACE "zlib.lib" "zlibstatic.lib" ZLIB_LIBRARIES "${ZLIB_LIBRARIES}")
-      endif()
-
-      # Assign zlib properties
-      set(CASS_INCLUDES ${CASS_INCLUDES} ${ZLIB_INCLUDE_DIRS})
-      set(CASS_LIBS ${CASS_LIBS} ${ZLIB_LIBRARIES})
-      set(HAVE_ZLIB On)
-    else()
-      message(WARNING "Could not find zlib, try to set the path to zlib root folder in the system variable ZLIB_ROOT_DIR")
-      message(WARNING "zlib libraries will not be linked into build")
-    endif()
-  else()
-    # Assign zlib properties
-    set(CASS_INCLUDES ${CASS_INCLUDES} ${ZLIB_INCLUDE_DIRS})
-    set(CASS_LIBS ${CASS_LIBS} ${ZLIB_LIBRARIES})
-  endif()
-endif()
-
-#------------------------
-# Kerberos
-#------------------------
-
-if(CASS_USE_KERBEROS)
-  # Discover Kerberos and assign Kerberos include and libraries
-  find_package(Kerberos REQUIRED)
-  set(CASS_INCLUDES ${CASS_INCLUDES} ${KERBEROS_INCLUDE_DIR})
-  set(CASS_LIBS ${CASS_LIBS} ${KERBEROS_LIBRARIES})
-endif()
-
 #------------------------
 # Boost
 #------------------------

cmake/ExternalProject-OpenSSL.cmake

@@ -25,9 +25,6 @@ if(NOT OPENSSL_VERSION)
   set(OPENSSL_VERSION "1.0.2s")
 endif()
 option(OPENSSL_INSTALL_PREFIX "OpenSSL installation prefix location")
-if(CASS_USE_ZLIB)
-  include(ExternalProject-zlib)
-endif()
 set(OPENSSL_VERSION ${OPENSSL_VERSION} CACHE STRING "OpenSSL version to build and install" FORCE)
 
 # Determine the major and minor version of OpenSSL used
@@ -91,19 +88,6 @@ else()
 endif()
 set(OPENSSL_ROOT_DIR "${OPENSSL_INSTALL_DIR}" CACHE STRING "OpenSSL root directory" FORCE)
 
-# Create build options for the platform build scripts
-if(BUILD_SHARED_LIBS)
-  if(CASS_USE_ZLIB)
-    set(OPENSSL_ZLIB_CONFIGURE_ARGUMENT "zlib-dynamic")
-    set(ZLIB_LIB zlib.lib)
-  endif()
-else()
-  if(CASS_USE_ZLIB)
-    set(OPENSSL_ZLIB_CONFIGURE_ARGUMENT "no-zlib-dynamic")
-    set(ZLIB_LIB zlibstatic.lib)
-  endif()
-endif()
-
 # Determine if shared or static library should be built
 set(OPENSSL_CONFIGURE_COMPILER "no-asm no-ssl2")
 if(BUILD_SHARED_LIBS)
@@ -273,16 +257,6 @@ file(APPEND ${OPENSSL_CONFIGURE_SCRIPT}
   "POPD\r\n"
   "SET PATH=${PERL_PATH};%PATH%\r\n"
   "CALL :SHORTENPATH \"${OPENSSL_NATIVE_INSTALL_DIR}\" SHORTENED_OPENSSL_INSTALL_DIR\r\n")
-if(CASS_USE_ZLIB)
-  # OpenSSL requires zlib paths to be relative (otherwise build errors may occur)
-  externalproject_get_property(${OPENSSL_LIBRARY_NAME} SOURCE_DIR)
-  file(RELATIVE_PATH ZLIB_INCLUDE_RELATIVE_DIR ${SOURCE_DIR} ${ZLIB_INCLUDE_DIR})
-  file(TO_NATIVE_PATH ${ZLIB_INCLUDE_RELATIVE_DIR} ZLIB_NATIVE_INCLUDE_RELATIVE_DIR)
-  file(RELATIVE_PATH ZLIB_LIBRARY_RELATIVE_DIR ${SOURCE_DIR} ${ZLIB_LIBRARY_DIR})
-  file(TO_NATIVE_PATH ${ZLIB_LIBRARY_RELATIVE_DIR} ZLIB_NATIVE_LIBRARY_RELATIVE_DIR)
-  set(OPENSSL_WITH_ZLIB_ARGUMENT "zlib ${OPENSSL_ZLIB_CONFIGURE_ARGUMENT} --with-zlib-include=\"${ZLIB_NATIVE_INCLUDE_RELATIVE_DIR}\" --with-zlib-lib=\"${ZLIB_NATIVE_LIBRARY_RELATIVE_DIR}\\${ZLIB_LIB}\"")
-  set(OPENSSL_WITH_ZLIB_ARGUMENT "zlib ${OPENSSL_ZLIB_CONFIGURE_ARGUMENT} --with-zlib-include=\"${ZLIB_INCLUDE_RELATIVE_DIR}\" --with-zlib-lib=\"${ZLIB_LIBRARY_RELATIVE_DIR}\\${ZLIB_LIB}\"")
-endif()
 file(APPEND ${OPENSSL_CONFIGURE_SCRIPT}
   "perl Configure ${OPENSSL_WITH_ZLIB_ARGUMENT} --openssldir=!SHORTENED_OPENSSL_INSTALL_DIR! --prefix=!SHORTENED_OPENSSL_INSTALL_DIR! ${OPENSSL_CONFIGURE_COMPILER}\r\n"
   "IF NOT %ERRORLEVEL% EQU 0 (\r\n"
@@ -317,10 +291,5 @@ file(APPEND ${OPENSSL_CONFIGURE_SCRIPT}
   "  FOR %%A IN (\"%~1\") DO SET %~2=%%~SA\r\n"
   "  EXIT /B\r\n")
 
-# Determine if zlib should be added as a dependency
-if(CASS_USE_ZLIB)
-  add_dependencies(${OPENSSL_LIBRARY_NAME} ${ZLIB_LIBRARY_NAME})
-endif()
-
 # Update the include directory to use OpenSSL
 include_directories(${OPENSSL_INCLUDE_DIR})

dist/redhat/scylla-cpp-rust-driver.spec

@@ -17,7 +17,7 @@ Conflicts:      scylla-cpp-driver
 API-compatible rewrite of https://github.com/scylladb/cpp-driver as a wrapper for Rust driver.
 
 %package devel
-Summary:        Development libraries for ${name}
+Summary:        Development libraries for %{name}
 Group:          Development/Tools
 Requires:       %{name} = %{version}-%{release}
 Requires:       pkgconfig

docs/Makefile

@@ -20,10 +20,13 @@ all: dirhtml
 .PHONY: setupenv
 setupenv:
 	pip install -q poetry
+	sudo apt-get install doxygen
 
 .PHONY: setup
 setup:
 	$(POETRY) install
+	$(POETRY) update
+	cd .. && doxygen Doxyfile.in
 
 .PHONY: update
 update: