Check In tool source code based on Build tool project revision r1655.

[mirror_edk2.git] / BaseTools / Conf / XMLSchema / WorkspaceContent.xsd

<?xml version="1.0" encoding="UTF-8"?>\r
<!--\r
    Filename: WorkspaceContent.xsd\r
    \r
    Copyright (c) 2008, Intel Corp.  All rights reserved.\r
    \r
    This program and the accompanying materials are licensed and made available \r
    under the terms and conditions of the BSD License which may be found at \r
    http://opensource.org/licenses/bsd-license.php\r
    \r
    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
    \r
-->\r
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"\r
	elementFormDefault="qualified"\r
	targetNamespace="http://edk2.TianoCore.org/2008/1.0"\r
	xmlns="http://edk2.TianoCore.org/2008/1.0">\r
	<xs:annotation>\r
		<xs:documentation xml:lang="en-us">This document covers the\r
			WorkspaceContent.xml file that tracks what has been installed into an EDK\r
			II development WORKSPACE.</xs:documentation>\r
	</xs:annotation>\r
	<xs:element name="WorkspaceContent">\r
		<xs:annotation>\r
			<xs:documentation xml:lang="en-us"> This file describes the distributions,\r
				packages, stand-alone (non-package) modules and miscellaneous files that\r
				have been installed in THIS WORKSPACE. Additionally, any tools that are\r
				installed as part of a distribution are tracked (tools are not required\r
				to be installed within a WORKSPACE.) </xs:documentation>\r
		</xs:annotation>\r
		<xs:complexType>\r
			<xs:sequence>\r
				<xs:element ref="Header" minOccurs="1" maxOccurs="1">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This section tracks required\r
							information about this WORKSPACE. </xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
				<xs:element ref="DistributionPackage" minOccurs="1"\r
					maxOccurs="unbounded">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> The list of UEFI/PI distribution\r
							packages that have been installed in this WORKSPACE.\r
						</xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
			</xs:sequence>\r
		</xs:complexType>\r
	</xs:element>\r
