summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKinney, Michael D <michael.d.kinney@intel.com>2018-07-28 00:32:34 -0700
committerStar Zeng <star.zeng@intel.com>2018-08-03 08:08:32 +0800
commitb2df415a77ebb7ca88899716018b336ef70d1b8e (patch)
tree144e2d5520c7c056f9653bb3d7c9af4db5fed1c4
parent128c591b0197ada32748008e1345b504bdc562ab (diff)
downloadedk2-b2df415a77ebb7ca88899716018b336ef70d1b8e.tar.gz
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> (cherry picked from commit d6f079b600cc88367c20b5eec5a28d28d3ceaca8)
-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