maokaihe/mini_lsm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document x sync

Browse Source 
Signed-off-by: Alex Chi <iskyzh@gmail.com>
This commit is contained in:
Alex Chi
2022-12-23 22:35:38 -05:00
parent 3c50c81b69
commit 9f3e29c781
3 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -16,3 +16,6 @@ cargo x install-tools
cargo x check cargo x check
cargo x book cargo x book
``` ```
If you changed public API in the reference solution, you might also need to synchronize it to the starter crate.
To do this, use `cargo x sync`.

4
mini-lsm-book/src/00-overview.md
View File

@@ -89,6 +89,10 @@ In this tutorial, we will build the LSM tree structure in 7 days:
* Day 6: Recovery. We will implement WAL and manifest so that the engine can recover after restart. * Day 6: Recovery. We will implement WAL and manifest so that the engine can recover after restart.
* Day 7: Bloom filter and key compression. They are widely-used optimizations in LSM tree structures. * Day 7: Bloom filter and key compression. They are widely-used optimizations in LSM tree structures.
## Development Guide
We provide you starter code (see `mini-lsm-starter` crate), where we simply replace all function body with We provide you starter code (see `mini-lsm-starter` crate), where we simply replace all function body with
`unimplemented!()`. You can start your project based on this starter code. We provide test cases, but they are very `unimplemented!()`. You can start your project based on this starter code. We provide test cases, but they are very
simple. We recommend you to think carefully about your implementation and write test cases by yourself. simple. We recommend you to think carefully about your implementation and write test cases by yourself.
You can use `cargo x scheck` to run all test cases and do style check in your codebase.

2
mini-lsm-starter/src/table/tests.rs
View File

@@ -1 +1 @@
//! Please copy `mini-lsm/src/table/tests.rs` here so that you can run tests.