1== Summary ==
2This directory contains RocksDB-based Storage Engine (RDBSE) for MySQL,
3also known as "MyRocks".
4
5== Resources ==
6https://github.com/facebook/mysql-5.6/wiki/Getting-Started-with-MyRocks
7https://www.facebook.com/groups/MyRocks/
8
9== Coding Conventions ==
10The baseline for MyRocks coding conventions for the code in storage/rocksdb/
11is based on the default clang format with a few minor changes.  The file
12storage/rocksdb/.clang-format describes conventions and can be integrated
13with Vim or Emacs as described here:
14http://releases.llvm.org/3.6.0/tools/clang/docs/ClangFormat.html#vim-integration
15
16All code outside of storage/rocksdb/ should conform to the MySQL coding
17conventions:
18http://dev.mysql.com/doc/internals/en/coding-guidelines.html.
19
20Several refinements:
21  0. There is an umbrella C++ namespace named "myrocks" for all MyRocks code.
22  1. We introduced "RDB" as the super-short abbreviation for "RocksDB". We will
23     use it as a name prefix, with different capitalization (see below), to ease
24     up code navigation with ctags and grep.
25     N.B. For ease of matching, we'll keep the variables and functions dealing
26          with sysvars as close as possible to the outside visible names of
27          sysvars, which start with "rocksdb_" prefix, the outward storage
28          engine name.
29  2. The names for classes, interfaces, and C++ structures (which act as
30     classes), start with prefix "Rdb_".
31     NB: For historical reasons, we'll keep the "ha_<storage_engine_name>" class
32         name for ha_rocksdb class, which is an exception to the rule.
33  3. The names for global objects and functions start with prefix "rdb_".
34  4. The names for macros and constants start with prefix "RDB_".
35  5. Regular class member names start with "m_".
36  6. Static class member names start with "s_".
37  7. Given the 80 character per line limit, we'll not always use full English
38     words in names, when a well known or easily recognizable abbreviation
39     exists (like "tx" for "transaction" or "param" for "parameter" etc).
40  8. When needing to disambiguate, we use different suffixes for that, like
41     "_arg" for a function argument/parameter, "_arr" for a C style array, and
42     "_vect" for a std::vector etc.
43
44== Running Tests ==
45To run tests from rocksdb, rocksdb_rpl or other rocksdb_* packages, no extra
46parameters are necessary. Simply specify the suite and/or test names.
47