robur/cachet
4
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix link for map_file into the README.md

Browse source
This commit is contained in:
Calascibetta Romain 2024-11-08 16:20:02 +01:00
parent c3f4deb3d4
commit 0be968d9eb
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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