Added More Comments and started doing data type checking so that if a ModuleName...

[mirror_edk2.git] / Tools / XMLSchema / FrameworkHeaders.xsd

diff --git a/Tools/XMLSchema/FrameworkHeaders.xsd b/Tools/XMLSchema/FrameworkHeaders.xsd
index 7b1f9556841c5d4ba6bcc9aa4b135026adf0183e..ca8d13ca3c5c79d01d1ea639eeb09a06181c38f8 100644 (file)
--- a/Tools/XMLSchema/FrameworkHeaders.xsd
+++ b/Tools/XMLSchema/FrameworkHeaders.xsd
@@ -20,25 +20,41 @@
         <xs:complexType>\r
             <xs:sequence>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="DatabaseName"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                <!-- Value fixed during initialization: FrameworkDatabase -->\r
+                <xs:choice minOccurs="1" maxOccurs="1">\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>\r
+                    <!-- Guid needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                    <!-- GuidValue needs to be required -->\r
+                </xs:choice>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>\r
+                <!-- Version is the version of this file -->\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="Path"/>\r
+                <!-- Path needs to be removed -->\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
+                    <!-- Created needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <!-- CreatedDate needs to be required -->\r
+                </xs:choice>\r
+                <xs:choice minOccurs="0">\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
+                    <!-- Updated needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="UpdatedDate"/>\r
                 </xs:choice>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>\r
+                <!-- Specificatoin needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00090000 -->\r
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
     <xs:element name="MbdHeader">\r
+        <!-- MbdHeader needs to be removed -->\r
         <xs:annotation>\r
-            <xs:documentation xml:lang="en">This is the header for the Component Module Build Description (MBD) file. NOTE: The GUID may be different from the GUID in the MSA file, as the Guid is updated every time the file is changed, as the Guid may change if the contents of the file are changed.</xs:documentation>\r
+            <xs:documentation xml:lang="en">DO NOT USE! This is the header for the Component Module Build Description (MBD) file. NOTE: The GUID may be different from the GUID in the MSA file, as the Guid is updated every time the file is changed, as the Guid may change if the contents of the file are changed.</xs:documentation>\r
         </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
@@ -48,20 +64,22 @@
                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
                 </xs:choice>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
                 </xs:choice>\r
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
     <xs:element name="MbdLibHeader">\r
+        <!-- MbdLibHeader needs to be removed -->\r
         <xs:annotation>\r
-            <xs:documentation xml:lang="en">This is the header for the Library Module Build Description (MBD) file. NOTE: The Guid may be different from the Guid in the MSA file, as the Guid may change when the contents of the file are changed..</xs:documentation>\r
+            <xs:documentation xml:lang="en">DO NOT USE! This is the header for the Library Module Build Description (MBD) file. NOTE: The Guid may be different from the Guid in the MSA file, as the Guid may change when the contents of the file are changed..</xs:documentation>\r
         </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
@@ -71,13 +89,14 @@
                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
                 </xs:choice>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
                 </xs:choice>\r
             </xs:sequence>\r
         </xs:complexType>\r
@@ -88,28 +107,44 @@
         </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
-                <xs:element minOccurs="1" maxOccurs="1" ref="BaseName"/>\r
+                <xs:choice>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="BaseName"/>\r
+                    <!-- BaseName needs to be removed  -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" name="ModuleName" type="xs:NCName"/>\r
+                </xs:choice>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="ModuleType"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="ComponentType"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                <xs:choice>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>\r
+                    <!-- Guid needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                    <!-- GuidValue needs to be required -->\r
+                </xs:choice>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
+                    <!-- Created needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <!-- CreatedDate needs to be required -->\r
+                </xs:choice>\r
+                <xs:choice>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
+                    <!-- Updated needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
                 </xs:choice>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>\r
+                <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00090000 -->\r
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
     <xs:element name="MsaLibHeader">\r
+        <!-- MsaLibHeader needs to be removed -->\r
         <xs:annotation>\r
-            <xs:documentation xml:lang="en">This is the Library Module Surface Area Description Header - a replacement for INF files. The Guid may change when the contents of the file are changed.</xs:documentation>\r
+            <xs:documentation xml:lang="en">DO NOT USE! This is the Library Module Surface Area Description Header - a replacement for INF files. The Guid may change when the contents of the file are changed.</xs:documentation>\r
         </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
