Fix the Saxon8 instructions.
[people/mcb30/edk2.git] / www / installation.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
2 <html xmlns="http://www.w3.org/1999/xhtml">\r
3 <head>\r
4   <meta content="text/html; charset=ISO-8859-1"\r
5  http-equiv="content-type">\r
6   <title>EDK 2.0 Installation Guide</title>\r
7 </head>\r
8 <body>\r
9 <h3>Getting and installing the required tools for building the EDK2<br>\r
10 </h3>\r
11 <h3>Table of Contents</h3>\r
12 <ul>\r
13   <li><a href="#Requirements">Requirements</a></li>\r
14 </ul>\r
15 <h3><a name="Requirements"></a>Requirements</h3>\r
16 <p>\r
17 The following are required to be able to build the EDK:\r
18 </p>\r
19 <div id="requirements">\r
20 <table style="width: 741px; height: 216px;" id="requirements_table"\r
21  border="1" cellpadding="0" cellspacing="0">\r
22   <tbody>\r
23     <tr class="header">\r
24       <th\r
25  style="border-color: black; background-color: grey; color: white;">Name</th>\r
26       <th\r
27  style="border-color: black; background-color: grey; color: white;">Version</th>\r
28       <th\r
29  style="border-color: black; background-color: grey; color: white;">URL</th>\r
30     </tr>\r
31     <tr>\r
32       <td\r
33  style="vertical-align: top; text-align: center; font-weight: bold;">TortoiseSVN<br>\r
34       </td>\r
35       <td\r
36  style="vertical-align: top; text-align: center; font-weight: bold;">1.3.3<br>\r
37       </td>\r
38       <td style="vertical-align: top; text-align: center;"><a\r
39  href="http://prdownloads.sourceforge.net/tortoisesvn/TortoiseSVN-1.3.3.6219-svn-1.3.1.msi?download">http://prdownloads.sourceforge.net/tortoisesvn/</a><br>\r
40       <a\r
41  href="http://prdownloads.sourceforge.net/tortoisesvn/TortoiseSVN-1.3.3.6219-svn-1.3.1.msi?download">TortoiseSVN-1.3.3.6219-svn-1.3.1.msi?download</a><br>\r
42       </td>\r
43     </tr>\r
44     <tr>\r
45       <td style="text-align: center; font-weight: bold;">Ant</td>\r
46       <td style="text-align: center; font-weight: bold;">1.6.5</td>\r
47       <td style="text-align: center;"><a\r
48  href="http://ant.apache.org/bindownload.cgi">http://ant.apache.org/bindownload.cgi</a></td>\r
49     </tr>\r
50     <tr>\r
51       <td style="text-align: center; font-weight: bold;">Ant\r
52 Contrib</td>\r
53       <td style="text-align: center; font-weight: bold;">1.0b2</td>\r
54       <td style="text-align: center;"><a\r
55  href="http://sourceforge.net/project/showfiles.php?group_id=36177">http://sourceforge.net/project/showfiles.php?group_id=36177</a></td>\r
56     </tr>\r
57     <tr>\r
58       <td style="text-align: center; font-weight: bold;">Java\r
59 JDK</td>\r
60       <td style="text-align: center; font-weight: bold;">1.5.x</td>\r
61       <td style="text-align: center;"><a\r
62  href="http://java.sun.com/j2se/1.5.0/download.jsp">http://java.sun.com/j2se/1.5.0/download.jsp</a></td>\r
63     </tr>\r
64     <tr>\r
65       <td style="text-align: center; font-weight: bold;">Saxon-B</td>\r
66       <td style="text-align: center; font-weight: bold;">8.1.1 for Java<br>\r
67       </td>\r
68       <td style="text-align: center;"><a\r
69  href="http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip">http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip<br>\r
70       </a></td>\r
71     </tr>\r
72     <tr>\r
73       <td style="text-align: center; font-weight: bold;">XMLBeans</td>\r
74       <td style="text-align: center; font-weight: bold;">2.1.0</td>\r
75       <td style="text-align: center;"><a\r
76  href="http://xmlbeans.apache.org/sourceAndBinaries/index.html">http://xmlbeans.apache.org/sourceAndBinaries/index.html</a></td>\r
77     </tr>\r
78   </tbody>\r
79 </table>\r
80 <br>\r
81 <p>The following tools are optional:<br>\r
82 </p>\r
83 <div id="requirements">\r
84 <table style="width: 745px; height: 46px;" id="requirements_table"\r
85  border="1" cellpadding="0" cellspacing="0">\r
86   <tbody>\r
87     <tr class="header">\r
88       <th\r
89  style="border-color: black; background-color: grey; color: white;">Name</th>\r
90       <th\r
91  style="border-color: black; background-color: grey; color: white;">Version</th>\r
92       <th\r
93  style="border-color: black; background-color: grey; color: white;">URL</th>\r
94     </tr>\r
95     <tr>\r
96       <td\r
97  style="vertical-align: top; font-weight: bold; text-align: center;">Cygwin<br>\r
98       </td>\r
99       <td\r
100  style="vertical-align: top; font-weight: bold; text-align: center;">Current<br>\r
101       </td>\r
102       <td style="vertical-align: top; text-align: center;"><a\r
103  href="http://www.cygwin.com">http://www.cygwin.com</a><br>\r
104       </td>\r
105     </tr>\r
106     <tr>\r
107       <td\r
108  style="vertical-align: top; text-align: center; font-weight: bold;">Intel\r
109 C++ Compiler for Windows<br>\r
110       </td>\r
111       <td\r
112  style="vertical-align: top; text-align: center; font-weight: bold;">9.0\r
113       <br>\r
114       </td>\r
115       <td style="vertical-align: top; text-align: center;"><a\r
116  href="http://www.intel.com">http://www.intel.com</a><br>\r
117       </td>\r
118     </tr>\r
119     <tr>\r
120       <td\r
121  style="vertical-align: top; text-align: center; font-weight: bold;">Intel\r
122 C Compiler for EFI Byte Code<br>\r
123       </td>\r
124       <td\r
125  style="vertical-align: top; text-align: center; font-weight: bold;">1.2<br>\r
126       </td>\r
127       <td style="vertical-align: top; text-align: center;"><a\r
128  href="http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm">http://www.intel.com/cd/software/products</a><br>\r
129       <a\r
130  href="http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm">/asmo-na/eng/compilers/efibc/index.htm</a><br>\r
131       </td>\r
132     </tr>\r
133     <tr>\r
134       <td\r
135  style="vertical-align: top; text-align: center; font-weight: bold;">Microsoft\r
136 Driver Development Kit<br>\r
137       </td>\r
138       <td\r
139  style="vertical-align: top; text-align: center; font-weight: bold;">3790.1830<br>\r
140       </td>\r
141       <td style="vertical-align: top; text-align: center;"><a\r
142  href="http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx">http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx</a><br>\r
143       </td>\r
144     </tr>\r
145     <tr>\r
146       <td\r
147  style="vertical-align: top; text-align: center; font-weight: bold;">Microsoft\r
148 ACPI Source Language Assembler<br>\r
149       </td>\r
150       <td\r
151  style="vertical-align: top; text-align: center; font-weight: bold;">1.0.13NT<br>\r
152       </td>\r
153       <td style="vertical-align: top; text-align: center;"><a\r
154  href="http://download.microsoft.com/download/0/e/2/0e258da3-dd7a-4d3b-9b48-8673b6b5897c/ASL.exe">http://download.microsoft.com/download/0/e/2/0e2</a><br>\r
155       <a\r
156  href="http://download.microsoft.com/download/0/e/2/0e258da3-dd7a-4d3b-9b48-8673b6b5897c/ASL.exe">58da3-dd7a-4d3b-9b48-8673b6b5897c/ASL.exe</a><br>\r
157       </td>\r
158     </tr>\r
159     <tr>\r
160       <td\r
161  style="vertical-align: top; text-align: center; font-weight: bold;">Intel\r
162 ACPI Component Architecture<br>\r
163       </td>\r
164       <td\r
165  style="vertical-align: top; text-align: center; font-weight: bold;">20060113<br>\r
166       </td>\r
167       <td style="vertical-align: top; text-align: center;"><a\r
168  href="http://www.intel.com/technology/iapc/acpi/downloads.htm">http://www.intel.com/technology/iapc/acpi/downloads.htm</a><br>\r
169       </td>\r
170     </tr>\r
171   </tbody>\r
172 </table>\r
173 <h3>Install and Configure Tools on Windows XP</h3>\r
174 <h4>Software Installation Order</h4>\r
175 After installing the compiler tools and your Subversion client, the\r
176 following required tools should be installed in this order: <br>\r
177 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8<br>\r
178 <h4>Java Development Kit</h4>\r
179 The Java Environment Variable must be set before attempting to build.<br>\r
180 e.g. For Sun JDK:<br>\r
181 <pre>set JAVA_HOME=c:\Java\jdk1.5.0_06</pre>\r
182 During installation, you should specify the install directory as\r
183 C:\Java instead of C:\Program Files (or some other drive letter.)&nbsp;\r
184 While installing to this non-standard location is not required. In use,\r
185 it seems to work more reliably.<br>\r
186 <br>\r
187 NOTE: You cannot combine the location for the JDK and the JRE, as the\r
188 JRE install removes most of the binaries and libraries installed by the\r
189 JDK install.<br>\r
190 <h4>Java Tools</h4>\r
191 The Apache-ANT requires the ANT_HOME environment variable to be set\r
192 before attempting to build:<br>\r
193 <pre>set ANT_HOME=c:\&lt;full path to where ant was installed&gt;</pre>\r
194 The ant-contrib.jar file should be <span style="font-weight: bold;">installed</span>\r
195 in the %ANT_HOME%\lib\r
196 directory.<br>\r
197 <br>\r
198 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
199 before attempting to build:<br>\r
200 <pre>set XMLBEANS_HOME=C:\&lt;full path to where xmlbeans was installed&gt;</pre>\r
201 The saxon8.jar file should be <span style="font-weight: bold;">copied </span>to\r
202 the %XMLBEANS_HOME%\lib\r
203 directory. Do not download a later version of saxon 8. You will get the\r
204 following error message if you do:<br>\r
205 <pre>build.xml:45: java.lang.RuntimeException:&nbsp; Trying XBeans path engine... Trying XQRL... Trying Saxon... FAILED on declare namespace sans='http://www.TianoCore.org/2006/Edk2.0'; $this/sans:FrameworkPlatformDescription/sans:Flash/sans:FvImages/sans:FvImage[@Type='ValidImageNames']/sans:FvImageNames</pre>\r
206 The Ant and XMLBean tools are required to be in the path.<br>\r
207 <pre>set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin<br></pre>\r
208 <h3>Cygwin</h3>\r
209 If you optionally install cygwin (for gcc support) you should install\r
210 it in "Unix" mode. The gcc tool chain will not compile in "DOS" mode.<br>\r
211 <h3>Environment Variables</h3>\r
212 You need to set WORKSPACE to the location of the edk2 directory that\r
213 you pulled from Subversion. For example<br>\r
214 <pre>set WORKSPACE=c:\workspace\edk2\</pre>\r
215 It is recommended that you wrap up all the environment variables above\r
216 into a script that you can launch each time you begin to do development\r
217 in your EDK2 workspace.<br>\r
218 <h3>The first build</h3>\r
219 Once the external tools are installed, the environment variables are\r
220 set, and you have the ant executable in your path, you can try a build.<br>\r
221 <ol>\r
222   <li>cd to %WORKSPACE%</li>\r
223   <li>run edksetup.bat (this will build several tools that are used in\r
224 edk2 development. It will fail if the external tools above are not\r
225 properly installed.)<br>\r
226   </li>\r
227   <li>cd MdePkg</li>\r
228   <li>type ant</li>\r
229 </ol>\r
230 </div>\r
231 </div>\r
232 </body>\r
233 </html>\r