[edk2] [staging/FmpDevicePkg-master 6/8] BaseTools/Capsule: Update file header with tool limitations

Kinney, Michael D posted 8 patches 5 years, 1 month ago
[edk2] [staging/FmpDevicePkg-master 6/8] BaseTools/Capsule: Update file header with tool limitations
Posted by Kinney, Michael D 5 years, 1 month ago
Update file header to state that the tool does not support:
* Multiple payloads
* Drivers
* Vendor code bytes


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>
 BaseTools/Source/Python/Capsule/GenerateCapsule.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

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

edk2-devel mailing list