[WinOF] updated to discuss WDK build and WinOF/makebin/buildrelease structures

git-svn-id: svn://openib.tc.cornell.edu/gen1@1402 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86

diff --git a/branches/WinOF/WIX/README.txt b/branches/WinOF/WIX/README.txt
index bb76b554ef6957561926cdc784d0e03838813fe9..6deadcda22d9254bc8ee91101d828f9169e6e85a 100644 (file)
--- a/branches/WinOF/WIX/README.txt
+++ b/branches/WinOF/WIX/README.txt
@@ -1,12 +1,5 @@
 [5-28-08]\r
 \r
-WinOF Revisions:\r
-  1.0  based on svn.614\r
-  1.0.1        svn.864\r
-  1.1  svn.1177\r
-  2.0  svn.xxxx\r
-\r
-\r
 How to generate a Windows OpenFabrics Release (WinOF) using the WIX 2.0 open\r
 source installer tool set ( http://sourceforge.net/projects/wix/ ).\r
 \r
@@ -17,22 +10,32 @@ WIX References:
        WIX Introduction http://wix.sourceforge.net/manual-wix2/wix_index.htm   \r
 \r
 \r
+WinOF Revisions:\r
+  1.0  based on svn.614\r
+  1.0.1        svn.864\r
+  1.1  svn.1177\r
+  2.0  svn.xxxx\r
+\r
+\r
+\r
 Creating a binary release tree\r
 ------------------------------\r
 \r
-As of WinFO 1.1 release [5-23-08] the build environment has been switched over to\r
+As of WinOF 2.0 release [Aug'08] the build environment has been switched over to\r
 Microsoft WDK (Windows Driver Kit) version 6001.180001.\r
 \r
-See gen1\trunk\BuildRelease.bat file to generate a Wix installer (.msi file).\r
-The OS flavor (WLH, WXP or WNET - Vista/Server 2008[LongHorn], Server 2003+XP64\r
-and XP(x86)]) bin folders will be populated with the correct folder structure such that\r
+See gen1\trunk\BuildRelease.bat file to generate a Wix installer (.msi file) containing\r
+signed driver files.\r
+The OS flavor WLH\ - Vista/Server 2008[LongHorn], WNET\ - Server 2003+XP64\r
+and XP\ (x86 only) bin folders will be populated with the correct folder structure such that\r
 a WIX installer (.msi) files can be generated; either cd into OS\arch dir and\r
-run nmake or use BuildRelease.bat from trunk\ folder.\r
+run buildmsi.bat or use BuildRelease.bat from trunk\ folder.\r
 \r
-Warning - buildrelease.bat is not generic, some asembly required.\r
-BuildRelease.bat will by default deposit 7 .msi files in\r
-'%SystemRoot%\temp\WinOF_OS_xxx.msi'; OS flavor_arch is the convention.\r
+Warning - buildrelease.bat is not generic, some asembly required as the folder\r
+structure is assumed.\r
 \r
+BuildRelease.bat will by default deposit 7 .msi files in\r
+'%SystemRoot%\temp\WinOF_OS_arch.msi'.\r
 \r
 \r
 The other approach to creating a binary release tree is to generate the\r
@@ -45,10 +48,22 @@ contents of WIX\bin\ yourself from a WDK/SDK build window which can run
 \r
   2) cd trunk\etc; execute 'makebin src-dir dest-dir OS-flavor' for each OS flavor:\r
      wnet, wlh and wxp.\r
-     Say your svn repository is at C:\open-ib\, then to generate a binary\r
-     release from a command window:\r
-        makebin C:\open-ib\gen1\trunk C:\open-ib\gen1\branches\WinOF\Wix\bin\r
-\r
+     Say your svn repository is at C:\open-ib\, then to populate the WIX bin\r
+     folder for Server 2008 binaries from a command window:\r
+        makebin C:\open-ib\gen1\trunk C:\open-ib\gen1\branches\WinOF\Wix\WLH\bin WLH\r
+\r
+With the arrival of Windows Server 2008 & Vista (WLH - Windows LongHorn) driver signing\r
+is a requirement. The WIX\sign-all-drivers.bat script will create a .cat file for each\r
+driver .inf located. The generation of the .cat file is driven from the corresponding\r
+.cdf file (.inf + .cdf + all files listed in .cdf + inf2cat.exe & signtool.exe result\r
+in a .cat file).\r
+\r
+A SW publisher's digital-ID certificate is required in order for WinOF installers to\r
+be created. A test certificate can be generated for local use, requires overhead during\r
+installation (reboot & local certificate store updates). The MS prescribed procedure is\r
+to obtain a SW publisher's certificate from VeriSign or other agency; if your company\r
+is producing SW drivers for SVR2008, then you will likely have access to a cert file.\r
+The OFA will be purchasing a certificate for WinOF publication.\r
 \r
 Creating a WIX tool set\r
 -------------------------\r
@@ -87,13 +102,28 @@ Update the trunk\doc\Manual.htm file for new features.
 BUILDING a .msi installer image file\r
 ------------------------------------\r
 \r
+Easy way:\r
+ place certificate file in WIX\ folder.\r
+ cd trunk\\r
+ From a standard DOS cmd window, not a WDK cmd window, say \r
+   buildrelease clean\r
+   buildrelease all            # .msi file created in %windir%\temp\*.msi\r
+\r
+   buildrelease makebin - assumes trunk\bin\* built, populates WIX\{wlh,wnet,wxp}\bin folders.\r
+   buildrelease msi - signs & creates installers assuming makebin has been run.\r
+   buildrelease wix - just creates .msi installers - assumes all bin\ folders populated.\r
+\r
+CPU specific builds\r
+\r
 CD to the WIX OS-flavor and architecture specific directory.  'nmake.exe' needs to be\r
 in your command window search path. Build three arch specific installers\r
 (.msi files) for WLH and WNET; WXP is x86 only. \r
-WARNING - assupmtion is .\bin is populated correctly from makebin.bat or BuildRelease.bat.\r
+\r
+WARNING:\r
+   assupmtion: .\bin is populated correctly from makebin.bat or BuildRelease.bat makebin.\r
 \r
 cd gen1\branches\WinOF\WIX\wlh\x86 & nmake\r
-       Results in a WOF_wlh_x86.msi installer image.\r
+       Results in a .\WOF_wlh_x86.msi installer image.\r
 \r
 cd gen1\branches\WinOF\WIX\wlh\x64 & nmake\r
        Results in a WOF_wlh_x64.msi installer image.\r
@@ -108,6 +138,8 @@ Create a log file for a given installation:
 \r
   msiexec /I "WOF_x86.msi" /Lv \temp\msi.log\r
 \r
+  Also see %windir%\inf\setupapi.dev.log on Svr08 & Vista for driver load logging.\r
+\r
 Command line way to set an interface's IP address, netmask, no gateway:\r
 \r
   netsh interface ip set address "Local Area Connection 3" static 10.10.4.200 255.255.255.0\r