summaryrefslogtreecommitdiffstats
path: root/BaseTools
diff options
context:
space:
mode:
authorKinney, Michael D <michael.d.kinney@intel.com>2018-07-28 00:32:34 -0700
committerKinney, Michael D <michael.d.kinney@intel.com>2018-08-02 14:35:27 -0700
commitd6f079b600cc88367c20b5eec5a28d28d3ceaca8 (patch)
tree3b1bccb4a4dd56e261098ef8a444a6ac7fac6ba3 /BaseTools
parentff307fba9857145875839fdca33c95236e238153 (diff)
downloadedk2-d6f079b600cc88367c20b5eec5a28d28d3ceaca8.tar.gz
edk2-d6f079b600cc88367c20b5eec5a28d28d3ceaca8.tar.bz2
edk2-d6f079b600cc88367c20b5eec5a28d28d3ceaca8.zip
BaseTools/Capsule: Update file header with tool limitations
Update file header to state that the tool does not support: * Multiple payloads * Drivers * Vendor code bytes https://bugzilla.tianocore.org/show_bug.cgi?id=1031 Cc: Sean Brogan <sean.brogan@microsoft.com> Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Yonghong Zhu <yonghong.zhu@intel.com> Cc: Liming Gao <liming.gao@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com>
Diffstat (limited to 'BaseTools')
-rw-r--r--BaseTools/Source/Python/Capsule/GenerateCapsule.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/BaseTools/Source/Python/Capsule/GenerateCapsule.py b/BaseTools/Source/Python/Capsule/GenerateCapsule.py
index 76426dcf66..d829000849 100644
--- a/BaseTools/Source/Python/Capsule/GenerateCapsule.py
+++ b/BaseTools/Source/Python/Capsule/GenerateCapsule.py
@@ -1,6 +1,17 @@
## @file
# Generate a capsule.
#
+# This tool generates a UEFI Capsule around an FMP Capsule. The capsule payload
+# be signed using signtool or OpenSSL and if it is signed the signed content
+# includes an FMP Payload Header.
+#
+# This tool is intended to be used to generate UEFI Capsules to update the
+# system firmware or device firmware for integrated devices. In order to
+# keep the tool as simple as possible, it has the following limitations:
+# * Do not support multiple payloads in a capsule.
+# * Do not support optional drivers in a capsule.
+# * Do not support vendor code bytes in a capsule.
+#
# Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License