Some clarifications on Rebuild and ForceRebuild options and when they need to be...
[mirror_edk2.git] / ReleaseNotes.txt
1 Intel(R) Platform Innovation Framework for EFI
2 EFI Development Kit II (EDK II)
3 Root Package 1.00
4 2006-07-18
5
6 Intel is a trademark or registered trademark of Intel Corporation or its
7 subsidiaries in the United States and other countries.
8 * Other names and brands may be claimed as the property of others.
9 Copyright (c) 2006, Intel Corporation
10
11 This document provides updates to documentation, along with a description on
12 how to install and build the EDK II.
13
14 Package Contents
15 ----------------
16 ReleaseNote.txt- These release notes for the package.
17 MdePkg - Industry-standard headers and libraries
18 Tools - Build -specific tools that are designed to help the
19 developer create and modify drivers and libraries
20 EdkModulePkg - Reference drivers
21 EdkFatBinPkg - Binary DXE drivers for the Fat 32 file system
22 EdkShellBinPkg - Binary Shell applications and commands
23 EdkNt32Pkg - NT32 Emulation platform reference
24
25 Note: MDE and MDK that appear in other documentation refer to the MdePkg and
26 Tools packages, respectively. While, these two packages are the minimum
27 requirement for developing EDK II Packageswe recommend that you download all
28 of the top-level files listed above.
29
30 The following package is available as a separate project, under a separate
31 license, on the TianoCore.org website: https://fat-driver2.tianocore.org
32
33 EdkFatPkg - A package containing source DXE drivers for the Fat 32 file
34 system
35
36 Documents have the following filenames (to download these documents, see \93Notes
37 on Documentation\94 later in these Release Notes):
38 EDK II Module Development Environment Library Specification, v0.58
39 (MDE_Library_Spec_0_58.rtf)
40 EDK II Build and Packaging Architecture Specification, v0.53
41 (Build_Packaging_Spec_0_53.rtf)
42 EDK II Platform Configuration Database Infrastructure Description, v0.54
43 (PCD_Infrastructure_0_54.rtf)
44 EDK II Module Surface Area Specification, v0.51
45 (Module_Surface_Area_0_50.rtf)
46 EDK II Module Development Environment Package Specification, v0.51
47 (MDE_Package_Spec_0_51.rtf)
48 EDK II C Coding Standards Specification v0.51
49 (C_Coding_Standards_Specification_ 0_51.rtf)
50 EDK II Subversion Setup Guide
51 (edk2-subversion-setup.rtf)
52
53 Pre-Requisites
54 --------------
55 The following list of tools must be installed on the development workstation
56 prior to using the EDK II.
57
58 Compiler Tool Chain
59 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)
60 or
61 A special GCC version 4.x or later (http://gcc.gnu.org). See below.
62
63 Assembler Tool Chain
64 Microsoft Macro Assembler, version 6.15 or later
65 or
66 GNU binutils 2.16.1 or later
67
68 Java Development Kit ( Java 5.0 or later)
69 Sun* jdk-1.5.0_06 or later (http://java.sun.com)
70 or
71 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)
72
73 Java Tools
74 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)
75 Ant-contrib, version 1.0b2 or later
76 (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)
77 Saxon8, version 8.1.1
78 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)
79 XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)
80 DO NOT download the latest XMLBeans, version 2.2.0. It is not compatible
81 with Saxon8, version 8.1.1.
82
83 Other Tools
84 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
85
86 Optional Tools
87 --------------
88 Compiler Tool Chains:
89 Intel(R) C++ Compiler for Windows*, ver. 9.0 or later (http://www.intel.com)
90 Intel(R) C Compiler for EFI Byte Code, ver. 1.2 or later
91 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)
92 Microsoft Driver Development Kit, version 3790.1830 or later
93 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)
94 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later
95 Intel ACPI Component Architecture, version 20060113
96
97 -----------------------------------------------
98 Notes on Required Tools (Source Control System)
99 -----------------------------------------------
100 The EDK II is being managed by the Subversion Source Control on Tianocore.org.
101 Subversion provides speed, security, and additional features. The
102 recommended client is TortoiseSVN version 1.3.3.
103 (Available at http://tortoisesvn.tigris.org/)
104
105 The checkout procedures on the Tianocore.org Web site include
106 instructions for the use of Subversion Source Control.
107
108 The URL of the EDK II repository is:
109 https://edk2.tianocore.org/svn/edk2/trunk/edk2
110
111
112 --------------------------------------------------------------------
113 Notes On Required Tools (With examples for Windows, OS X, and Linux*)
114 --------------------------------------------------------------------
115 Software Installation Order:
116 After installing the compiler tools and your Subversion client, install the
117 following required tools in this order:
118 1. Java JDK
119 2. Apache-Ant
120 3. ant-contrib
121 4. xmlbeans
122 5. saxon8
123
124 Java Development Kit:
125
126 The Java Environment Variable must be set before attempting to build.
127 For Sun JDK (see note below\86):
128 set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows example)
129 export JAVA_HOME=/Library/Java/Home/ (OS X example)
130 export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)
131 For Bea Systems:
132 set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04
133
134 \86 When using the Sun JDK5.0:
135 During installation, you should specify the install directory as C:\Java
136 instead of C:\Program Files\(or some other drive letter.) While installing
137 to this non-standard location is not required, in practice, it seems to work
138 more reliably.
139 For the JDK, the install path is C:\Java\jdk1.5.0_06
140 For the JRE, the install path is C:\Java\jre1.5.0_06
141 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.
142
143 NOTE: You cannot combine the location for the JDK and the JRE, because the
144 JRE install removes most of the binaries and libraries installed by the JDK
145 install.
146
147 Java Tools:
148 The Apache-ANT requires the ANT_HOME environment variable to be set before
149 attempting to build:
150 set ANT_HOME=c:\<full path to where ant was installed>
151 export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)
152
153 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib
154 directory.
155
156 XMLBeans, requires the XMLBEANS_HOME environment variable to be set
157 before attempting to build:
158 set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>
159 export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)
160
161 Copy the saxon8.jar file to the %XMLBEANS_HOME%\lib directory.
162
163 The Ant and XMLBean tools must be in the path.
164 MS system example:
165 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin
166 Linux/OS X bash shell example:
167 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin
168
169 --------------------
170 A Word on Apache-ANT
171 --------------------
172 The Apache-ANT program is a build tool that uses XML-based project files.
173 Similar to Makefiles, these project files may contain multiple targets. Most
174 build.xml files in EDK II are auto-generated; any edits performed on the
175 build.xml files will be overwritten by the next build.
176
177 Pre-defined targets in the build.xml file include:
178 all - This target builds binaries for defined architectures.
179 clean - This target removes object files generated by commands.
180 cleanall - This target removes all generated files and directories.
181
182 ----------------------------
183 A Word on the GCC Tool Chain
184 ----------------------------
185 EDK II will not compile with a standard Linux gcc tool chain. While Linux
186 distributions are usually based on ELF, EDK II requires a version of gcc
187 that is configured to produce PE-COFF images. You will find a script in
188 edk2/Tools/gcc that will download, configure, compile, and install a gcc
189 4.X cross-compile tool chain for EDK II development. This custom tool chain
190 supports the IA-32 architecture. It can be built and run on Cygwin, Linux, and
191 many other POSIX-compliant host operating environments. To compile the custom
192 gcc tool chain, you need the following tools on your host computer: bash, gcc,
193 gmake, curl (or wget).
194
195 Only the MdePkg and EdkModulePkg are currently supported by gcc builds. Other
196 builds, such as the EdkNt32Pkg, will not compile with gcc. By default, the edk2
197 will try to build the NT32.fpd, which is not supported by gcc. So, you need to
198 change the Tools/Conf/target.txt.
199
200 The platform to be built is identified by the Tools/Conf/target.txt file:
201
202 #
203 # PROPERTY Type Use Description
204 # ---------------- -------- -------- -----------------------------------------------------------
205 # ACTIVE_PLATFORM Filename Recommended Specify the WORKSPACE relative Path and Filename
206 # of the platform FPD file that will be used for the build
207 # This line is required if and only if the current working
208 # directory does not contain one or more FPD files.
209
210 ACTIVE_PLATFORM =
211
212 You can leave it black, as above, or set it to any .fpd file in the workspace.
213 If you leave it blank, then you just cd to the dir that contains the .fpd that
214 you would like to build (MdePkg/ or EdkModulePkg/) and then type build.
215
216 ----------------------------
217 A Word on compiling on Linux
218 ----------------------------
219
220 In order to compile on Linux, you will need to have the e2fsprogs-dev package
221 installed. Check your distribution for the rpm, deb or other package format.
222 This package contains the uuid library and header that are used by some of the
223 host tools.
224
225 If you are running on x86_64 Linux, then you should install a 64 bit version of
226 the Java JDK. The version that was used was jdk-1_5_0_07-linux-amd64-rpm.bin.
227 It may be downloaded from sun.com.
228
229 -----------------------------------------
230 A Word on compiling under Cygwin with gcc
231 -----------------------------------------
232
233 Cygwin is a POSIX style operating environment for Windows. It is possible to
234 compile the EDK 2 using gcc and cygwin. There are a few extra steps necessary
235 to make this happen. There is a JNI (Java Native Interface) library in the
236 Tools. In order to compile this under Cygwin, the 'linux' java headers must be
237 installed to the $JAVA_HOME dir on the windows system. To accomplish this, you
238 must install the JDK on a linux system, and then copy
239 linux:$JAVA_HOME/include/linux/ to windows:$JAVA_HOME/include. These are really
240 typedefs needed by gcc.
241
242 Compiling under cygwin is slow, because the underlying file accesses are slow
243 in cygwin. For this reason, we do not encourage the use of cygwin. A true unix
244 system will be a superior choice for those wishing to compile with gcc.
245
246 Make sure that you select the e2fsprogs development package when you install
247 cygwin. It is necessary for the GenFvImage tool.
248
249 -----------------------
250 Notes on Documentation
251 -----------------------
252 The documents are being managed by the Subversion Source Control on
253 Tianocore.org. The document repository is "docs" and must be checked out
254 separately from the EDK II source tree. Refer to the checkout procedures on
255 the Tianocore.org Web site for EDK II.
256
257 The URL of the document repository is:
258 https://edk2.tianocore.org/svn/edk2/trunk/docs
259
260
261 -------------------------------------------------------------------------------
262 Quick Start
263 -----------
264 (assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see
265 "Detailed Starting Instructions" below)
266
267 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
268 check out the entire EDK II source tree.
269
270 In a command window, change to the top-level directory of the EDK II source.
271
272 To test your tool chain setup and to build the supplied tools, execute:
273 c:\MyWork\edkii\> edksetup ForceRebuild
274
275 (The edksetup script is referred to as the setup command throughout the
276 rest of this document.)
277 NOTE: You should run the setup command at the start of every session.
278 This configures the environment to include the TianoTools and the
279 Java applications and libraries.
280
281 You will need to set the WORKSPACE environment variable, or run the edksetup
282 script (without any arguments), any time you want to build.
283
284 Set the WORKSPACE environment variable, e.g.:
285
286 c:\> set WORKSPACE=C:\MyWork\edkii
287
288 You may need to edit the text files Tools/Conf/target.txt and
289 Tools/Conf/tools_def.txt (created by edksetup) using your favorite
290 text editor to ensure that the paths to the tools you want to use
291 to build EDK II binaries are correct. These files contain the default
292 paths (as per the default installation of the tools), so a customized
293 install may require this manual process.
294
295 Once this is completed, you are ready to test the build, by executing:
296 c:\MyWork\edkii\> build
297
298 This command builds the active platform specified in text file target.txt. If
299 the active platform is not specified target.txt, you must execute the build
300 command from the sub-directory that contains FPD files. For more information
301 about the active platform policy, see the \93EDK II Build and Packaging
302 Architecture Specification.\94
303
304 -------------------------------------------------------------------------------
305 Detailed Starting Instructions
306 ------------------------------
307
308 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
309 check out the entire EDK II source tree.
310
311 In a command window, change to the top-level directory of the EDK II source.
312
313 If the active compiler tool chain is GCC, you must set the
314 environment variable, TOOL_CHAIN to "gcc" before running the
315 edksetup script. Example: export TOOL_CHAIN=gcc
316
317 To test your tool chain setup and to build the supplied tools, execute:
318 c:\MyWork\edkii\> edksetup ForceRebuild
319
320 On Linux systems, you must source the edksetup.sh file to load the correct
321 settings into your shell.
322
323 . edksetup.sh # Note the dot.
324
325 If you have recently updated your code from subversion, the tools will need to
326 be rebuilt if there were any code changes made to them. You can request that
327 the tools get rebuilt by typing:
328
329 . edksetup.sh Rebuild # Unix-like systems
330 edksetup.bat Rebuild # Windows
331
332 The edksetup script is referred to as the setup command throughout the
333 rest of this document.
334 NOTE: You should run the setup command at the start of every session.
335 This configures the environment to include the TianoTools and the
336 Java applications and libraries.
337
338 Any changes to the tool source code or XML Schema documents require that
339 you execute the following:
340 c:\MyWork\edkii\> edksetup ForceRebuild
341
342 You must set the WORKSPACE environment variable, or run the edksetup
343 script (without any arguments), any time you want to build.
344
345 Set the WORKSPACE environment variable, e.g.:
346
347 c:\> set WORKSPACE=C:\MyWork\edkii
348
349 You may need to edit the text files Tools/Conf/target.txt and
350 Tools/Conf/tools_def.txt (created by edksetup) using your favorite
351 text editor to ensure that the paths to the tools you want to use
352 to build EDK II binaries are correct. These files contain the default
353 paths (as per the default installation of the tools), so a customized
354 tool installation may require this manual process.
355
356 Once this is completed, you are ready to test the build, by executing:
357 c:\MyWork\edkii\> build
358
359 This command builds the active platform specified in text file target.txt. If
360 the active platform is not specified, go to the sub-directory that contains FPD
361 files and execute the build command. For more information about the active
362 platform policy, see the \93EDK II Build and Packaging Architecture
363 Specification.\94
364
365 --------------------------
366 Individual Platform Builds
367 --------------------------
368 After running the setup command, you can build individual platforms.
369 In the command window:
370 Set the active platform in target.txt, and execute this command:
371 c:\<directory>\> build
372 or
373 cd to the platform (FPD file) that you want to build and execute this command:
374 c:\MyWork\edkii\EdkNt32Pkg\> build
375
376 Note that the active platform specified in target.txt overrides the platform
377 specified by any FPD file in the current directory. For more information
378 about active platform policy, see the \93EDK II Build and Packaging Architecture
379 Specification.\94
380
381 To run the Nt32 emulation platform under Microsoft Windows, go to
382 <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe
383
384 To exit the Nt32 emulation platform, type \93reset\94 at the EFI Shell>
385 command prompt. Alternatively, from the graphical interface, select the Boot
386 Maintenance Manager's \93Reset System\94 command.
387
388 NOTE: When creating a new platform, the Platform Name is restricted
389 to a single word containing alphanumeric characters, underscore, dash,
390 and period. The space character and other special characters are
391 not allowed.
392
393 -----------------------
394 Notes on Symbolic Debug
395 -----------------------
396 To enable EFI Symbolic Debugging, make sure the target output is set to DEBUG
397 in the text file Tools/Conf/target.txt and then modify the FPD <BuildOptions>
398 <Options><Option BuildTargets="DEBUG" ToolCode="CC"> and append the following
399 compiler options to the string:
400 "/D EFI_GENERATE_SYM_FILE", "/D EFI_SYMBOLIC_DEBUG"
401
402 (If the Option line does not contain "/D EFI_DEBUG", you must add that
403 option as well.)
404
405 ------------------------
406 Individual Module Builds
407 ------------------------
408 After running the setup command, you can build individual modules.
409 In the command window, cd to the module that you want to build, and
410 execute the build command:
411 c:\MyWork\edkii\MdePkg\Library\BaseLib\> build
412
413 You must set the active platform in target.txt for individual module builds.
414
415 -------------------------------------------------------------------------------
416
417 General Information:
418 ===============================================================
419 Mechanisms
420 ----------
421 A brief overview:
422
423 A) The Surface Area Package Description (SPD) file contains information about
424 the modules that the package contains, including the location of all MSA files,
425 and public library names and headers that might be provided by a module in the
426 package. Packages are defined by SPD files. (Found in the root of the Package
427 subdirectory (i.e. EdkNt32Pkg).) The SPD file is further explained in \93EDK II
428 Build and Packaging Architecture Specification.\94
429
430 B) Module Surface Area Definition (MSA) files. A description of a module's
431 surface area, with all module specific default flags and features specified.
432 For additional details, see the "EDK II Module Surface Area Specification" and
433 the "EDK II Build and Packaging Architecture Specification."
434
435 C) Framework Platform Description (FPD) files. A description of a platform's
436 surface are, including a list of modules that are needed by the platform. To
437 support individual module builds, developers are not required to provide
438 information about specific flash devices, nor flash device layout.
439 Specific sections in the FPD file control aspects of the build, such
440 as the Supported Architectures and Build Targets, as well as the tool flags
441 that are used to create the binary files. A valid platform file can specify
442 zero or more modules, so individual modules can be compiled within the context
443 of a platform (FPD) definition.
444
445 D) Platform Configuration Database (PCD). A platform database that contains a
446 variety of current platform settings or directives that can be accessed by a
447 driver or application. The PCD is defined by the PCD_Protocol (This is
448 further explained in the "EDK II Platform Configuration Database Infrastructure
449 Description."
450
451 E) Library Class. A library class is a logical grouping of similar functions.
452 When developing components, the module surface area declares the class of
453 libraries that can be used by the component. The MSA and SPD files can specify
454 a recommended instance of the library that a platform integrator (PI) may
455 select, however this is only a recommendation. The PI may choose to select a
456 different library instance to be used during compilation and linking. All
457 library type modules must include header files in their distribution package,
458 as well as their MSA files. Components, on the other hand, need provide only an
459 MSA file and either source or binary files when distributing packages. The
460 Library Classes are further explained in the "EDK II Build and Packaging
461 Architecture Specification."
462
463 =========================================================================
464 The common operations by developers of new modules are:
465 -----------------------------------------------
466 1) Manually creating a new module in a package:
467 - The module source code must first be created in an appropriate directory
468 (under the package the module is to be a part of.)
469 - An MSA file must be created, spelling out all aspects of the module.
470 - The MSA must be added to the SPD for the package to include the module.
471
472 -----------------------------------------------------
473 2) Adding and Removing modules to and from a package:
474
475 - Set up environment as Build
476 - Adding a module to a package:
477 - Generate the MSA file
478 - Add a new <Filename> element under <MsaFiles> into
479 <PackageDir>\<PackageName>.spd, using arelative path to the package
480 - Add a new <ModuleSA> entry under each <FrameworkModules> into the
481 <PackageDir>\<PackageName>.fpd file if necessary.
482
483 - Removing a module from a package:
484 - Comment out or remove the corresponding <Filename> element under
485 <MsaFiles> from <PackageDir>\<PackageName>.spd
486 - Comment out or remove the corresponding <ModuleSA> entry under each
487 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.
488
489 -------------------------------
490 3) Manually creating a package:
491 - Identify the modules that are to be members of the project.
492 - Identify the Variables and Guids required in and of the Package (including
493 consumption and production information).
494 - Create an SPD file defining these modules and calling out their MSA files.
495 - Add a new <Filename> element under <PackageList> into
496 Tools\Conf\FrameworkDatabase.db, using the relative path to the workspace.
497
498 -----------------------------------------
499 4) Declaring a new Protocol in a package:
500 - This release requires manual editing of the SPD file, adding the protocol
501 to the ProtocolDeclarations section of the file.
502 - Add the Protocol .h file to the Include\Protocol directory.
503 - Add an <Entry> to the <ProtocolDeclarations> element in the
504 <PackageName>.spd file
505 - Each line contains Protocol base name, followed by the global variable
506 name, and the hex value of the Protocol GUID.
507
508 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD
509 file):
510 <ProtocolDeclarations>
511 <Entry Name="Bds">
512 <C_Name>gEfiBdsArchProtocolGuid</C_Name>
513 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>
514 <HelpText/>
515 </Entry>
516 <Entry Name="Cpu">
517 <C_Name>gEfiCpuArchProtocolGuid</C_Name>
518 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>
519 <HelpText/>
520 </Entry>
521 </ProtocolDeclarations>
522
523 ------------------------------------
524 5) Declaring a new PPI in a package:
525 - This release requires manual editing of the SPD file
526 - Add the PPI .h file to the Include\Ppi directory.
527 - Add an <Entry> to the package <PpiDeclarations> element in the
528 <PackageName>.spd file
529 - Each line contains the PPI base name, followed by the global variable
530 name and the hex value of the PPI GUID.
531
532 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
533 <PpiDeclarations>
534 <Entry Name="BootInRecoveryMode">
535 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>
536 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>
537 <HelpText/>
538 </Entry>
539 <Entry Name="CpuIo">
540 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>
541 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>
542 <HelpText/>
543 </Entry>
544 </PpiDeclarations>
545
546 -------------------------------------
547 6) Declaring a new GUID in a package:
548 - This release requires manual editing of the SPD file to include the new
549 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration
550 element, as described above.
551
552 ------------------------------------------
553 7) Declaring a new PCD entry in a package:
554 - This release requires manual editing of the SPD file to include the new
555 PCD. New Pcd entries are added to the PcdDefinitions section of the
556 <PackageName>.spd file using the following example for the format
557 (NOTE: The hex <Token> value must be unique):
558
559 <PcdDeclarations>
560 <PcdEntry ItemType="FIXED_AT_BUILD">
561 <C_Name>PcdMaximumUnicodeStringLength</C_Name>
562 <Token>0x00000001</Token>
563 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
564 <DatumType>UINT32</DatumType>
565 <ValidUsage>FIXED_AT_BUILD</ValidUsage>
566 <DefaultValue>1000000</DefaultValue>
567 <HelpText>The maximum lengh for unicode string.</HelpText>
568 </PcdEntry>
569 </PcdDeclarations>
570
571 ------------------------------
572 8) Declaring a new Library Class:
573 - This release requires manual editing of the SPD file to include the new
574 Library Class. New Library Class entries are added to the
575 LibraryClassDeclarations section of the <PackageName>.spd file using
576 the following example for the format:
577
578 <LibraryClassDeclarations>
579 <LibraryClass Name="BaseLib">
580 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
581 <HelpText/>
582 </LibraryClass>
583 <LibraryClass Name="BaseMemoryLib">
584 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>
585 <HelpText/>
586 </LibraryClass>
587 </LibraryClassDeclarations>
588
589 =======================================================
590 EDK II Changes Relative to the original EDK:
591 --------------------------------------------
592 The EDK II represents significant changes in the structure of the EDK.
593 Therefore, it is very difficult to isolate all of the changes of this version of
594 the EDK with the original EDK.
595
596 Of particular note:
597
598 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.
599 These libraries are provided to make Memory Reference Code (MRC) development
600 easier.
601 2) The MDE libraries represent significant changes in source
602 (with only limited changes in functionality.) These new libraries conform
603 to the "EDK II Module Development Environment Library Specification.\94
604 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
605 to the original EDK.
606 4) The EDK tools directory has been expanded to include more tools and more
607 tool functionality.
608 5) The EDK NT32 section has been ported to the new build process, but
609 functionally remains the same as the original EDK.
610 6) The Application "HelloWorld" has been ported to EDK II as well.
611
612 =======================================================
613 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
614 virus detected.
615