From 0be968d9ebccb2dec43e75a015edfa10bc49d4c7 Mon Sep 17 00:00:00 2001 From: Calascibetta Romain Date: Fri, 8 Nov 2024 16:20:02 +0100 Subject: [PATCH] Fix link for map_file into the README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 422f097..aef1136 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Cachet is a small library that provides a simple cache system for page-by-page read access on a block device. The cache system requires a map function, which -can correspond to [Unix.map_file]. +can correspond to [Unix.map_file][unix-map-file]. Here's a simple example using `Unix.map_file`: ```ocaml @@ -78,3 +78,5 @@ Finally, the Cachet documentation specifies how many pages we would need to read to obtain the requested value. As a result, it's up to the user to know where the cooperation point should be placed and whether it makes sense to use, for example, `get_string` or just use `load` interspersed with cooperation points. + +[unix-map-file]: https://ocaml.org/manual/5.2/api/Unix.html#1_Mappingfilesintomemory