From b287e6f8ec5d2640125c09d5d7256229335f81e0 Mon Sep 17 00:00:00 2001
From: Chenli Wei <chenli.wei@intel.com>
Date: Fri, 30 Sep 2022 00:59:18 +0800
Subject: [PATCH] misc: add documentation element for CACHE_REGION

Some member of CACHE_REGION have no documentation element, this cause
some issue when we generate documentation for user.

This patch add some documentation to fix the above issue.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@intel.com>
---
 misc/config_tools/schema/types.xsd | 36 +++++++++++++++++++++++++-----
 1 file changed, 30 insertions(+), 6 deletions(-)

diff --git a/misc/config_tools/schema/types.xsd b/misc/config_tools/schema/types.xsd
index b09f578a6..abd50d8cd 100644
--- a/misc/config_tools/schema/types.xsd
+++ b/misc/config_tools/schema/types.xsd
@@ -330,17 +330,41 @@ the board hardware does not support RDT, enabling this option is ignored.</xs:do
 
 <xs:complexType name="CachePolicyType">
   <xs:sequence>
-    <xs:element name="VM" type="xs:string" />
-    <xs:element name="VCPU" type="xs:integer" />
-    <xs:element name="TYPE" type="CacheType" minOccurs="1"/>
-    <xs:element name="CLOS_MASK" type="HexFormat" />
+    <xs:element name="VM" type="xs:string">
+      <xs:annotation acrn:title="VM Name">
+        <xs:documentation>The Name of VM</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="VCPU" type="xs:integer">
+      <xs:annotation acrn:title="Virtual CPU ID">
+        <xs:documentation>The Virtual CPU index of VM</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="TYPE" type="CacheType" minOccurs="1">
+      <xs:annotation acrn:title="Cache Type">
+        <xs:documentation>The Type of Cache Region</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="CLOS_MASK" type="HexFormat">
+      <xs:annotation acrn:title="Cache CLOS Mask">
+        <xs:documentation>The Cache Region Mask</xs:documentation>
+      </xs:annotation>
+    </xs:element>
   </xs:sequence>
 </xs:complexType>
 
 <xs:complexType name="CacheAllocationType">
   <xs:sequence>
-    <xs:element name="CACHE_ID" type="HexFormat"/>
-    <xs:element name="CACHE_LEVEL" type="xs:integer"/>
+    <xs:element name="CACHE_ID" type="HexFormat">
+      <xs:annotation acrn:title="Cache ID">
+        <xs:documentation>The Cache Region index</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="CACHE_LEVEL" type="xs:integer">
+      <xs:annotation acrn:title="Cache Level">
+        <xs:documentation>The Cache Region Level</xs:documentation>
+      </xs:annotation>
+    </xs:element>
     <xs:element name="POLICY" type="CachePolicyType"  minOccurs="1" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>