@@ -123,8 +158,8 @@
                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
                 </xs:choice>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>\r
@@ -137,18 +172,12 @@
         </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
-                <xs:element minOccurs="1" maxOccurs="1" name="PlatformName" type="PlatformNamingConvention">\r
-                    <xs:annotation>\r
-                        <xs:documentation xml:lang="en">Define the Name of a Platform</xs:documentation>\r
-                    </xs:annotation>\r
-                </xs:element>\r
+                <xs:element minOccurs="1" maxOccurs="1" name="PlatformName" type="PlatformNamingConvention"/>\r
                 <xs:choice>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Guid">\r
-                    <xs:annotation>\r
-                      <xs:documentation xml:lang="en">DO NOT USE! removing from XMLSchema</xs:documentation>\r
-                    </xs:annotation>\r
-                  </xs:element>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>\r
+                    <!-- DO NOT USE Guid needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                    <!-- GuidValue needs to be required -->\r
                 </xs:choice>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="Version"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>\r
@@ -156,40 +185,23 @@
                 <xs:element minOccurs="0" maxOccurs="1" ref="Copyright"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="License"/>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Created">\r
-                    <xs:annotation>\r
-                      <xs:documentation xml:lang="en">DO NOT USE! removing from XMLSchema</xs:documentation>\r
-                    </xs:annotation>\r
-                  </xs:element>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
-                </xs:choice>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="CreatedBy">\r
-                   <xs:annotation>\r
-                       <xs:documentation xml:lang="en">DO NOT USE! removing from XMLSchema</xs:documentation>\r
-                   </xs:annotation>\r
-                </xs:element>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
+                    <!-- DO NOT USE Created needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <!-- CreatedDate needs to be required -->\r
+                </xs:choice>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="CreatedBy"/>\r
+                <!-- DO NOT USE CreatedBy needs to be removed -->\r
                 <xs:choice>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Updated">\r
-                    <xs:annotation>\r
-                       <xs:documentation xml:lang="en">DO NOT USE! removing from XMLSchema</xs:documentation>\r
-                    </xs:annotation>\r
-                  </xs:element>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
-                </xs:choice>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="PackageType">\r
-                  <xs:annotation>\r
-                    <xs:documentation xml:lang="en">DO NOT USE! removing from XMLSchema</xs:documentation>\r
-                  </xs:annotation>\r
-                </xs:element>\r
-                <xs:element minOccurs="0" maxOccurs="1" name="BuildTarget">\r
-                  <xs:simpleType>\r
-                    <xs:restriction base="xs:NCName">\r
-                      <xs:enumeration value="DEBUG"/>\r
-                      <xs:enumeration value="RELEASE"/>\r
-                      <xs:enumeration value="BOTH"/>\r
-                    </xs:restriction>\r
-                  </xs:simpleType>\r
-                </xs:element>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
+                    <!-- DO NOT USE Updated needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
+                </xs:choice>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="PackageType"/>\r
+                <!-- DO NOT USE PackageType needs to be removed -->\r
+                <xs:element minOccurs="0" maxOccurs="1" name="BuildTarget" type="BuildTargets"/>\r
+                <xs:element minOccurs="0" maxOccurs="unbounded" ref="Specification"/>\r
+                <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00090000 -->\r
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
@@ -200,25 +212,38 @@
         <xs:complexType>\r
             <xs:sequence>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="PackageName"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                <xs:choice minOccurs="1" maxOccurs="1">\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>\r
+                    <!-- Guid needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>\r
+                    <!-- GuidValue needs to be required -->\r
+                </xs:choice>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>\r
                 <xs:choice minOccurs="1" maxOccurs="1">\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
-                  <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>\r
+                    <!-- Created needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>\r
+                    <!-- CreatedDate needs to be required -->\r
                 </xs:choice>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="E-Mail"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
+                <xs:choice minOccurs="0" maxOccurs="1">\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>\r
+                    <!-- Created needs to be removed -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
+                    <!-- CreatedDate needs to be required -->\r
+                </xs:choice>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="URL"/>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="PackageType"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="ReadOnly"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="RePackage"/>\r
                 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Specification"/>\r
+                <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00090000 -->\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="OutputDirectory"/>\r
+                <!-- OutputDirectory needs to be removed -->\r
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r