Function headers in .h and .c files synchronized with spec

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

diff --git a/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h b/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
index f890cd82b281e869d2ee799caf8606f527fcf24b..04284c73305834a7cde45e9bb8112146befe7f4a 100644 (file)
--- a/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
@@ -1,8 +1,16 @@
 /** @file\r
   Provides a service to retrieve a pointer to the EFI Runtime Services Table.\r
+\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
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\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