added explanations to many modules

Distribution/InstalledPackageInfo.hs

@@ -7,11 +7,10 @@
 -- Stability   :  alpha
 -- Portability :  portable
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Information on how to USE an installed package,
+-- consumed by HC-PKG (ghc-pkg, for instance).
 
-{- Copyright (c) 2004, The University of Glasgow
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Make.hs

@@ -7,11 +7,11 @@
 -- Stability   :  alpha
 -- Portability :  GHC
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Uses the parsed command-line from Distribution.Setup
+-- in order to build haskell tools using a backend build system based
+-- on Make.
 
-{- Copyright (c) 2004, Martin Sjögren
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Misc.hs

@@ -8,11 +8,10 @@
 -- Stability   :  alpha
 -- Portability :  
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Misc stuff that doesn't fit elsewhere. License,
+-- Dependencies, extensions.
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/ModuleTest.hs

@@ -8,11 +8,9 @@
 -- Stability   :  alpha
 -- Portability :  GHC
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Test this module and sub modules.
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Package.hs

@@ -8,11 +8,9 @@
 -- Stability   :  alpha
 -- Portability :  
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Package description and parsing
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Setup.hs

@@ -9,11 +9,11 @@
 -- Stability   :  alpha
 -- Portability :  
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Data types and parser for the standard command-line
+-- setup.  Will also return commands it doesn't know about.
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Simple.hs

@@ -8,11 +8,12 @@
 -- Stability   :  alpha
 -- Portability :  GHC
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Simple build system; basically the interface for
+-- Distribution/Simple/\* modules.  When given the parsed command-line
+-- args and package information, is able to perform basic commands
+-- like configure, build, install, register, etc.
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Simple/Configure.hs

@@ -8,11 +8,10 @@
 -- Stability   :  alpha
 -- Portability :  GHC
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Perform the "./setup configure" action.  Outputs the
+-- .setup-config file.
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Simple/GHCPackageConfig.hs

@@ -7,8 +7,8 @@
 -- Stability   :  alpha
 -- Portability :  portable
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Performs registration for GHC.  Specific to
+-- ghc-pkg. Creates a GHC package config file.
 
 module Distribution.Simple.GHCPackageConfig (
 	GHCPackageConfig(..),

Distribution/Simple/Install.hs

@@ -8,11 +8,10 @@
 -- Stability   :  alpha
 -- Portability :  GHC
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Perform the "./setup install" action.  Move files into
+-- place based on the prefix argument.
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/Simple/Register.hs

@@ -8,8 +8,9 @@
 -- Stability   :  alpha
 -- Portability :  
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Perform the "./setup register" action.  Uses a
+-- drop-file for HC-PKG. See also InstalledPackageInfo
+
 
 {- Copyright (c) 2003-2004, Isaac Jones
 All rights reserved.

Distribution/Simple/Utils.hs

@@ -2,17 +2,16 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Distribution.Simple.Utils
--- Copyright   :  Isaac Jones 2003-2004
+-- Copyright   :  Isaac Jones, Simon Marlow 2003-2004
 -- 
 -- Maintainer  :  Isaac Jones <ijones@syntaxpolice.org>
 -- Stability   :  alpha
 -- Portability :  GHC
 --
--- Explanation: <FIX>
--- WHERE DOES THIS MODULE FIT IN AT A HIGH-LEVEL <FIX>
+-- Explanation: Misc. Utilities, especially file-related utilities.
+-- Stuff used by multiple modules that doesn't fit elsewhere.
 
-{- Copyright (c) 2003-2004, Isaac Jones
-All rights reserved.
+{- All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

Distribution/TODO

 * 0.1
 RC:
 ** grep for "FIX"
+** make sure module documentation (haddock) builds.
 ** Extensions
 - complain if their use makes the code non-portable?
 - constructorless data-types?
@@ -12,14 +13,15 @@ HIGH:
 
 LOW
 ** clean 
-- does clean remove installed-pkg-config and .setup-config or whatever? 
 - should .installed-pkg-config be removed after successful register?
-** add "clean" to doc?
-** add description file format to doc.
 ** Change name of Setup.description?
 ** the ./setup -h output should document which commands exist, and
    which options are relevant to which commands.
-** add note to doc that we're going to chase dependencies and make the
+
+** DOC
+*** add "clean" to doc?
+*** add description file format to doc.
+*** add note to doc that we're going to chase dependencies and make the
    "modules" field unnecessary in the future.
 
 * 1.0