update doc

cacheMon · Aug 16, 2024 · f7c85f8 · f7c85f8
1 parent 67b5889
commit f7c85f8
Show file tree

Hide file tree

Showing 19 changed files with 8 additions and 413 deletions.
diff --git a/doc/advanced.md b/doc/advanced.md
diff --git a/doc/advanced_lib_extend.md b/doc/advanced_lib_extend.md
@@ -39,6 +39,14 @@ Specifically, you can following the steps:
 5. Add command line option in [bin/cachesim/cache_init.h](/libCacheSim/bin/cachesim/cache_init.h) so that you can use `cachesim` binary. You may also want to take a look at [bin/cachesim/cli_parser.c](/libCacheSim/bin/cachesim/cli_parser.c). 
 6. Remember to add a test in [test/test_evictionAlgo.c](/test/test_evictionAlgo.c) and add the algorithm to this [README](README.md). 
 
+> [!TIP]
+> Many eviction algorithms use a doubly linked list to maintain state, libCacheSim provides several functions in [cacheObj.h](/libCacheSim/include/libCacheSim/cacheObj.h) to manipulate list. 
+
+
+> [!TIP]
+> Many eviction algorithms are composable, e.g., LeCaR uses one LRU and one LFU, it is easy to support these algorithms in libCacheSim, please take a look at [LeCaR](/libCacheSim/cache/eviction/LeCaRv0.c). 
+
+
 ---
 
 ## Add new eviction algorithms in C++

diff --git a/doc0/API.rst b/doc0/API.rst
diff --git a/doc0/Makefile b/doc0/Makefile
diff --git a/doc0/cheatsheet.rst b/doc0/cheatsheet.rst
diff --git a/doc0/conf.py b/doc0/conf.py
diff --git a/doc0/getting_started.rst b/doc0/getting_started.rst
diff --git a/doc0/index.rst b/doc0/index.rst
diff --git a/doc0/make.bat b/doc0/make.bat
diff --git a/doc0/new/Advanced/dataStruct.md b/doc0/new/Advanced/dataStruct.md
diff --git a/doc0/new/Advanced/eviction.md b/doc0/new/Advanced/eviction.md
diff --git a/doc0/new/Advanced/traceReader.md b/doc0/new/Advanced/traceReader.md
diff --git a/doc0/new/Advanced/tuning.md b/doc0/new/Advanced/tuning.md
diff --git a/doc0/new/feature.md b/doc0/new/feature.md
diff --git a/doc0/new/tutorial/cmp b/doc0/new/tutorial/cmp
diff --git a/doc0/new/tutorial/highLevel.md b/doc0/new/tutorial/highLevel.md