git » libjio » commit ee668d0

Document the assumptions the library makes

author Alberto Bertogli
2009-09-12 03:58:26 UTC
committer Alberto Bertogli
2009-09-12 03:58:26 UTC
parent f5c4408ccde387c00881abe0dc2ceef41df5ca5b

Document the assumptions the library makes

We're probably forgetting some things, but it's better to have this than
nothing.

Signed-off-by: Alberto Bertogli <albertito@blitiri.com.ar>

doc/assumptions +13 -0

diff --git a/doc/assumptions b/doc/assumptions
new file mode 100644
index 0000000..e7a0862
--- /dev/null
+++ b/doc/assumptions
@@ -0,0 +1,13 @@
+
+The following list documents the assumptions the library makes. All of them
+should be well within normal behaviour for decent filesystems.
+
+ - fcntl() locking works.
+ - fsync(), fdatasync() and sync_file_range(WAIT_AFTER) return after the data
+   has been stored on stable storage, like they're supposed to.
+ - If a crash occurs while a write is in progress, the data within the
+   relevant range may contain garbage, but the data outside the range will not
+   be touched. Failure in doing so is normally considered corruption and
+   covering from it is outside the scope of the library.
+
+