Updated with comments
[people/mcb30/basetools.git] / Conf / XMLSchema / FarManifest.xsd
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!--\r
3 Filename: FarManifest.xsd\r
4 \r
5 Copyright (c) 2007, Intel Corp.\r
6 All rights reserved. This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which may be found at http://opensource.org/licenses/bsd-license.php\r
9 \r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT 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/2007/Edk2.1" xmlns="http://www.TianoCore.org/2007/Edk2.1">\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="Contents">   \r
38           <xs:annotation>\r
39             <xs:documentation>\r
40               Extra contents that are not part of any Package. 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
41             </xs:documentation>\r
42           </xs:annotation>\r
43         </xs:element>\r
44         <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>\r
45       </xs:sequence>\r
46     </xs:complexType>\r
47   </xs:element>\r
48   <xs:element name="FarPackageList">\r
49     <xs:complexType>\r
50       <xs:sequence>\r
51         <xs:element minOccurs="1" maxOccurs="unbounded" ref="FarPackage"/>\r
52       </xs:sequence>\r
53     </xs:complexType>\r
54   </xs:element>\r
55   <xs:element name="FarPackage">\r
56     <xs:complexType>\r
57       <xs:sequence>\r
58         <xs:element ref="FarFilename">\r
59           <xs:annotation>\r
60             <xs:documentation>\r
61               This is the name of the .spd or file that describes the package. It must exist in the directory identified by DefaultPath.\r
62             </xs:documentation>\r
63           </xs:annotation>\r
64         </xs:element>\r
65         <xs:element ref="GuidValue"></xs:element>\r
66         <xs:element ref="Version"></xs:element>\r
67         <xs:element ref="DefaultPath">\r
68           <xs:annotation>\r
69             <xs:documentation>\r
70               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
71             </xs:documentation>\r
72           </xs:annotation>\r
73         </xs:element>\r
74         <xs:element ref="Contents">\r
75           <xs:annotation>\r
76             <xs:documentation>\r
77               This is the list of files that belong to the package. They are specified by relative path from the root of the pacakge.                            \r
78             </xs:documentation>\r
79           </xs:annotation>\r
80         </xs:element>\r
81         <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"></xs:element>\r
82       </xs:sequence>\r
83     </xs:complexType>\r
84   </xs:element>\r
85   <xs:element name="DefaultPath" type="PathAndFilename"/>\r
86   <xs:element name="FarFilename" type="DbPathAndFilename">\r
87     <xs:annotation>\r
88       <xs:documentation>\r
89         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
90       </xs:documentation>\r
91     </xs:annotation>\r
92   </xs:element>\r
93   <xs:element name="GuidValue" type="GuidType">\r
94     <xs:annotation>\r
95       <xs:documentation>\r
96         The purpose of this element is to allow Guids to be assigned to or used by other elements in the schema.\r
97       </xs:documentation>\r
98     </xs:annotation>\r
99   </xs:element>\r
100   <xs:element name="Contents">\r
101     <xs:annotation>\r
102       <xs:documentation>\r
103         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
104       </xs:documentation>\r
105     </xs:annotation>\r
106     <xs:complexType>\r
107       <xs:sequence>\r
108         <xs:element maxOccurs="unbounded" ref="FarFilename"/>\r
109       </xs:sequence>\r
110     </xs:complexType>\r
111   </xs:element>\r
112   <xs:annotation>\r
113     <xs:documentation xml:lang="en">\r
114       Definitions and rules for creating, installing, updating and removing fars within the workspace.\r
115     </xs:documentation>\r
116     <xs:documentation>\r
117       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
118     </xs:documentation>\r
119     <xs:documentation>\r
120       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
121     </xs:documentation>\r
122     <xs:documentation>\r
123       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
124     </xs:documentation>\r
125     <xs:documentation>\r
126       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
127     </xs:documentation>\r
128     <xs:documentation>\r
129       a.  It is supported to "partially" install a far. A partial installation of a far means that 1 or more packages are installed into the workspace from the far. For each package p in f, p's dependencies must be satisfied by a package in the workspace.\r
130     </xs:documentation>\r
131     <xs:documentation>\r
132       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
133     </xs:documentation>\r
134     <xs:documentation>\r
135       a.  It is supported to "partially" remove a far. In this case, one or more of the packages in the far can be removed, provided that for each package p in the workspace w, there does not exist a module m such that m depends on p.\r
136     </xs:documentation>\r
137     <xs:documentation>\r
138       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
139     </xs:documentation>\r
140     <xs:documentation>\r
141       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
142     </xs:documentation>\r
143     <xs:documentation>\r
144       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
145     </xs:documentation>\r
146     <xs:documentation>\r
147           (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
148     </xs:documentation>\r
149     <xs:documentation>\r
150       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
151     </xs:documentation>\r
152     <xs:documentation>\r
153       10. When a far f is removed from the workspace w, for each package p in f, we will remove p from w.\r
154     </xs:documentation>\r
155     <xs:documentation>\r
156       11. If a package 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
157     </xs:documentation>\r
158     <xs:documentation>\r
159       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
160     </xs:documentation>\r
161     <xs:documentation>\r
162       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
163     </xs:documentation>\r
164     <xs:documentation>\r
165       14. If a package p is marked with p->RePackage==false, then p may not be added to a far.\r
166     </xs:documentation>\r
167     <xs:documentation>\r
168       15. A far f is identical to a far g, iff f->Guid == g->Guid.\r
169     </xs:documentation>\r
170     <xs:documentation>\r
171       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 to reinstall or update, to ensure that the files in the workspace are correct.\r
172     </xs:documentation>\r
173   </xs:annotation>\r
174 </xs:schema>\r