1. Correct File header to ## @file

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / DataHubDxe / DataHubDxe.inf

diff --git a/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHubDxe.inf b/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHubDxe.inf
index 7e75436f53b19fa33e9e636b54494e7b2ce9fff1..a7597f40b760cf54a58732e4e9bb1f2b93776cbe 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHubDxe.inf
+++ b/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHubDxe.inf
@@ -1,8 +1,27 @@
-#/** @file\r
-#  Component description file for DataHub module.\r
-#\r
+## @file\r
 #  This driver initializes and installs the Data Hub protocol.\r
-#  Copyright (c) 2006 - 2009, Intel Corporation\r
+#\r
+#  The data hub is a volatile database that is intended as the major focus for the accumulation of\r
+#  manageability data.T he hub is fed by "producers" with chunks of data in a defined format.\r
+#  Consumers may then extract the data in temporal "log" order.As an example, progress codes might\r
+#  be recorded in the data hub for future processing.Ot her data contributed to the data hub might\r
+#  include, for example, statistics on enumerated items such as memory, add-in buses, and add-in\r
+#  cards and data on errors encountered during boot (for example, the system did not boot off the\r
+#  network because the cable was not plugged in).\r
+#  Some classes of data have defined formats.For example, the amount of memory in the system is\r
+#  reported in a standard format so that consumers can be written to extract the data.O ther data is\r
+#  system specific.For example, additional detail on errors might be specific to the driver that\r
+#  discovered the error.The consumer might be a driver that tabularizes data from the data hub,\r
+#  providing a mechanism for the raw data to be made available to the OS for post-processing by\r
+#  OS-based applications.\r
+#  The intent of the data hub is for drivers that enumerate and configure parts of the system to report\r
+#  their discoveries to the data hub.This data can then be extracted by other drivers that report those\r
+#  discoveries using standard manageability interfaces such as SMBIOS and Intelligent Platform\r
+#  Management Interface (IPMI).The alternative to a data-hub-like architecture is to require all\r
+#  drivers to be aware of all reporting formats.\r
+#  For more information, please ref http://www.intel.com/technology/framework/\r
+#  \r
+#  Copyright (c) 2006 - 2010, Intel Corporation\r
 #\r
 #  All rights reserved. This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -12,7 +31,7 @@
 #  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 #\r
 #\r
-#**/\r
+##\r
 \r
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
@@ -29,7 +48,7 @@
 #  VALID_ARCHITECTURES           = IA32 X64 IPF EBC\r
 #\r
 \r
-[Sources.common]\r
+[Sources]\r
   DataHub.h\r
   DataHub.c\r
 \r
@@ -51,7 +70,7 @@
 \r
 \r
 [Protocols]\r
-  gEfiDataHubProtocolGuid                       # PROTOCOL ALWAYS_PRODUCED\r
+  gEfiDataHubProtocolGuid                       # PROTOCOL PRODUCED\r
 \r
 \r
 [Depex]\r