Provide simple build instructions for developers who check out the
[mirror/winof/.git] / docs / build.txt
1 To build the WinOF tree, you need to have the following installed:\r
2 \r
3 WDK version 6001.18001\r
4 Windows Platform SDK (multiple versions work)\r
5 \r
6 The WinOF tree (kernel drivers and userspace libraries) is built from the WDK\r
7 build environment.  You need to set the following environment variables:\r
8 \r
9 OPENIB_REV              (example set OPENIB_REV=0)\r
10 PLATFORM_SDK_PATH       (example set PLATFORM_SDK_PATH=c:\progra~1\mi2578~1)\r
11 \r
12 The OPENIB_REV variable can be set to the SVN revision number of the code.\r
13 \r
14 The PLATFORM_SDK_PATH variable must reference the SDK path, using 8.3 notation\r
15 (no spaces).  You can use 'dir /x' to obtain the correct 8.3 notation for a\r
16 given directory.\r
17 \r
18 Environment variables may be set by using the 'set' command in a command prompt\r
19 window.  Or by selecting Control Panel -> Performance and Maintenance -> System ->\r
20 Advanced -> Environment Variables.\r
21 \r
22 To build the code, cd into the trunk and type 'build -wg'.  See 'build -?' for\r
23 additional build options.\r
24 \r
25 A build batch file is also available in etc\bldwo.bat that allows building\r
26 for any OS / processor architecture from within a single command window.  Run\r
27 'bldwo' without any arguments for more details.\r