From aa170a3d1157c8c001c386bb7d13370dbb0d97e9 Mon Sep 17 00:00:00 2001
From: "David B. Kinder" <david.b.kinder@intel.com>
Date: Fri, 22 Apr 2022 16:05:30 -0700
Subject: [PATCH] doc: update acrn:title for uniqueness and context clarity

Make small changes to DX-friendly acrn:title names to make them unique
across the options and to provide meaningful names when shown out of
context in the config option documentation.

Tracked-On: #5692

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
---
 misc/config_tools/schema/VMtypes.xsd | 6 +++---
 misc/config_tools/schema/config.xsd  | 4 ++--
 misc/config_tools/schema/types.xsd   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/misc/config_tools/schema/VMtypes.xsd b/misc/config_tools/schema/VMtypes.xsd
index b19a66289..5deea6479 100644
--- a/misc/config_tools/schema/VMtypes.xsd
+++ b/misc/config_tools/schema/VMtypes.xsd
@@ -221,7 +221,7 @@ The size is a subset of the VM's total memory size specified on the Basic tab.</
       </xs:annotation>
     </xs:element>
     <xs:element name="vbdf" type="VBDFType">
-      <xs:annotation acrn:title="Virtual BDF" acrn:defaults="[f'00:{i:02x}.0' for i in range(16, 24)]" acrn:unique-among="//vuart_connection/endpoint[vm_name=$parent/vm_name]/vbdf/text()">
+      <xs:annotation acrn:title="Virtual UART BDF" acrn:defaults="[f'00:{i:02x}.0' for i in range(16, 24)]" acrn:unique-among="//vuart_connection/endpoint[vm_name=$parent/vm_name]/vbdf/text()">
         <xs:documentation>Specify the virtual Bus:Device.Function (BDF) for each PCI virtual UART. Virtual BDF is automatically assigned when the configuration is saved and can be changed if needed.</xs:documentation>
       </xs:annotation>
     </xs:element>
@@ -231,12 +231,12 @@ The size is a subset of the VM's total memory size specified on the Basic tab.</
 <xs:complexType name="VuartConnectionType">
   <xs:sequence>
       <xs:element name="name" type="xs:string">
-          <xs:annotation>
+          <xs:annotation acrn:title="vUART name">
         <xs:documentation>Specify the vUART name.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="type" type="VuartType" default="legacy">
-      <xs:annotation acrn:title="Type">
+      <xs:annotation acrn:title="vUART Type">
         <xs:documentation>Select the communication virtual UART (vUART) type.</xs:documentation>
       </xs:annotation>
     </xs:element>
diff --git a/misc/config_tools/schema/config.xsd b/misc/config_tools/schema/config.xsd
index 4b2bea796..3139814fb 100644
--- a/misc/config_tools/schema/config.xsd
+++ b/misc/config_tools/schema/config.xsd
@@ -289,7 +289,7 @@ Refer to :ref:`vuart_config` for detailed vUART settings.</xs:documentation>
   <xs:all>
     <xs:element name="load_order" type="LoadOrderType">
       <xs:annotation acrn:title="Load order" acrn:views="">
-        <xs:documentation>Specify the load_order.</xs:documentation>
+        <xs:documentation>Specify the VM load order.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="vm_type" type="VMType" minOccurs="0">
@@ -328,7 +328,7 @@ Refer to :ref:`vuart_config` for detailed vUART settings.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="virtual_cat_support" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation acrn:title="Virtual Cache Allocation Tech" acrn:applicable-vms="pre-launched, post-launched" acrn:views="advanced">
+      <xs:annotation acrn:title="VM Virtual Cache Allocation Tech" acrn:applicable-vms="pre-launched, post-launched" acrn:views="advanced">
         <xs:documentation>Enable virtualization of the Cache Allocation Technology (CAT) feature in RDT. CAT enables you to allocate cache to VMs, providing isolation to avoid performance interference from other VMs.</xs:documentation>
       </xs:annotation>
     </xs:element>
diff --git a/misc/config_tools/schema/types.xsd b/misc/config_tools/schema/types.xsd
index 059fe887c..36a4aae09 100644
--- a/misc/config_tools/schema/types.xsd
+++ b/misc/config_tools/schema/types.xsd
@@ -259,7 +259,7 @@ Read more about the available scheduling options in :ref:`cpu_sharing`.</xs:docu
 <xs:complexType name="IVSHMEMRegionType">
   <xs:all>
     <xs:element name="NAME">
-      <xs:annotation acrn:title="Name">
+      <xs:annotation acrn:title="Region Name">
         <xs:documentation>Name of the shared memory region.</xs:documentation>
       </xs:annotation>
       <xs:simpleType>
@@ -277,7 +277,7 @@ Read more about the available scheduling options in :ref:`cpu_sharing`.</xs:docu
       </xs:annotation>
     </xs:element>
     <xs:element name="IVSHMEM_SIZE" type="IVSHMEMSize" default="2">
-      <xs:annotation acrn:title="Size (MB)">
+      <xs:annotation acrn:title="Region Size (MB)">
         <xs:documentation>Select the size of the shared memory region
 in megabytes. The value should be a power of 2
 and no more than 512.</xs:documentation>