docs: simplifying categories (#15757)

This commit is contained in:
Julien Robert
2023-04-10 13:19:57 +02:00
committed by GitHub
parent 59e5ca20b6
commit 107836964d
14 changed files with 71 additions and 110 deletions
+23 -24
View File
@@ -1,25 +1,24 @@
# Inter-block Cache
- [Inter-block cache](#inter-block-cache)
- [Synopsis](#synopsis)
- [Overview and basic concepts](#overview-and-basic-concepts)
- [Motivation](#motivation)
- [Definitions](#definitions)
- [System model and properties](#system-model-and-properties)
- [Assumptions](#assumptions)
- [Properties](#properties)
- [Thread safety](#thread-safety)
- [Crash recovery](#crash-recovery)
- [Iteration](#iteration)
- [Technical specification](#technical-specification)
- [General design](#general-design)
- [API](#api)
- [CommitKVCacheManager](#commitkvcachemanager)
- [CommitKVStoreCache](#commitkvstorecache)
- [Implementation details](#implementation-details)
- [History](#history)
- [Copyright](#copyright)
* [Inter-block Cache](#inter-block-cache)
* [Synopsis](#synopsis)
* [Overview and basic concepts](#overview-and-basic-concepts)
* [Motivation](#motivation)
* [Definitions](#definitions)
* [System model and properties](#system-model-and-properties)
* [Assumptions](#assumptions)
* [Properties](#properties)
* [Thread safety](#thread-safety)
* [Crash recovery](#crash-recovery)
* [Iteration](#iteration)
* [Technical specification](#technical-specification)
* [General design](#general-design)
* [API](#api)
* [CommitKVCacheManager](#commitkvcachemanager)
* [CommitKVStoreCache](#commitkvstorecache)
* [Implementation details](#implementation-details)
* [History](#history)
* [Copyright](#copyright)
## Synopsis
@@ -33,9 +32,9 @@ The goal of the inter-block cache is to allow SDK modules to have fast access to
### Definitions
- `Store key` uniquely identifies a store.
- `KVCache` is a `CommitKVStore` wrapped with a cache.
- `Cache manager` is a key component of the inter-block cache responsible for maintaining a map from `store keys` to `KVCaches`.
* `Store key` uniquely identifies a store.
* `KVCache` is a `CommitKVStore` wrapped with a cache.
* `Cache manager` is a key component of the inter-block cache responsible for maintaining a map from `store keys` to `KVCaches`.
## System model and properties
@@ -287,4 +286,4 @@ Dec 20, 2022 - Initial draft finished and submitted as a PR
## Copyright
All content herein is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
All content herein is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).