diff --git a/CMakeLists.txt b/CMakeLists.txt index 5a5a9713b4e585d3947a794b381b48d3c2efc751..6d2b8773e6cea4d2d9f4f578cf93c31269c8cdeb 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -83,7 +83,7 @@ add_subdirectory(examples) install( FILES README.md README-TOKUDB DESTINATION . - COMPONENT tokukv_misc + COMPONENT tokuft_misc ) ## build tags diff --git a/README.md b/README.md index 72b8988165a4d8a132f8d4f511c30152342a9794..12d6e6e4eedf5748bdfed81977c51fbe85c27d76 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -TokuKV +TokuFT ====== -TokuKV is a high-performance, transactional key-value store, used in the +TokuFT is a high-performance, transactional key-value store, used in the TokuDB storage engine for MySQL and MariaDB and in TokuMX, the high-performance MongoDB distribution. -TokuKV is provided as a shared library with an interface similar to +TokuFT is provided as a shared library with an interface similar to Berkeley DB. To build the full MySQL product, see the instructions for [Tokutek/ft-engine][ft-engine]. To build TokuMX, see the instructions -for [Tokutek/mongo][mongo]. This document covers TokuKV only. +for [Tokutek/mongo][mongo]. This document covers TokuFT only. [ft-engine]: https://github.com/Tokutek/ft-engine [mongo]: https://github.com/Tokutek/mongo @@ -19,7 +19,7 @@ for [Tokutek/mongo][mongo]. This document covers TokuKV only. Building -------- -TokuKV is built using CMake >= 2.8.9. Out-of-source builds are +TokuFT is built using CMake >= 2.8.9. Out-of-source builds are recommended. You need a C++11 compiler, though only GCC >= 4.7 and Apple's Clang are tested. You also need zlib development packages (`yum install zlib-devel` or `apt-get install zlib1g-dev`). @@ -50,14 +50,14 @@ to that if you are planning to run benchmarks or in production. ### Platforms -TokuKV is supported on 64-bit Centos, should work on other 64-bit linux -distributions, and may work on OSX 10.8 and FreeBSD. TokuKV is not +TokuFT is supported on 64-bit Centos, should work on other 64-bit linux +distributions, and may work on OSX 10.8 and FreeBSD. TokuFT is not supported on 32-bit systems. [Transparent hugepages][transparent-hugepages] is a feature in newer linux kernel versions that causes problems for the memory usage tracking -calculations in TokuKV and can lead to memory overcommit. If you have -this feature enabled, TokuKV will not start, and you should turn it off. +calculations in TokuFT and can lead to memory overcommit. If you have +this feature enabled, TokuFT will not start, and you should turn it off. If you want to run with transparent hugepages on, you can set an environment variable `TOKU_HUGE_PAGES_OK=1`, but only do this for testing, and only with a small cache size. @@ -68,23 +68,23 @@ and only with a small cache size. Examples -------- -There are some sample programs that can use either TokuKV or Berkeley DB +There are some sample programs that can use either TokuFT or Berkeley DB in the `examples/` directory. Follow the above instructions to build and -install TokuKV, and then look in the installed `examples/` directory for +install TokuFT, and then look in the installed `examples/` directory for instructions on building and running them. Testing ------- -TokuKV uses CTest for testing. The CDash testing dashboard is not +TokuFT uses CTest for testing. The CDash testing dashboard is not currently public, but you can run the tests without submitting them. There are some large data files not stored in the git repository, that will be made available soon. For now, the tests that use these files will not run. -Many of the tests are linked with both TokuKV and Berkeley DB, as a sanity +Many of the tests are linked with both TokuFT and Berkeley DB, as a sanity check on the tests themselves. To build these tests, you will need Berkeley DB and its header files installed. If you do not have Berkeley DB installed, just don't pass `USE_BDB=ON`. @@ -103,7 +103,7 @@ ctest -D ExperimentalStart \ Contributing ------------ -Please report bugs in TokuKV here on github. +Please report bugs in TokuFT here on github. We have two publicly accessible mailing lists for TokuDB: @@ -125,7 +125,7 @@ We are also available on IRC on freenode.net, in the #tokutek channel. License ------- -TokuKV is available under the GPL version 2, with slight modifications. +TokuFT is available under the GPL version 2, with slight modifications. See [README-TOKUDB][license]. [license]: http://github.com/Tokutek/ft-index/blob/master/README-TOKUDB diff --git a/buildheader/CMakeLists.txt b/buildheader/CMakeLists.txt index d9629f2cc686356c58fe1a66d294148ecc8d2ab2..68d7ddb541269ae5a9412b7f1076c7085fe26b48 100644 --- a/buildheader/CMakeLists.txt +++ b/buildheader/CMakeLists.txt @@ -19,11 +19,11 @@ if (NOT DEFINED MYSQL_PROJECT_NAME_DOCSTRING) FILES "${CMAKE_CURRENT_BINARY_DIR}/db.h" DESTINATION include RENAME tokudb.h - COMPONENT tokukv_headers + COMPONENT tokuft_headers ) install( FILES "${CMAKE_CURRENT_BINARY_DIR}/db.h" DESTINATION include - COMPONENT tokukv_headers + COMPONENT tokuft_headers ) endif () \ No newline at end of file diff --git a/cmake_modules/TokuThirdParty.cmake b/cmake_modules/TokuThirdParty.cmake index 0e8be69bf37a16f4e68c49de5c37d3009b5abb60..4aefb569f6ca9bf8e5e593597eac91667e11b074 100644 --- a/cmake_modules/TokuThirdParty.cmake +++ b/cmake_modules/TokuThirdParty.cmake @@ -29,7 +29,7 @@ if (NOT DEFINED LIBJEMALLOC) # detect when we are being built as a subproject if (NOT DEFINED MYSQL_PROJECT_NAME_DOCSTRING) install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/jemalloc/lib" DESTINATION . - COMPONENT tokukv_libs_extra) + COMPONENT tokuft_libs_extra) endif () endif () endif () diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 01ad01aa8d2fe396ea37d361d4abc665012d2cb8..9e2a35143ff5f4a34f53d208f89f8c7c7158a648 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -11,6 +11,6 @@ if (NOT DEFINED MYSQL_PROJECT_NAME_DOCSTRING) DESTINATION examples COMPONENT - tokukv_examples + tokuft_examples ) endif () \ No newline at end of file diff --git a/ft/CMakeLists.txt b/ft/CMakeLists.txt index 95d7866cb9d3b343ade52491171fb89fbc90286e..07cc4e3fbe4f63c5767f250ae9efd0c7d9ea259e 100644 --- a/ft/CMakeLists.txt +++ b/ft/CMakeLists.txt @@ -102,7 +102,7 @@ target_link_libraries(ftverify m) install( TARGETS tokuftdump DESTINATION bin - COMPONENT tokukv_tools + COMPONENT tokuft_tools ) add_subdirectory(tests) diff --git a/portability/CMakeLists.txt b/portability/CMakeLists.txt index 93dcf1d16751ba10e62ad5513308c95ce7eabe19..c690a9aee509a64be8c52e95a7ca4ae127711ce7 100644 --- a/portability/CMakeLists.txt +++ b/portability/CMakeLists.txt @@ -38,22 +38,22 @@ if (NOT DEFINED MYSQL_PROJECT_NAME_DOCSTRING) install( FILES toku_os_types.h toku_time.h toku_list.h toku_os.h DESTINATION include - COMPONENT tokukv_headers + COMPONENT tokuft_headers ) install( FILES "${CMAKE_CURRENT_BINARY_DIR}/toku_config.h" DESTINATION include - COMPONENT tokukv_headers + COMPONENT tokuft_headers ) install( TARGETS ${LIBTOKUPORTABILITY}_static DESTINATION ${INSTALL_LIBDIR} - COMPONENT tokukv_libs_static + COMPONENT tokuft_libs_static ) install( TARGETS ${LIBTOKUPORTABILITY} DESTINATION ${INSTALL_LIBDIR} - COMPONENT tokukv_libs_shared + COMPONENT tokuft_libs_shared ) endif () diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 28e51c3f8fe32906ec0f3f50461e33c12a78dc0c..284d798ea8755c5b0f5ee184822ee1f8f580c111 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -44,12 +44,12 @@ if (NOT DEFINED MYSQL_PROJECT_NAME_DOCSTRING) install( TARGETS ${LIBTOKUDB} DESTINATION ${INSTALL_LIBDIR} - COMPONENT tokukv_libs_shared + COMPONENT tokuft_libs_shared ) install( TARGETS ${LIBTOKUDB}_static DESTINATION ${INSTALL_LIBDIR} - COMPONENT tokukv_libs_static + COMPONENT tokuft_libs_static ) endif () diff --git a/util/CMakeLists.txt b/util/CMakeLists.txt index 6a0bb6208a5d012904adb6bc5edb0dc5ae810d2e..decbcff8e8503ba2f99b23f074bfdc2a0a8633b4 100644 --- a/util/CMakeLists.txt +++ b/util/CMakeLists.txt @@ -24,7 +24,7 @@ if (NOT DEFINED MYSQL_PROJECT_NAME_DOCSTRING) install( FILES partitioned_counter.h DESTINATION include - COMPONENT tokukv_headers + COMPONENT tokuft_headers ) endif ()