Skip to content

Commit f7c85f8

Browse files
committed
update doc
1 parent 67b5889 commit f7c85f8

19 files changed

+8
-413
lines changed

doc/advanced.md

-7
This file was deleted.

doc/advanced_lib_extend.md

+8
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ Specifically, you can following the steps:
3939
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).
4040
6. Remember to add a test in [test/test_evictionAlgo.c](/test/test_evictionAlgo.c) and add the algorithm to this [README](README.md).
4141
42+
> [!TIP]
43+
> 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.
44+
45+
46+
> [!TIP]
47+
> 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).
48+
49+
4250
---
4351
4452
## Add new eviction algorithms in C++

doc0/API.rst

-13
This file was deleted.

doc0/Makefile

-20
This file was deleted.

doc0/cheatsheet.rst

-97
This file was deleted.

doc0/conf.py

-52
This file was deleted.

doc0/getting_started.rst

Whitespace-only changes.

doc0/index.rst

-22
This file was deleted.

doc0/make.bat

-35
This file was deleted.

doc0/new/Advanced/dataStruct.md

-14
This file was deleted.

doc0/new/Advanced/eviction.md

-35
This file was deleted.

doc0/new/Advanced/traceReader.md

-3
This file was deleted.

doc0/new/Advanced/tuning.md

-7
This file was deleted.

doc0/new/feature.md

-20
This file was deleted.

doc0/new/tutorial/cmp

-15
This file was deleted.

doc0/new/tutorial/highLevel.md

-19
This file was deleted.

0 commit comments

Comments
 (0)