瀏覽代碼

Added a note about the callback functions

Added a short section about the callback functions, based on the answers
to issue #35 and #36
Juerg Rast 7 年之前
父節點
當前提交
5c4ee2109d
共有 1 個文件被更改,包括 12 次插入0 次删除
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -120,6 +120,18 @@ really do anything to ensure that the data written to disk is machine portable.
 This is fine as long as all of the involved machines share endianness
 (little-endian) and don't have strange padding requirements.
 
+In the configuration struct, the `prog` and `erase` function provided by the
+user may return a `LFS_ERR_CORRUPT` error if the implementation already can
+detect corrupt blocks. However, the wear leveling does not depend on the return
+code of these functions, instead all data is read back and checked for
+integrity.
+
+If your storage caches writes, make sure that the provided `sync` function
+flushes all the data to memory and ensures that the next read fetches the data
+from memory, otherwise data integrity can not be guaranteed. If the `write`
+function does not perform caching, and therefore each `read` or `write` call
+hits the memory, the `sync` function can simply return 0.
+
 ## Reference material
 
 [DESIGN.md](DESIGN.md) - DESIGN.md contains a fully detailed dive into how