MdePkg: fix comment typo in DebugLib.h

[mirror_edk2.git] / MdePkg / Include / Library / UefiRuntimeServicesTableLib.h

diff --git a/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h b/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
index d1dfe43710c5095f725345abdf961e554ac38b93..f667d220e9f457a28f9c56865043cd32f6360016 100644 (file)
--- a/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
@@ -1,25 +1,32 @@
 /** @file\r
-  Library that provides a global pointer to the UEFI Runtime Services Tables\r
+  Provides a service to retrieve a pointer to the EFI Runtime Services Table.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  This library does not contain any functions or macros.  It simply exports the\r
+  global variable gRT that is a pointer to the EFI Runtime Services Table as defined\r
+  in the UEFI Specification.  The global variable gRT must be preinitialized to NULL.\r
+  The library constructor must set gRT to point at the EFI Runtime Services Table so\r
+  it is available at the module's entry point. Since there is overhead in initializing\r
+  this global variable, only those modules that actually require access to the EFI\r
+  Runtime Services Table should use this library.\r
+  Only available to DXE and UEFI module types.\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
 \r
-  Module Name:  UefiRuntimeServicesTableLib.h\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
 #ifndef __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__\r
 #define __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__\r
 \r
-//\r
-//\r
-//\r
+///\r
+/// Cached copy of the EFI Runtime Services Table\r
+///\r
 extern EFI_RUNTIME_SERVICES  *gRT;\r
 \r
 #endif\r