[Zope-Checkins] SVN: Zope/branches/Zope-2_8-branch/inst/WinBuilders/README.txt Clarify, correct, expand.

[Tim Peters]

Log message for revision 30784:
  Clarify, correct, expand.
  

Changed:
  U   Zope/branches/Zope-2_8-branch/inst/WinBuilders/README.txt

-=-
Modified: Zope/branches/Zope-2_8-branch/inst/WinBuilders/README.txt
===================================================================
--- Zope/branches/Zope-2_8-branch/inst/WinBuilders/README.txt	2005-06-13 13:04:33 UTC (rev 30783)
+++ Zope/branches/Zope-2_8-branch/inst/WinBuilders/README.txt	2005-06-13 15:12:32 UTC (rev 30784)
@@ -1,9 +1,9 @@
 Quick instructions:
 
-The installers have only been tested under Windows 2K, but should work
-without incident on XP.  It "almost works" on Win98SE (see bottom of
-file for discussion).
+The buildout has been tested under Windows 2K and XP Pro SP2.  It "almost
+works" on Win98SE (see bottom of file for discussion).
 
+
 Setup Environment
 ------------------
 
@@ -17,68 +17,110 @@
 or later should be fine.  Inno 5.x versions do *not* work (it appears the
 Inno "custom dialog" mechanism has changed in an incompatible way)
 
-From the parent directory of the package, make a "tmp" directory.  Place
-the necessary pre-requisites in this directory.  At the time of this writing,
-this includes:
+'svn switch' to, or check out, the Zope tag for which an installer is to be
+built.  You want a native Windows checkout here, so that the text files have
+Windows-appropriate line ends.
 
+Within a Zope checkout, parent directory of this package is inst.  Make a
+"tmp" directory, inst/tmp.  Place the necessary pre-requisites in the tmp
+directory.  At the time of this writing, this includes:
+
   - Python-2.3.5.tgz
   - Python-2.3.5.exe (used for binary modules)
   - pywin32-204.win32-py2.3.exe (extracts binaries and sources)
   - Zope.tgz
 
-As time marches on, these version numbers will obviously change.  See
-mk/python.mk for the exact versions required.
+As time marches on, these version numbers will obviously change.  See/edit
+mk/python.mk and mk/zope.mk for the exact versions required.
 
+
 Building
 --------
-Launch a Cygwin bash shell, and from the parent directory, type:
-  WinBuilders/buildout <type>
-where type is one of "python", "zope", or "zeo".  Alternatively, you can
+
+Launch a Cygwin bash shell, and from the parent directory (inst/) type:
+
+    WinBuilders/buildout <type>
+
+where type is one of "zope", "python", or "zeo".  Alternatively, you can
 avoid the bash shell completely, and from a Windows command prompt type:
-  bash WinBuilders/buildout <type>
 
+    bash WinBuilders/buildout <type>
+
 Everything should work!
-  * For python, the buildout populates the "build" directory with a Python
-    laid out for Zope and/or ZEO.
 
   * For 'zope', the buildout populates the "build" directory with a Windows
-    executable installer (read the Makefile.zope for special instructions).
+    executable installer.
 
+  * For python, the buildout populates the "build" directory with a Python
+    laid out for Zope and/or ZEO.  [Tim isn't sure this target has ever
+    been tested/used.]
+
   * For 'zeo', the buildout populates the "build" directory with a Windows
-   executable installer (read the Makefile.zeo for special instructions).
+    executable installer.   [Tim isn't sure this target has ever been
+    tested/used.]
 
+An 'inst\src' directory is also created.  The makefiles don't even pretend to
+do a good job of keeping track of dependencies; best practice is to blow away
+the 'build' and 'src' directories between runs.  Note that the 'tmp'
+directory should _not_ be deleted -- it's purely an input to this process.
+
 If the build fails:
 
 If the Windows drive you are working on is not C: (or Inno isn't installed
 there!), try executing the following:
-  WinBuilders/buildout <type> CYGROOT=/cygdrive/{your_drive_letter}
 
+    WinBuilders/buildout <type> CYGROOT=/cygdrive/{your_drive_letter}
+
 If you see errors relating to MSVC not being installed, or the build process
 failing to find MSVC, it may be necessary to bring up the MSVC gui
-at least once (MSDev doesn't finish writing
-all the registry keys it should until the GUI is first launched).  If may
-also be necessary to run VCVARS.bat to set up the VC++ environment (but
-generally is not.)  See below for Win98SE.
+at least once (MSDev doesn't finish writing all the registry keys it should
+until the GUI is first launched).  If may also be necessary to run VCVARS.bat
+to set up the VC++ environment (but generally is not.)  See below for Win98SE.
 
 If you see any make errors with references to any of the files required
 in tmp/ (see 'Setup Environment' above), it's because a later version is
 now required, or the files you've downloaded are not in 'tmp'.
 
+
+Testing Zope
+------------
+
+The test suite can be run from inst\build\:
+
+- Open a native (not Cygwin) DOS box.  We want to test with the Python the
+  Zope installer includes.
+- cd to inst\build
+- Copy log.ini from the root of the Zope checkout.  This isn't necessary for
+  the tests to pass, but if you don't do it a great many spurious log
+  messages will be displayed on the console, some of which "look like"
+  errors (some of the tests deliberately provoke errors).
+- Enter
+
+      bin\python bin\test.py -v --all
+
+  or whatever variation you like best.  All tests should pass.
+
+Also run the Windows installer, and play with the Zope it installs.
+
+
 All platform notes
 ------------------
+
 - Depending on your MSVC installation options, you have to run vcvars32.bat
   to set up envars for MSVC.  Running that from a bash shell doesn't have any
   effect on the Cygwin PATH. This works:
 
-+ Open a native DOS box.
-+ Run vcvars32.bat.
-+ Start a bash shell from the same box (== run cygwin.bat, found in the
-  root of your Cygwin installation -- the same thing the Cygwin shell
-  desktop shortcut resolves to, so you can get the exact path by looking
-  at the icon's Properties).
+  + Open a native DOS box.
+  + Run vcvars32.bat.
+  + Start a bash shell from the same box (== run cygwin.bat, found in the
+    root of your Cygwin installation -- the same thing the Cygwin shell
+    desktop shortcut resolves to, so you can get the exact path by looking
+    at the icon's Properties).
 
+
 Win98SE notes
 -------------
+
 - Every time a makefile runs xcopy, there's a segfault in kernel32.dll,
   which hangs the bash shell with an endless succession of error boxes.
   The only way I found to break out of this was to bring up the debugger,