Commit 46805005 authored by John Esmet's avatar John Esmet

TMX-1 Rename TokuKV to TokuFT

parent c92c8cc9
......@@ -83,7 +83,7 @@ add_subdirectory(examples)
install(
FILES README.md README-TOKUDB
DESTINATION .
COMPONENT tokukv_misc
COMPONENT tokuft_misc
)
## build tags
......
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
......@@ -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
......@@ -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 ()
......
......@@ -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
......@@ -102,7 +102,7 @@ target_link_libraries(ftverify m)
install(
TARGETS tokuftdump
DESTINATION bin
COMPONENT tokukv_tools
COMPONENT tokuft_tools
)
add_subdirectory(tests)
......@@ -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 ()
......
......@@ -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 ()
......
......@@ -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 ()
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment