[Zope3-checkins] SVN: Zope3/trunk/releases/Zope-win/Zope-win-fixup.py Fleshed out the docs, so that (I hope) it's now obvious

[Tim Peters]

Log message for revision 39450:
  Fleshed out the docs, so that (I hope) it's now obvious
  why this exists and what it does.
  

Changed:
  U   Zope3/trunk/releases/Zope-win/Zope-win-fixup.py

-=-
Modified: Zope3/trunk/releases/Zope-win/Zope-win-fixup.py
===================================================================
--- Zope3/trunk/releases/Zope-win/Zope-win-fixup.py	2005-10-14 14:47:53 UTC (rev 39449)
+++ Zope3/trunk/releases/Zope-win/Zope-win-fixup.py	2005-10-14 16:15:26 UTC (rev 39450)
@@ -11,11 +11,23 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""Complete a windows release
+"""distutils --install-script for the Windows installer.
 
-This script does post processing of a windows release
-(and preprocessing of an ununstall of a windows release).
+The path to this script is passed at build-the-Windows-installer time to
+setup.py as the value of the --install-script option.  The installer created
+by distutils then runs this script after installation, and before
+uninstallation.
 
+At present, it does this:
+
+Install:
+
+  - creates mkzopeinstance.bat in Python's Scripts directory
+
+Uninstall:
+
+  - does nothing
+
 $Id$
 """
 
@@ -34,7 +46,7 @@
 
     scripts = os.path.split(argv[0])[0]
     install = os.path.split(scripts)[0]
-    
+
     f = open(os.path.join(scripts, 'mkzopeinstance.bat'), 'w')
     f.write(mkzopeinstance_bat % (install, scripts))