From 5162bcb1bf8a79d9957e84816e7454b3f0f6dc23 Mon Sep 17 00:00:00 2001
From: stansmith <stansmith@ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86>
Date: Tue, 7 Aug 2007 16:00:59 +0000
Subject: [PATCH] [WinOF] document how to invoke makebin to create a binary
 release suitable for WIX to build an installer.

git-svn-id: svn://openib.tc.cornell.edu/gen1@753 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86
---
 branches/WinOF/WIX/README.txt | 69 +++++++++++++++++++++++++----------
 1 file changed, 50 insertions(+), 19 deletions(-)

diff --git a/branches/WinOF/WIX/README.txt b/branches/WinOF/WIX/README.txt
index 1f957508..00a645c7 100644
--- a/branches/WinOF/WIX/README.txt
+++ b/branches/WinOF/WIX/README.txt
@@ -1,7 +1,7 @@
-[6-15-07]
+[8-06-07]
 
-How to generate a Windows OpenFabrics Release (WinOF) using the WIX 2.0 open source installer
-tool set ( http://sourceforge.net/projects/wix/ ).
+How to generate a Windows OpenFabrics Release (WinOF) using the WIX 2.0 open
+source installer tool set ( http://sourceforge.net/projects/wix/ ).
 
 WIX References:
 	WIX collection http://www.dalun.com/wix/default.htm
@@ -9,14 +9,18 @@ WIX References:
 	WIX sourceforge project http://sourceforge.net/projects/wix/
 	WIX Introduction http://wix.sourceforge.net/manual-wix2/wix_index.htm	
 
-Download the latest openib-windows binary release to 'bin\';
-(svn.614 was used for winOF 1.0).
 
-The .zip archives reduce the download/copy overhead.
+Creating a binary release tree
+------------------------------
+
+Download the latest openib-windows binary release from 
+http://openib.tc.cornell.edu/downloads/binaries/ to 'branches\WinOF\Wix\bin\'
+(svn.614 was used for winOF 1.0).
+The downloaded .zip archives reduce the download/copy overhead.
 
-The resulting bin\ folder structure must be structured like the following:
+The resulting WIX\bin\ folder must be structured like the following:
 
-  bin\
+  WIX\bin\
      DAPL\
 	  amd64\
 	  x86\
@@ -44,15 +48,36 @@ The resulting bin\ folder structure must be structured like the following:
 	    debug\
 	    release\
 
-Down load the WIX v2 (stable) tool set (http://sourceforge.net/projects/wix/) to ‘WIX_tools’.
-Unzip the archive to a folder within WIX_tools\ which represents the version of the tool set.
+
+The other approach to creating a binary release tree is to generate the
+contents of WIX\bin\ yourself from a DDK/SDK build window which can run
+'nmake'.
+
+  1) Generate binaries for each supported architecture: x86, x64 and ia64.
+     cd to trunk; build -wcf from a DDK command window for the respective arch.
+
+  2) cd trunk\etc; execute 'makebin src-dir dest-dir'
+     Say your svn repository is at C:\open-ib\, then to generate a binary
+     release from a command window:
+        makebin C:\open-ib\gen1\trunk C:\open-ib\gen1\branches\WinOF\Wix\bin
+     Answer 'F' to the few xcopy prompts.
+
+
+Creating a WIX tool set
+-------------------------
+
+Download the WIX v2 (stable) tool set (http://sourceforge.net/projects/wix/)
+to ‘WIX_tools\’.
+Unzip the archive to a folder within 'WIX_tools\' as this represents the
+version of the tool set.
 Something like unzip wix-2.0.5325.0-binaries.zip into wix-2.0.5325.0-binaries\.
 You would now have the following structure:
 	WIX\WIX_tools\wix-2.0.5325.0-binaries\{candle.exe, light.exe,...}
 
 
-RELEASE UPDATES:
-----------------
+
+Updating Relase Files
+---------------------
 
 Update Release_notes.htm file.
 
@@ -62,19 +87,25 @@ Update Release_notes.htm file.
 
 	Know issues
 
-Update the Manual.htm file for new features, etc.
+Update the trunk\doc\Manual.htm file for new features.
 
 
-BUILDING a .msi installer image
--------------------------------
+BUILDING a .msi installer image file
+------------------------------------
 
-CD to an architecture specific directory.
-'nmake.exe' needs to be in your command window search path.
+CD to the WIX architecture specific directory.  'nmake.exe' needs to be
+in your command window search path. Build three arch specific installers
+(.msi files).
 
-x86> nmake
- 
+gen1\branches\WinOF\WIX\x86> nmake
 	Results in a WOF_x86.msi installer image.
 
+gen1\branches\WinOF\WIX\x64> nmake
+	Results in a WOF_x64.msi installer image.
+
+gen1\branches\WinOF\WIX\ia64> nmake
+	Results in a WOF_ia64.msi installer image.
+
 
 DEBUG
 -----
-- 
2.41.0