From 2f31a27316faf3de5008fcb5f49316e5178827e6 Mon Sep 17 00:00:00 2001
From: joe <joe@jerkface.net>
Date: Sun, 4 May 2014 19:47:21 -0400
Subject: haddock updates

---
 KeyRing.hs | 31 +++++++++++++++++++------------
 1 file changed, 19 insertions(+), 12 deletions(-)

(limited to 'KeyRing.hs')

diff --git a/KeyRing.hs b/KeyRing.hs
index a96d6a2..9d046b6 100644
--- a/KeyRing.hs
+++ b/KeyRing.hs
@@ -35,9 +35,8 @@ module KeyRing
     , KeyRingOperation(..)
     , PassphraseSpec(..)
     , Transform(..)
-    , PacketUpdate(..)
-    , noManip
-    , guardAuthentic
+    -- , PacketUpdate(..)
+    -- , guardAuthentic
     -- * Describing File Operations
     , StreamInfo(..)
     , Access(..)
@@ -188,11 +187,20 @@ home = HomeDir
     }
 
 data InputFile = HomeSec
+               -- ^ A file named secring.gpg located in the home directory.
+               -- See 'opHome'.
                | HomePub
+               -- ^ A file named pubring.gpg located in the home directory.
+               -- See 'opHome'.
                | ArgFile FilePath
+               -- ^ Contents will be read or written from the specified path.
                | FileDesc Posix.Fd
+               -- ^ Contents will be read or written from the specified file
+               -- descriptor.
                | Pipe Posix.Fd Posix.Fd
-               -- ^ Note: Don't use Pipe for wallet files. (TODO)
+               -- ^ Contents will be read from the first descriptor and updated
+               -- content will be writen to the second. Note: Don't use Pipe
+               -- for 'Wallet' files. (TODO: Wallet support)
  deriving (Eq,Ord)
 
 -- type UsageTag = String
@@ -250,24 +258,26 @@ data StreamInfo = StreamInfo { access :: Access
     --  * 'KF_None'  - The file's contents will not be shared.
     --
     --  * 'KF_Match' - The file's key will be shared with the specified owner
-    --  key and usage tag.
+    --  key and usage tag.  If 'fill' is also a 'KF_Match', then it must be
+    --  equal to this value; changing the usage or owner of a key is not
+    --  supported via the fill/spill mechanism.
     --
     --  * otherwise  - Unspecified.  Do not use.
     --
     -- 'WalletFile':
     --
     --  * The 'spill' setting is ignored and the file's contents are shared.
-    --  (TODO)
+    --    (TODO)
     --
     -- 'Hosts': 
     --
     --  * The 'spill' setting is ignored and the file's contents are shared.
-    -- (TODO)
+    --    (TODO)
     --
     , initializer :: Maybe String
     -- ^ If 'typ' is 'PEMFile' and an 'initializer' string is set, then it is
-    -- interpretted as a shell command that may be used to create the key if
-    -- it does not exist.
+    -- interpretted as a shell command that may be used to create the key if it
+    -- does not exist.
     , transforms :: [Transform] 
     -- ^ Ignored.  TODO: The intention is that we may indicate per-file
     -- transformations that occur before the contents of a file are spilled
@@ -330,9 +340,6 @@ data KeyRingRuntime = KeyRingRuntime
 --         action.
 data PacketUpdate = InducerSignature String [SignatureSubpacket]
 
-noManip :: KeyRingRuntime -> KeyData -> [PacketUpdate]
-noManip _ _ = []
-
 -- | This type is used to indicate where to obtain passphrases.
 data PassphraseSpec = PassphraseSpec
     { passSpecRingFile :: Maybe FilePath
-- 
cgit v1.2.3