From 634366733dd389fe33016732b67b5d212e5c8f24 Mon Sep 17 00:00:00 2001 From: myronporter Date: Sat, 13 Mar 2010 01:03:39 +0000 Subject: [PATCH] Grammatical and disclaimer changes (does not follow internal C coding stds.) git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10238 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Compatibility/Include/Guid/BootState.h | 27 +++++++++-------- .../Include/Guid/SmmBaseThunkCommunication.h | 15 +++++----- .../Include/Library/LanguageLib.h | 29 +++++++++++------- .../Compatibility/Include/Ppi/EcpPciCfg.h | 30 +++++++++++-------- .../Compatibility/Include/Protocol/Print.h | 23 +++++++------- 5 files changed, 69 insertions(+), 55 deletions(-) diff --git a/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h b/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h index 8211328443..627521edb1 100644 --- a/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h +++ b/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h @@ -1,20 +1,21 @@ /** @file - GUID and Name is used to configure PcdBootState to DynamicHii PCD, which can - make EDKII core work with EDK implementation. + GUID and Name are used to configure PcdBootState to DynamicHii PCD, which can + make EDKII core work with the EDK implementation. - EDK implementation may depend on this guid variable to check boot state. But - EDKII core uses the dynamic PcdBootState to save boot state. To be compatible to EDK implementation, - BootStateGuid and BootStateName will be used to configure PcdBootState to DynamicHii PCD to - save boot state as variable. + The EDK implementation may depend on this guid variable to check the boot state. + However, the EDKII core uses a dynamic PcdBootState to save the boot state. To be compatible with EDK implementations, + BootStateGuid and BootStateName are used to configure PcdBootState to DynamicHii PCD to + save the boot state as a variable. - Copyright (c) 2010, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php +Copyright (c) 2010, Intel Corporation. All rights reserved
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.
+All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _BOOT_STATE_H_ diff --git a/EdkCompatibilityPkg/Compatibility/Include/Guid/SmmBaseThunkCommunication.h b/EdkCompatibilityPkg/Compatibility/Include/Guid/SmmBaseThunkCommunication.h index 76deda8693..188aff9bd2 100644 --- a/EdkCompatibilityPkg/Compatibility/Include/Guid/SmmBaseThunkCommunication.h +++ b/EdkCompatibilityPkg/Compatibility/Include/Guid/SmmBaseThunkCommunication.h @@ -2,14 +2,15 @@ GUID and data structures for communication between SMM Base on SMM Base2 Thunk driver and SmmBaseHelper driver. - Copyright (c) 2009 - 2010, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php +Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.
+All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _SMM_BASE_THUNK_COMMUNICATION_H_ diff --git a/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h b/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h index 406704a254..a25fbae8c4 100644 --- a/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h +++ b/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h @@ -1,11 +1,12 @@ /** @file Provides functions for language conversion between ISO 639-2 and RFC 4646 styles. -Copyright (c) 2009 - 2010, Intel Corporation
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php +http://opensource.org/licenses/bsd-license.php. THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @@ -28,7 +29,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. representing an RFC 4646 language code containing only either a ISO 639-1 or ISO 639-2 primary language subtag. This string is Null-terminated. - @param[in] Iso639Language Pointer to a 3-letter ASCII string that represents + @param[in] Iso639Language The pointer to a 3-letter ASCII string that represents an ISO 639-2 language code. This string is not required to be Null-terminated. @@ -53,8 +54,10 @@ ConvertIso639ToRfc4646 ( If Iso639Language is NULL, then ASSERT(). @param[out] Iso639Language Pointers to a buffer large enough for a 3-letter ASCII string - representing an ISO 639-2 language code. The string is Null-terminated. - @param[in] Rfc4646Language Pointer to a RFC 4646 language code string. This string is terminated + representing an ISO 639-2 language code. The string + is Null-terminated. + @param[in] Rfc4646Language The pointer to a RFC 4646 language code string. + This string is terminated by a NULL or a ';' character. @retval TRUE Language code converted successfully. @@ -79,8 +82,10 @@ ConvertRfc4646ToIso639 ( @retval NULL Invalid ISO 639-2 language code found. @retval NULL Out of memory. - @return Pointer to the allocate buffer containing the Null-terminated converted language codes string. - This string is composed of one or more RFC4646 language codes each of which has only + @return The pointer to the allocate buffer containing the + Null-terminated converted language codes string. + This string is composed of one or more RFC4646 + language codes each of which has only ISO 639-1 2-letter primary language subtag. **/ @@ -97,13 +102,15 @@ ConvertLanguagesIso639ToRfc4646 ( If Rfc4646Languages is NULL, then ASSERT. - @param[in] Rfc4646Languages Pointers to a Null-terminated RFC 4646 language codes string containing - one or more RFC 4646 language codes. + @param[in] Rfc4646Languages Pointers to a Null-terminated RFC 4646 language codes + string containing one or more RFC 4646 language codes. @retval NULL Invalid or unsupported RFC 4646 language code found. @retval NULL Out of memory. - @return Pointer to the allocate buffer containing the Null-terminated converted language codes string. - This string is composed of one or more ISO 639-2 language codes. + @return The pointer to the allocate buffer containing the + Null-terminated converted language codes string. + This string is composed of one or more ISO 639-2 + language codes. **/ CHAR8 * diff --git a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h index 9428ff9134..524aa12902 100644 --- a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h +++ b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h @@ -1,13 +1,15 @@ /** @file -This PPI is the same as the PPI in the framework PciCfg, with one exception: this PPI does not include a modify API, while the PPI in the framework PciCfg does. +This PPI is the same as the PPI in the framework PciCfg, with one exception. +Specifically, this PPI does not include a modify API, while the PPI in the framework PciCfg does. -Copyright (c) 2008 - 2010, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.
+All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -23,19 +25,21 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. typedef struct _ECP_PEI_PCI_CFG_PPI ECP_PEI_PCI_CFG_PPI; /** - PCI read and write operation. + A PCI read and write operation. - Writes to or reads from a given location in the PCI configuration space. + Writes to, or reads from, a given location in the PCI configuration space. - @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. - @param This Pointer to local data for the interface. + @param PeiServices An indirect pointer to the PEI Services Table + published by the PEI Foundation. + @param This The pointer to local data for the interface. @param Width The width of the access. Enumerated in bytes. @param Address The physical address of the access. The format of the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS. @param Buffer A pointer to the buffer of data. @retval EFI_SUCCESS The function completed successfully. @retval EFI_DEVICE_ERROR There was a problem with the transaction. - @retval EFI_DEVICE_NOT_READY The device is not capable of supporting the operation at this time. + @retval EFI_DEVICE_NOT_READY The device is not capable of supporting the + operation at this time. **/ typedef EFI_STATUS diff --git a/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h b/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h index 5c0426232a..d6ccc50d3b 100644 --- a/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h +++ b/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h @@ -3,11 +3,12 @@ The lite print protocol defines only one print function to print the format unicode string. -Copyright (c) 2006 - 2008, Intel Corporation +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php +http://opensource.org/licenses/bsd-license.php. THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @@ -26,17 +27,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. typedef struct _EFI_PRINT_PROTOCOL EFI_PRINT_PROTOCOL; /** - Produces a Null-terminated Unicode string in an output buffer based on - a Null-terminated Unicode format string and a VA_LIST argument list + Produces a Null-terminated Unicode string in an output buffer, based on + a Null-terminated Unicode format string and a VA_LIST argument list. Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer and BufferSize. The Unicode string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. - The number of Unicode characters in the produced output buffer is returned not including + The number of Unicode characters in the produced output buffer is returned, not including the Null-terminator. - If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned. + If BufferSize is 0 or 1, then no output buffer is produced, and 0 is returned. If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). @@ -46,13 +47,13 @@ typedef struct _EFI_PRINT_PROTOCOL EFI_PRINT_PROTOCOL; PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string - contains more than PcdMaximumUnicodeStringLength Unicode characters not including the + contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then ASSERT(). @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated Unicode string. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. - @param FormatString Null-terminated Unicode format string. + @param FormatString A Null-terminated Unicode format string. @param Marker VA_LIST marker for the variable argument list. @return The number of Unicode characters in the produced output buffer not including the @@ -69,9 +70,9 @@ UINTN ); /** - The EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string - based on a Null-terminated Unicode format string and a VA_LIST argument list and fill into - the buffer as output + EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string, + based on a Null-terminated Unicode format string and a VA_LIST argument list, and fills into + the buffer as output. **/ struct _EFI_PRINT_PROTOCOL { UNI_VSPRINT VSPrint;