\r
	<xs:element name="Header">\r
		<xs:complexType>\r
			<xs:sequence>\r
				<xs:element minOccurs="0" maxOccurs="1" name="Name"\r
					type="xs:normalizedString">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This User Interface Name can be\r
							entered during initialization of a WORKSPACE to permit a developer\r
							to uniquely identify a WORKSPACE. </xs:documentation>\r
						<xs:documentation xml:lang="en-us"> This value can be used by report\r
							generators. </xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
				<xs:element minOccurs="1" maxOccurs="1" name="AbsolutePath"\r
					type="xs:anyURI">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> When the WORKSPACE is first\r
							initialized, this is the absolute path to the WORKSPACE. If the\r
							user moves or re-names the directory, the RmPkg tool will need to\r
							verify the content of this WORKSPACE before removing any content.\r
						</xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
				<xs:element minOccurs="1" maxOccurs="1" name="LastModifiedDate"\r
					type="xs:dateTime">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> The date and time of the last\r
							Package Installation or Removal. The format is:\r
							YYYY-MM-DDThh:mm:ss, for example: 2001-01-31T13:30:00 (note the T\r
							character separator between the calendar date and the time.\r
						</xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
				<xs:element minOccurs="1" maxOccurs="1"\r
					name="WorkspaceContentSpecification" default="1.0" type="xs:decimal"\r
				 />\r
			</xs:sequence>\r
		</xs:complexType>\r
	</xs:element>\r
\r
\r
\r
	<xs:element name="ModuleList">\r
		<xs:complexType>\r
			<xs:sequence>\r
				<xs:element minOccurs="1" maxOccurs="unbounded" name="Module">\r
					<xs:complexType>\r
						<xs:sequence>\r
							<xs:element name="Name" minOccurs="1" maxOccurs="1">\r
								<xs:annotation>\r
									<xs:documentation xml:lang="en-us"> The User Interface Name of\r
										the module. </xs:documentation>\r
								</xs:annotation>\r
								<xs:complexType>\r
									<xs:simpleContent>\r
										<xs:extension base="xs:normalizedString">\r
											<xs:attribute name="BaseName" type="xs:NCName"\r
												use="required">\r
												<xs:annotation>\r
													<xs:documentation xml:lang="en-us"> The BaseName is\r
														used to create files and folders during a build, and\r
														is used by packaging tools as a keyword to create\r
														the INF file. </xs:documentation>\r
												</xs:annotation>\r
											</xs:attribute>\r
										</xs:extension>\r
									</xs:simpleContent>\r
								</xs:complexType>\r
							</xs:element>\r
							<xs:element ref="GUID" minOccurs="1" maxOccurs="1">\r
								<xs:annotation>\r
									<xs:documentation xml:lang="en-us"> This is the GUID of the\r
										module. Backward compatible versions of a module can use the\r
										same GUID, however the version attribute must be changed\r
										(incrementally.) Non-backward compatible versions of a\r
										module must also provide a new GUID, while resetting the\r
										version attribute is optional. </xs:documentation>\r
								</xs:annotation>\r
							</xs:element>\r
							<xs:element name="InstalledFolder" minOccurs="1" maxOccurs="1"\r
								type="xs:anyURI">\r
								<xs:annotation>\r
									<xs:documentation xml:lang="en-us"> This is the WORKSPACE\r
										relative path that the Module was installed in.\r
									</xs:documentation>\r
								</xs:annotation>\r
							</xs:element>\r
							<xs:element name="InfFilename" minOccurs="1" maxOccurs="1"\r
								type="xs:anyURI">\r
								<xs:annotation>\r
									<xs:documentation xml:lang="en-us"> This is filename of the\r
										INF file created in the InstalledFolder (listed above)\r
										during installation. </xs:documentation>\r
								</xs:annotation>\r
							</xs:element>\r
						</xs:sequence>\r
					</xs:complexType>\r
				</xs:element>\r
			</xs:sequence>\r
		</xs:complexType>\r
	</xs:element>\r
\r
	<xs:element name="DistributionPackage">\r
		<xs:complexType>\r
			<xs:sequence>\r
				<xs:element minOccurs="1" maxOccurs="1" name="Name">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> The User Interface Name of the\r
							distribution. </xs:documentation>\r
					</xs:annotation>\r
					<xs:complexType>\r
						<xs:simpleContent>\r
							<xs:extension base="xs:normalizedString">\r
								<xs:attribute name="BaseName" type="xs:NCName" use="required">\r
									<xs:annotation>\r
										<xs:documentation xml:lang="en-us"> This is the actual\r
											BaseName used during the installation. Since users may\r
											change the Distribution Package's default BaseName (used\r
											to create the PKG and MANIFEST files) this is the real\r
											name used to create the files. </xs:documentation>\r
									</xs:annotation>\r
								</xs:attribute>\r
							</xs:extension>\r
						</xs:simpleContent>\r
					</xs:complexType>\r
				</xs:element>\r
				<xs:element ref="GUID" minOccurs="1" maxOccurs="1">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This is the GUID of the\r
							distribution, backward compatible versions of a distribution can\r
							use the same GUID, however the version attribute must be changed\r
							(incrementally.) Non-backward compatible versions of a\r
							distribution must also provide a new GUID, while resetting the\r
							version attribute is optional. </xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
				<xs:element minOccurs="1" maxOccurs="1" name="PkgFilename"\r
					type="xs:anyURI">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This is the filename of the XML\r
							distribution package surface area (PKG) file that was stored in\r
							the Conf/Pkgs folder of the WORKSPACE for this distribution\r
							package. </xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
				<xs:element minOccurs="1" maxOccurs="1" name="ManifestFilename"\r
					type="xs:anyURI">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This is the filename of the\r
							distribution package manifest (.manifest) file that was created\r
							and stored in the Conf/Pkgs folder of the WORKSPACE for this\r
							distribution package. The InstallPkg tool must create this file\r
							using the extracted locations of the content zip file (or,\r
							alternatively, the user can create the file by redirecting the\r
							output of the zip -Tv Contents.zip.) </xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
				<xs:element minOccurs="1" maxOccurs="1" name="InstalledDate"\r
					type="xs:dateTime" />\r
				<xs:element name="DistributionProperties" minOccurs="0" maxOccurs="1"\r
					nillable="true">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This section tracks information\r
							and content that is not associated with either packages or\r
							modules, or is not required for building packages or modules.\r
						</xs:documentation>\r
					</xs:annotation>\r
					<xs:complexType>\r
						<xs:attribute name="ReadOnly" type="xs:boolean" default="false"\r
							use="optional">\r
							<xs:annotation>\r
								<xs:documentation xml:lang="en-us">If set to true, all content\r
									within this distribution package should NOT be\r
								modified.</xs:documentation>\r
							</xs:annotation>\r
						</xs:attribute>\r
						<xs:attribute name="RePackage" type="xs:boolean" default="false"\r
							use="optional">\r
							<xs:annotation>\r
								<xs:documentation xml:lang="en-us">If set to true, then the\r
									content can be repackaged into another distribution\r
								package.</xs:documentation>\r
							</xs:annotation>\r
						</xs:attribute>\r
						<xs:attribute name="ModifiedToolsDef" type="xs:boolean"\r
							default="false" use="optional">\r
							<xs:annotation>\r
								<xs:documentation xml:lang="en-us">If set to true, then either\r
									the distribution or one of its packages has a user extensions\r
									section that modified the tools_def.txt file.\r
								</xs:documentation>\r
							</xs:annotation>\r
						</xs:attribute>\r
						<xs:attribute name="ProvidesTools" type="xs:boolean" default="false"\r
							use="optional">\r
							<xs:annotation>\r
								<xs:documentation xml:lang="en-us"> This is used to identify a\r
									distribution that provides tools that may or may not be\r
									installed in a WORKSPACE. </xs:documentation>\r
							</xs:annotation>\r
						</xs:attribute>\r
						<xs:attribute name="ProvidesMiscellaneousFiles" type="xs:boolean"\r
							default="false" use="optional">\r
							<xs:annotation>\r
								<xs:documentation xml:lang="en-us"> This is used to identify a\r
									distribution that provides miscellaneous files that must be\r
									installed in a WORKSPACE. </xs:documentation>\r
							</xs:annotation>\r
						</xs:attribute>\r
						<xs:attribute name="UnknownUserExtensions" type="xs:boolean"\r
							default="false" use="optional">\r
							<xs:annotation>\r
								<xs:documentation xml:lang="en-us"> This is used to identify a\r
									distribution that has a UserExtensions section at the\r
									Distribution, Package or Module level that uses an Identifier\r
									other than BuildOptions, ToolsDef or DistributionPackage.\r
								</xs:documentation>\r
							</xs:annotation>\r
						</xs:attribute>\r
					</xs:complexType>\r
				</xs:element>\r
				<xs:element name="PackageList" minOccurs="0" maxOccurs="1">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This section tracks individual\r
							packages (collections of related items.) Each package listed in\r
							this section must have a DEC file associated with it.\r
						</xs:documentation>\r
					</xs:annotation>\r
					<xs:complexType>\r
						<xs:sequence>\r
							<xs:element name="Package" minOccurs="1" maxOccurs="unbounded">\r
								<xs:complexType>\r
									<xs:sequence>\r
										<xs:element name="Name" minOccurs="1" maxOccurs="1">\r
											<xs:annotation>\r
												<xs:documentation xml:lang="en-us"> The User Interface\r
													Name of the package. </xs:documentation>\r
											</xs:annotation>\r
											<xs:complexType>\r
												<xs:simpleContent>\r
													<xs:extension base="xs:normalizedString">\r
														<xs:attribute name="BaseName" type="xs:NCName"\r
															use="required">\r
															<xs:annotation>\r
																<xs:documentation xml:lang="en-us"> The BaseName\r
																	is used to create files and folders during a\r
																	build, and is used by packaging tools as a\r
																	keyword to create the DEC file.\r
																</xs:documentation>\r
															</xs:annotation>\r
														</xs:attribute>\r
													</xs:extension>\r
												</xs:simpleContent>\r
											</xs:complexType>\r
										</xs:element>\r
										<xs:element ref="GUID" minOccurs="1" maxOccurs="1">\r
											<xs:annotation>\r
												<xs:documentation xml:lang="en-us"> This is the GUID of\r
													the package, backward compatible versions of a package\r
													can use the same GUID, however the version attribute\r
													must be changed (incrementally.) Non-backward\r
													compatible versions of a package must also provide a\r
													new GUID, while resetting the version attribute is\r
													optional. </xs:documentation>\r
											</xs:annotation>\r
										</xs:element>\r
										<xs:element name="InstalledFolder" type="xs:anyURI"\r
											minOccurs="1" maxOccurs="1">\r
											<xs:annotation>\r
												<xs:documentation xml:lang="en-us"> This is used to\r
													track the actual installation location, relative to\r
													the WORKSPACE. During an installation, the user may be\r
													presented with an option to relocate package content\r
													from the ZIP portion of the archive into a different\r
													location. </xs:documentation>\r
												<xs:documentation> Any installation tools must modify\r
													this value if the location is different from the\r
													default location. </xs:documentation>\r
												<xs:documentation> Any removal tools must check this\r
													value to locate correctly, the items that will be\r
													removed. </xs:documentation>\r
											</xs:annotation>\r
										</xs:element>\r
										<xs:element name="DecFilename" minOccurs="1" maxOccurs="1"\r
											type="xs:anyURI">\r
											<xs:annotation>\r
												<xs:documentation xml:lang="en-us"> This is the filename\r
													of the package declaration (DEC) filename created\r
													during installation in the InstalledFolder listed\r
													above. </xs:documentation>\r
											</xs:annotation>\r
										</xs:element>\r
										<xs:element ref="ModuleList" minOccurs="0" maxOccurs="1">\r
											<xs:annotation>\r
												<xs:documentation xml:lang="en-us"> This section is used\r
													to track the actual installation location, relative to\r
													the WORKSPACE. Every module that is part of this\r
													package must be listed here. During an installation,\r
													the user may be presented with an option to relocate\r
													module content from the ZIP portion of the archive\r
													into a different location, the installation tools must\r
													modify this value if the location is different from\r
													the default location. Any removal tools must check\r
													this value to locate correctly, the items that will be\r
													removed. </xs:documentation>\r
												<xs:documentation xml:lang="en-us"> The name of any INF\r
													files that were created during the installation of a\r
													distribution must also be listed in this section.\r
												</xs:documentation>\r
											</xs:annotation>\r
										</xs:element>\r
									</xs:sequence>\r
								</xs:complexType>\r
							</xs:element>\r
						</xs:sequence>\r
					</xs:complexType>\r
				</xs:element>\r
				<xs:element ref="ModuleList" minOccurs="0" maxOccurs="1">\r
					<xs:annotation>\r
						<xs:documentation xml:lang="en-us"> This section is used to record\r
							distribution packages that contain modules that are not part of a\r
							package. Modules that are part of packages are listed under the\r
							Package element of the PackageList section. </xs:documentation>\r
						<xs:documentation xml:lang="en-us"> Module only distribution will\r
							typically be for binary only modules, like the enhanced FAT\r
							driver. </xs:documentation>\r
					</xs:annotation>\r
				</xs:element>\r
			</xs:sequence>\r
		</xs:complexType>\r
	</xs:element>\r
\r
	<xs:element name="GUID">\r
		<xs:complexType>\r
			<xs:simpleContent>\r
				<xs:extension base="RegistryFormatGuid">\r
					<xs:attribute name="Version" type="xs:decimal" use="required" />\r
				</xs:extension>\r
			</xs:simpleContent>\r
		</xs:complexType>\r
	</xs:element>\r
\r
	<!-- Simple Types that further restrict allowed content. -->\r
\r
	<xs:simpleType name="RegistryFormatGuid">\r
		<xs:annotation>\r
			<xs:documentation xml:lang="en-us"> A Registry format GUID must contain\r
				five different Hexadecimal character sets that are separated by a dash\r
				(-) character. </xs:documentation>\r
		</xs:annotation>\r
		<xs:restriction base="xs:normalizedString">\r
			<xs:pattern\r
				value="\s*[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\s*"\r
			 />\r
		</xs:restriction>\r
	</xs:simpleType>\r
\r
</xs:schema>\r