fix: cabal-file, readme, minor documentation additions
authorMax Voit <max.voit+gtdv@with-eyes.net>
Fri, 21 Aug 2015 11:30:39 +0000 (13:30 +0200)
committerMax Voit <max.voit+gtdv@with-eyes.net>
Fri, 21 Aug 2015 11:30:39 +0000 (13:30 +0200)
acid-state-dist.cabal
readme.md
src/Data/Acid/Centered.hs

index ab9e3a7..8a04e9f 100644 (file)
@@ -19,7 +19,7 @@ synopsis:            Replication backend for acid-state
 -- description:
 
 -- The license under which the package is released.
-license:             GPL-3
+license:             MIT
 
 -- The file containing the license text.
 license-file:        LICENSE
@@ -29,12 +29,12 @@ author:              Max Voit
 
 -- An email address to which users can send suggestions, bug reports, and
 -- patches.
-maintainer:          max.voit+hdv@with-eyes.net
+maintainer:          <max.voit+hdv@with-eyes.net>
 
 -- A copyright notice.
 -- copyright:
 
-category:            Data
+category:            Database
 
 build-type:          Simple
 
@@ -50,6 +50,10 @@ flag debug
   description:       enable debug output
   default:           True
 
+-- Source
+source-repository head
+  type: git
+  location: http://git.with-eyes.net/gitweb/?p=acid-state-dist.git
 
 library
   -- Modules exported by the library.
index b3f9f1d..47feae1 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -7,11 +7,11 @@ Run an acid-state application on multiple nodes and have all instances operate
 on the same state.
 Two operation modes are provided:
 
      - Regular operation: without redundancy guarantees but fast,
      - Redundant operation: guarantees replication on _n_ nodes but slower.
- **Regular operation**: without redundancy guarantees but fast,
- **Redundant operation**: guarantees replication on _n_ nodes but slower.
 
 Extented documentation is available via Haddock (/Hackage, as soon as released).
 
 For questions and feedback, feel free to contact me by e-mail
-<max.voit+hdv@with-eyes.net> or via IRC (sdx23 on irc.freenode.net).
+max.voit+hdv@with-eyes.net or via IRC (sdx23 on irc.freenode.net).
 
index 7b73edb..8e980f2 100644 (file)
@@ -27,8 +27,9 @@ module Data.Acid.Centered
     (
 -- * Usage
 -- |
--- Open your AcidState using one of the functions below. Afterwards the usual
--- interface of acid state is available.
+-- Open your AcidState using one of the functions below. Take care to use the
+-- same initial-state on all nodes. Afterwards the usual interface of acid state
+-- is available.
 --
 -- Always make sure to have sensible exception management since naturally a lot
 -- more error sources exist with this backend than do for a 'Data.Acid.Local'
@@ -43,7 +44,8 @@ module Data.Acid.Centered
 -- >               ...
 --
 -- 'Data.Acid.createCheckpoint' issued on Master is a global operation,
--- while issued on a Slave it is not.
+-- while issued on a Slave it is not. Note that Checkpoints on Master reduce the
+-- amount of Updates to be transferred when a Slave (re-)connects.
 --
 -- 'Data.Acid.createArchive' is an operation local to each node since usually
 -- further action is required. For global Archives see 'createArchiveGlobally'.