Provide simple build instructions for developers who check out the
authorshefty <shefty@ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86>
Tue, 20 May 2008 07:25:52 +0000 (07:25 +0000)
committershefty <shefty@ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86>
Tue, 20 May 2008 07:25:52 +0000 (07:25 +0000)
source tree and want to try building the drivers.  It's more intuitive
to provide build details with the source code itself, than separately
on a web site.

Signed-off-by: Sean Hefty <sean.hefty@intel.com>
git-svn-id: svn://openib.tc.cornell.edu/gen1/trunk@1189 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86

docs/build.txt [new file with mode: 0644]

diff --git a/docs/build.txt b/docs/build.txt
new file mode 100644 (file)
index 0000000..a42b6f3
--- /dev/null
@@ -0,0 +1,27 @@
+To build the WinOF tree, you need to have the following installed:\r
+\r
+WDK version 6001.18001\r
+Windows Platform SDK (multiple versions work)\r
+\r
+The WinOF tree (kernel drivers and userspace libraries) is built from the WDK\r
+build environment.  You need to set the following environment variables:\r
+\r
+OPENIB_REV             (example set OPENIB_REV=0)\r
+PLATFORM_SDK_PATH      (example set PLATFORM_SDK_PATH=c:\progra~1\mi2578~1)\r
+\r
+The OPENIB_REV variable can be set to the SVN revision number of the code.\r
+\r
+The PLATFORM_SDK_PATH variable must reference the SDK path, using 8.3 notation\r
+(no spaces).  You can use 'dir /x' to obtain the correct 8.3 notation for a\r
+given directory.\r
+\r
+Environment variables may be set by using the 'set' command in a command prompt\r
+window.  Or by selecting Control Panel -> Performance and Maintenance -> System ->\r
+Advanced -> Environment Variables.\r
+\r
+To build the code, cd into the trunk and type 'build -wg'.  See 'build -?' for\r
+additional build options.\r
+\r
+A build batch file is also available in etc\bldwo.bat that allows building\r
+for any OS / processor architecture from within a single command window.  Run\r
+'bldwo' without any arguments for more details.\r