Changed the rules to allow for partial installation and removal of fars.
[mirror_edk2.git] / Tools / XMLSchema / FarManifest.xsd
CommitLineData
85c483cb 1<?xml version="1.0" encoding="UTF-8"?>\r
2<!--\r
3Filename: FarManifest.xsd\r
4\r
5Copyright (c) 2006, Intel Corp.\r
6All rights reserved. This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which may be found at http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13-->\r
14<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://www.TianoCore.org/2006/Edk2.0" xmlns="http://www.TianoCore.org/2006/Edk2.0">\r
15 <xs:include schemaLocation="FrameworkHeaders.xsd"/> \r
16 <xs:annotation>\r
17 <xs:documentation xml:lang="en">\r
18 The Framework Archive File Format is defined as a Java Archive file, with a special xml file called FrameworkArchiveManifest.xml at the top of the archive. The FrameworkArchiveManifest.xml must be an instance of this schema.\r
19 </xs:documentation>\r
20 </xs:annotation>\r
21 <xs:element name="FrameworkArchiveManifest">\r
22 <xs:annotation>\r
23 <xs:documentation xml:lang="en">\r
24 This schema defines the Framework Archive Manifest. \r
25 </xs:documentation>\r
26 </xs:annotation>\r
27 <xs:complexType>\r
28 <xs:sequence>\r
29 <xs:element minOccurs="1" maxOccurs="1" ref="FarHeader"/>\r
30 <xs:element minOccurs="0" maxOccurs="1" ref="FarPackageList"> \r
31 <xs:annotation>\r
32 <xs:documentation>\r
33 The list of packages in this FAR.\r
34 </xs:documentation>\r
35 </xs:annotation>\r
36 </xs:element>\r
37 <xs:element minOccurs="0" maxOccurs="1" ref="FarPlatformList"> \r
38 <xs:annotation>\r
39 <xs:documentation>\r
40 The list of platforms in this FAR.\r
41 </xs:documentation>\r
42 </xs:annotation>\r
43 </xs:element>\r
44 <xs:element minOccurs="0" maxOccurs="1" ref="Contents"> \r
45 <xs:annotation>\r
46 <xs:documentation>\r
47 Extra contents that are not part of any Package or Platform. These file paths are WORKSPACE relative. If a file exists in the workspace at this location, then the user should be asked whether to overwrite. When the user removes the far, these should be removed also, unless they have been modified (per md5sum).\r
48 </xs:documentation>\r
49 </xs:annotation>\r
50 </xs:element>\r
51 <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>\r
52 </xs:sequence>\r
53 </xs:complexType>\r
54 </xs:element>\r
55 <xs:element name="FarPackageList">\r
56 <xs:complexType>\r
57 <xs:sequence>\r
58 <xs:element minOccurs="1" maxOccurs="unbounded" ref="FarPackage"/>\r
59 </xs:sequence>\r
60 </xs:complexType>\r
61 </xs:element>\r
62 <xs:element name="FarPackage">\r
63 <xs:complexType>\r
64 <xs:sequence>\r
65 <xs:element ref="FarFilename">\r
66 <xs:annotation>\r
67 <xs:documentation>\r
beabcf66 68 This is the name of the .spd or file that describes the package. It must exist in the directory identified by DefaultPath.\r
85c483cb 69 </xs:documentation>\r
70 </xs:annotation>\r
71 </xs:element>\r
72 <xs:element ref="GuidValue"></xs:element>\r
73 <xs:element ref="Version"></xs:element>\r
74 <xs:element ref="DefaultPath">\r
75 <xs:annotation>\r
76 <xs:documentation>\r
77 This is the default installation location within the workspace. This also serves as the location within the far itself of the package root. The Contents of the pacakage will be found there. The user may choose some other location within the workspace to install the package, as long as it does not overlap a package that is already installed.\r
78 </xs:documentation>\r
79 </xs:annotation>\r
80 </xs:element>\r
beabcf66 81 <xs:element minOccurs="0" maxOccurs="1" ref="FarPlatformList">\r
85c483cb 82 <xs:annotation>\r
83 <xs:documentation>\r
beabcf66 84 This list of platforms is relative to the package root of the package that they are contained in. If the package that these are bound to is intstalled in some directory other than the default, then these platforms should be stored relative to that.\r
85c483cb 85 </xs:documentation>\r
86 </xs:annotation>\r
87 </xs:element>\r
88 <xs:element ref="Contents">\r
89 <xs:annotation>\r
90 <xs:documentation>\r
91 This is the list of files that belong to the package. They are specified by relative path from the root of the pacakge. \r
92 </xs:documentation>\r
93 </xs:annotation>\r
94 </xs:element>\r
95 <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"></xs:element>\r
96 </xs:sequence>\r
97 </xs:complexType>\r
98 </xs:element>\r
99 <xs:element name="FarPlatform">\r
100 <xs:annotation>\r
101 <xs:documentation>\r
102 Platforms are treated separately from packages. A platform is listed in the far if, and only if, it is not part of some package.\r
103 </xs:documentation>\r
104 </xs:annotation>\r
105 <xs:complexType>\r
106 <xs:sequence>\r
107 <xs:element ref="FarFilename">\r
108 <xs:annotation>\r
109 <xs:documentation>\r
110 This is the relative path to the .fpd file that describes the platform.\r
111 </xs:documentation>\r
112 </xs:annotation>\r
113 </xs:element>\r
114 <xs:element ref="GuidValue"></xs:element>\r
115 <xs:element ref="Version"></xs:element>\r
116 <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"></xs:element>\r
117 </xs:sequence>\r
118 </xs:complexType>\r
119 </xs:element>\r
120 <xs:element name="DefaultPath" type="PathAndFilename"/>\r
121 <xs:element name="FarPlatformList">\r
122 <xs:complexType>\r
123 <xs:sequence>\r
124 <xs:element maxOccurs="unbounded" ref="FarPlatform">\r
125 </xs:element>\r
126 </xs:sequence>\r
127 </xs:complexType>\r
128 </xs:element>\r
129 <xs:element name="FarFilename" type="DbPathAndFilename">\r
130 <xs:annotation>\r
131 <xs:documentation>\r
132 The FarFilename is used to build up the Contents list. It has an md5sum attribute for keeping track of whether the file is changed after it is installed. The Md5sum can also be used to check the integrity of a far before it is installed into the workspace.\r
133 </xs:documentation>\r
134 </xs:annotation>\r
135 </xs:element>\r
136 <xs:element name="GuidValue" type="GuidType">\r
137 <xs:annotation>\r
138 <xs:documentation>\r
139 The purpose of this element is to allow Guids to be assigned to or used by other elements in the schema.\r
140 </xs:documentation>\r
141 </xs:annotation>\r
142 </xs:element>\r
143 <xs:element name="Contents">\r
144 <xs:annotation>\r
145 <xs:documentation>\r
146 This tag allows us to specify a tree of files all having a common root. All the files specified are relative to that common root.\r
147 </xs:documentation>\r
148 </xs:annotation>\r
149 <xs:complexType>\r
150 <xs:sequence>\r
151 <xs:element maxOccurs="unbounded" ref="FarFilename"/>\r
152 </xs:sequence>\r
153 </xs:complexType>\r
154 </xs:element>\r
155 <xs:annotation>\r
156 <xs:documentation xml:lang="en">\r
157 Definitions and rules for creating, installing, updating and removing fars within the workspace.\r
158 </xs:documentation>\r
159 <xs:documentation>\r
beabcf66 160 1. A module m is said to depend upon a package p, iff there exists a tuple (PackageGuid, PackageVerion) in the set m->PackageDependencies for which p->Guid==PackageGuid, and if PackageVersion is not empty, then p->Version== PackageVersion.\r
85c483cb 161 </xs:documentation>\r
162 <xs:documentation>\r
163 2. A far f is said to depend on a far g, iff there is a module in a package in f that depends on a package in g.\r
164 </xs:documentation>\r
165 <xs:documentation>\r
166 3. A far f is said to depend on a package p, iff there is a module m contained in f that depends on p.\r
167 </xs:documentation>\r
168 <xs:documentation>\r
169 3.1 A platform q is said to depend on a package p, iff p, or some module m contained in p, is necessary to build q.\r
170 </xs:documentation>\r
171 <xs:documentation>\r
6b039a51 172 4. A far f may be installed into the workspace w, iff for each module m in f, m's dependencies are met by the packages in w or f.\r
85c483cb 173 </xs:documentation>\r
174 <xs:documentation>\r
6b039a51 175 a. It is supported to "partially" install a far. A partial installation of a far means that 1 or more packages and/or platforms are installed into the workspace from the far. For each package or platform p in f, p's dependencies must be satisfied by a package in the workspace.\r
85c483cb 176 </xs:documentation>\r
177 <xs:documentation>\r
178 5. A far f may be removed from the workspace w, iff for each module m in w, and for each package p in f, m does not depend on p.\r
179 </xs:documentation>\r
180 <xs:documentation>\r
6b039a51 181 a. It is supported to "partially" remove a far. In this case, one or more of the packages or platforms in the far can be removed, provided that for each package and platform p in the workspace w, there does not exist a module m such that m depends on p.\r
85c483cb 182 </xs:documentation>\r
183 <xs:documentation>\r
184 6. When installing a far f into workspace w, for each package p in f, allow the user to install in p's default location, or choose a new location l (which must be unoccupied) within the workspace. Record this location l in the database. Each package p in f will be recorded in the database, associated with the GUID of f, as well as the actual install location l. (So we will know which far each package belongs to.)\r
185 </xs:documentation>\r
186 <xs:documentation>\r
6b039a51 187 7. When installing a far f into workspace w, if there exists a package p in w, and p is in f, then the user must be prompted to choose a location that does not collide with the location of p in workspace w. We will end up with two instances of p in w at two distinct locations. Alternately, the user may elect to partially install the far, leaving out the redundant package.\r
85c483cb 188 </xs:documentation>\r
189 <xs:documentation>\r
190 8. A far f may replace a far g in the workspace w, iff for each module m contained in w, if m depends on a package p, and p is only contained in g, then there must exist a package q in f, such that m depends on q. The net effect is that g is removed and f is installed, in one operation. The normal rules for installing f still apply--the dependencies of the modules of f must be satisfied. After the replacement, it must be the case that all the modules dependencies in the workspace are satisfied. Note that it is possible to backrev a package in this way. \r
191 </xs:documentation>\r
192 <xs:documentation>\r
193 (If we find that the replace is not permitted, then the user may install f and keep g. Next, he could _port_ every module m in w that depends on g, to f and eventually remove g.)\r
194 </xs:documentation>\r
195 <xs:documentation>\r
196 9. A special case of the above rule is that a far f may be reinstalled into the workspace. (This would allow the user to get a fresh copy, or change the location in the workspace where one or more of the packages of f are installed.)\r
197 </xs:documentation>\r
198 <xs:documentation>\r
199 10. When a far f is removed from the workspace w, for each package p in f, we will remove p from w.\r
200 </xs:documentation>\r
201 <xs:documentation>\r
6b039a51 202 11. If a package or platform p belongs to a far f, then it is legal to remove p from the workspace w iff, there does not exist a module m in w such that m depends on p.\r
85c483cb 203 </xs:documentation>\r
204 <xs:documentation>\r
6b039a51 205 12. When a far f is removed from the workspace, the we will remove all the files in f from the workspace tree. If a file has been modified from the original as installed from the far (per md5sum) then the user should be asked if he is "sure" he wants to remove it.\r
85c483cb 206 </xs:documentation>\r
207 <xs:documentation>\r
6b039a51 208 13. When a far is created, a GUID is generated and assigned to the far. If a far is created from the same components at a later time, it would have a different GUID.\r
85c483cb 209 </xs:documentation>\r
210 <xs:documentation>\r
6b039a51 211 14. If a package p is marked with p->RePackage==false, then p may not be added to a far.\r
85c483cb 212 </xs:documentation>\r
213 <xs:documentation>\r
6b039a51 214 15. When constructing a far f that contains at least one platform, then f may optionally be constructed such that for each platform q in f, every package p on which q depends should be included in f, unless p->RePackage==false. The far will have all the packages required, and may then be installed as a self-inflating executable that will create a brand new workspace on the developer's workstation.\r
85c483cb 215 </xs:documentation>\r
216 <xs:documentation>\r
6b039a51 217 16. A far f is identical to a far g, iff f->Guid == g->Guid.\r
85c483cb 218 </xs:documentation>\r
219 <xs:documentation>\r
6b039a51 220 17. A far f may be installed into the workspace w, iff there is no far g in w such that f->Guid==g->Guid. In that case, it is called "updating" the far in the workspace. The user may select some subset of packages or platforms to reinstall or update, to ensure that the files in the workspace are correct.\r
85c483cb 221 </xs:documentation>\r
85c483cb 222 </xs:annotation>\r
223</xs:schema>\r