Add tutorial and user doc. #4
Conversation
|
Hi Ziyan, Thanks, |
|
Both tutorial.cpp and code snippets in user_doc.md are updated to LLVM style now. |
| /.vs | ||
| /doc/impl_doc_cn.md | ||
| /doc/impl_doc.md | ||
| /doc/images |
There was a problem hiding this comment.
impl_doc is incomplete yet. /.vs contains irrelevant Visual Studio Intellisense files.
doc/user_doc.md
Outdated
| db_configs.pmem_segment_blocks = (1ull << 8); | ||
| db_configs.num_hash_buckets = (1ull << 10); | ||
| } | ||
| // The KVDK instance is mounted as DB under /mnt/pmem0/ |
There was a problem hiding this comment.
as DB -> as a directory tutorial_kvdk_example
doc/user_doc.md
Outdated
| } | ||
| // The KVDK instance is mounted as DB under /mnt/pmem0/ | ||
| // Modify this path if necessary. | ||
| std::string db_path{"/mnt/pmem0/tutorial_kvdk_example"}; |
There was a problem hiding this comment.
Since we don't call it db now, maybe we should change db to instance or engine, e.g. db_path -> instance_path, db_configs->configs
doc/user_doc.md
Outdated
| KV-Pair indexing stored on DRAM are purged. | ||
| Follow "Opening a Database" to reopen the database will reconstruct indexing on DRAM with information persisted on PMEM. | ||
|
|
||
| To purge contents on PMEM, just delete it from PMEM mounted as a file. |
There was a problem hiding this comment.
"just delete it from PMEM mounted as a file." -> "just delete the dir from PMEM"
|
Modified names with prefix |
Signed-off-by: Ziyan Shi <ziyan.shi@intel.com>
No description provided.