From ee668d00f1dc544dc5af78dd4f8b72295897e9ee Mon Sep 17 00:00:00 2001 From: Alberto Bertogli Date: Sat, 12 Sep 2009 00:58:26 -0300 Subject: [PATCH 11/14] 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 --- doc/assumptions | 13 +++++++++++++ 1 files changed, 13 insertions(+), 0 deletions(-) create mode 100644 doc/assumptions 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. + + -- 1.6.2.2.646.gb214