various doc cleanups

README.txt

@@ -42,7 +42,7 @@ distutils setup.py file.
 
 To upgrade to a new version "appname-X.Z", esky performs the following steps:
     * extract it into a temporary directory under "updates"
-    * move all bootstrapping files into "appname-X.Z.platform/esky-bootstrap"
+    * move all bootstrapping files into "appname-X.Z.platm/esky-bootstrap"
     * atomically rename it into the main directory as "appname-X.Z.platform"
     * move contents of "appname-X.Z.platform/esky-bootstrap" into the main dir
     * remove the "appname-X.Z.platform/esky-bootstrap" directory

TODO.txt

@@ -1,3 +1,4 @@
 
- * nothing for the moment...
+ * customisable bootstrap process
+ * hooks for code signing etc
 

esky/__init__.py

@@ -44,7 +44,7 @@
 
 To upgrade to a new version "appname-X.Z", esky performs the following steps:
     * extract it into a temporary directory under "updates"
-    * move all bootstrapping files into "appname-X.Z.platform/esky-bootstrap"
+    * move all bootstrapping files into "appname-X.Z.platm/esky-bootstrap"
     * atomically rename it into the main directory as "appname-X.Z.platform"
     * move contents of "appname-X.Z.platform/esky-bootstrap" into the main dir
     * remove the "appname-X.Z.platform/esky-bootstrap" directory

esky/bdist_esky.py

@@ -58,7 +58,7 @@ class bdist_esky(Command):
         excludes:  a list of modules to explicitly exclude from the freeze
 
         bootstrap_module:  a custom module to use for esky bootstrapping;
-                           the default just calls esky.bootstrap.bootstap()
+                           the default just calls esky.bootstrap.bootstrap()
 
     
     """
@@ -75,7 +75,7 @@ class bdist_esky(Command):
                     ('excludes=', None,
                      "list of modules to specifically exclude"),
                     ('include-interpreter', None,
-                     "include bbfreeze python interpreter"),
+                     "include bbfreeze custom python interpreter"),
                    ]
 
     boolean_options = ["include-interpreter"]
@@ -123,16 +123,16 @@ def freeze_scripts(self):
         f.include_py = self.include_interpreter
         f.addModule("esky")
         if self.distribution.has_scripts():
-            for s in self.distribution.scripts:
-                f.addScript(s,gui_only=s.endswith(".pyw"))
+            for script in self.distribution.scripts:
+                f.addScript(script,gui_only=script.endswith(".pyw"))
         f()
 
     def add_data_files(self):
         """Add any data_files under the frozen directory."""
         fdir = self.freeze_dir
         if self.distribution.data_files:
             for datafile in self.distribution.data_files:
-                #  Plain strings get placed in the root dist directory
+                #  Plain strings get placed in the root dist directory.
                 if isinstance(datafile,basestring):
                     datafile = ("",[datafile])
                 (df_dest,df_sources) = datafile
@@ -163,7 +163,10 @@ def add_package_data(self):
         lib.close()
 
     def get_package_dir(self,pkg):
-        """Return directory where the given package is location."""
+        """Return directory where the given package is located.
+
+        This was largely swiped from distutils, with some cleanups.
+        """
         inpath = pkg.split(".")
         outpath = []
         if not self.distribution.package_dir:
@@ -191,7 +194,7 @@ def get_package_dir(self,pkg):
             return ""
 
     def add_bootstrap_env(self):
-        """Create the bootstrap environment."""
+        """Create the bootstrap environment inside the frozen dir."""
         #  Create bootstapping library.zip
         self.copy_to_bootstrap_env("library.zip")
         bslib_path = os.path.join(self.bootstrap_dir,"library.zip")

esky/bootstrap.py

@@ -14,8 +14,8 @@
 update could result in the boostrapper from a new version being forced
 to load an old version.
 
-The code from this module is included in the bootstrapping environment under
-the module name "bootstrap". 
+The code from this module is always included in the bootstrapping environment
+under the module name "bootstrap". 
 
 If I can be bothered doing all this in C, I plan to eventually replace this
 module with a custom program loader. For now, this lets us get up and running

esky/finder.py

@@ -4,7 +4,7 @@
 
   esky.finder:  VersionFinder implementations for esky
 
-This module provides the default VersionFinder implementains for esky. The
+This module provides the default VersionFinder implementations for esky. The
 abstract base class 'VersionFinder' defines the expected interface, while 
 'SimpleVersionFinder' provides a simple default implementation that hits a
 specified URL to look for new versions.

esky/fstransact.py

@@ -142,7 +142,7 @@ def move(self,source,target):
             if files_differ(source,target):
                 self.pending.append(("_move",source,target))
             else:
-                self.pending.append(("_remove",target))
+                self.pending.append(("_remove",source))
 
         def _move(self,source,target):
             if sys.platform == "win32" and os.path.exists(target):