From d6f079b600cc88367c20b5eec5a28d28d3ceaca8 Mon Sep 17 00:00:00 2001 From: "Kinney, Michael D" Date: Sat, 28 Jul 2018 00:32:34 -0700 Subject: [PATCH 1/1] 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 Cc: Jiewen Yao Cc: Yonghong Zhu Cc: Liming Gao Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney Reviewed-by: Yonghong Zhu --- 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.
# This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License -- 2.39.2