git » libjio » commit 88022e8

Minor documentation updates

author Alberto Bertogli
2009-09-12 15:51:22 UTC
committer Alberto Bertogli
2009-09-12 15:51:22 UTC
parent f35db11e592be9964a47ea9858e4f381ee83409d

Minor documentation updates

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

README +11 -17
UPGRADING +5 -3

diff --git a/README b/README
index 0413faf..f560f08 100644
--- a/README
+++ b/README
@@ -1,32 +1,26 @@
 
 libjio - A library for Journaled I/O
-Alberto Bertogli (albertito@blitiri.com.ar)
--------------------------------------------
+------------------------------------
 
-As the name says, this is a simple userspace library to do journaled,
-transaction-oriented I/O.
+libjio is a simple userspace library to do journaled, transaction-oriented
+I/O.
 
-It provides a very simple transaction API to commit and rollback transactions,
-and on top of that a unix-alike set of functions to perform most regular
-operations (ie. open, read, write).
+It provides a transaction API to commit and rollback transactions, and on top
+of that a unix-alike set of functions to perform most regular operations (ie.
+open, read, write, etc.).
 
-On the disk, the file you work on is exactly like a regular one, but a
-special directory is created to store in-flight transactions.
+The library guarantees file integrity even after unexpected crashes, never
+leaving your files in an inconsistent state.
 
-This allows both simple file manipulation, recovery and debugging because
-everything is isolated.
-
-There are more detailed documents: a programming guide, a brief introduction
-to the design and inner workings, and the manpage; all in the doc/ directory.
+You can find more detailed documents, including the programmer's guide, in the
+doc/ directory, and the manpage in the libjio/ directory.
 
 
 To see how to install it, please read the INSTALL file.
 
 It is in the public domain, see the LICENSE file for more details.
 
-Comments and patches are always welcome; please send them to my email address,
+Comments and patches are always welcome; please send them to
 albertito@blitiri.com.ar.
 
-Thanks,
-		Alberto
 
diff --git a/UPGRADING b/UPGRADING
index 0db68b4..68d843d 100644
--- a/UPGRADING
+++ b/UPGRADING
@@ -2,9 +2,11 @@
 Here you can find a summary of the changes in the library that could require
 an effort from its users, like the ones affecting the API, ABI or semantics.
 
-You should always clean all your files before upgrading. While I don't expect
-the transaction on-disk format to change, it's a good practise and it doesn't
-take much effort. When it's mandatory, it will be noted.
+Normally, nothing should be required when upgrading between two stable
+releases from the same branch.
+
+
+------- 1.00: Stable release
 
 -> 0.90 (On-disk format change, pre 1.0 freeze)
   - The way transactions are stored on disk has changed. It is mandatory that