Skip to content

Commit

Permalink
updated branding to tokuft
Browse files Browse the repository at this point in the history
  • Loading branch information
leifwalsh committed Jul 5, 2014
1 parent dc07bf7 commit c536154
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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`).
Expand Down Expand Up @@ -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.
Expand All @@ -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`.
Expand All @@ -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:

Expand All @@ -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

0 comments on commit c536154

Please sign in to comment.