diff options
| author | Michael Kubacki <michael.kubacki@microsoft.com> | 2020-08-06 12:05:36 -0700 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2020-08-07 02:30:01 +0000 |
| commit | ef0460b852fbfec180089b5490f6888e5141a68e (patch) | |
| tree | 4c0b069a757eeafb97e4213c55f498741b505978 /FmpDevicePkg | |
| parent | bfe36cb4efe577405aa4116a95e22a646fc8ee0c (diff) | |
| download | edk2-ef0460b852fbfec180089b5490f6888e5141a68e.tar.gz edk2-ef0460b852fbfec180089b5490f6888e5141a68e.tar.bz2 edk2-ef0460b852fbfec180089b5490f6888e5141a68e.zip | |
FmpDevicePkg/FmpDependencyLib: Correct ValidateDependency() documentation
Modifies the return value documentation to state that the BOOLEAN
value indicates whether a given dependency expression is valid
not a capsule.
Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Cc: Wei6 Xu <wei6.xu@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Guomin Jiang <guomin.jiang@intel.com>
Reviewed-by: Wei6 Xu <wei6.xu@intel.com>
Diffstat (limited to 'FmpDevicePkg')
| -rw-r--r-- | FmpDevicePkg/Include/Library/FmpDependencyLib.h | 5 | ||||
| -rw-r--r-- | FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/FmpDevicePkg/Include/Library/FmpDependencyLib.h b/FmpDevicePkg/Include/Library/FmpDependencyLib.h index 1110eefa9a..c732903425 100644 --- a/FmpDevicePkg/Include/Library/FmpDependencyLib.h +++ b/FmpDevicePkg/Include/Library/FmpDependencyLib.h @@ -2,6 +2,7 @@ Fmp Capsule Dependency support functions for Firmware Management Protocol based
firmware updates.
+ Copyright (c) Microsoft Corporation.<BR>
Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@@ -29,8 +30,8 @@ typedef struct { @param[in] MaxDepexSize Max size of the dependency.
@param[out] DepexSize Size of dependency.
- @retval TRUE The capsule is valid.
- @retval FALSE The capsule is invalid.
+ @retval TRUE The dependency expression is valid.
+ @retval FALSE The dependency expression is invalid.
**/
BOOLEAN
diff --git a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c index 91dc0b9abd..2835806995 100644 --- a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c +++ b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c @@ -1,6 +1,7 @@ /** @file
Supports Fmp Capsule Dependency Expression.
+ Copyright (c) Microsoft Corporation.<BR>
Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@@ -433,8 +434,8 @@ Error: @param[in] MaxDepexSize Max size of the dependency.
@param[out] DepexSize Size of dependency.
- @retval TRUE The capsule is valid.
- @retval FALSE The capsule is invalid.
+ @retval TRUE The dependency expression is valid.
+ @retval FALSE The dependency expression is invalid.
**/
BOOLEAN
|