From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 2EC332195408C for ; Mon, 17 Apr 2017 18:08:19 -0700 (PDT) Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 Apr 2017 18:08:18 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.37,217,1488873600"; d="scan'208";a="88649778" Received: from mdkinney-mobl.amr.corp.intel.com ([10.241.98.47]) by orsmga005.jf.intel.com with ESMTP; 17 Apr 2017 18:08:19 -0700 From: Michael Kinney To: edk2-devel@lists.01.org Cc: Liming Gao , Yonghong Zhu , Kevin W Shaw Date: Mon, 17 Apr 2017 18:08:16 -0700 Message-Id: <1492477696-44816-2-git-send-email-michael.d.kinney@intel.com> X-Mailer: git-send-email 2.6.3.windows.1 In-Reply-To: <1492477696-44816-1-git-send-email-michael.d.kinney@intel.com> References: <1492477696-44816-1-git-send-email-michael.d.kinney@intel.com> Subject: [edk2-DscSpecification PATCH] Declare Pre/Post build scripts in [Defines] section X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 18 Apr 2017 01:08:19 -0000 https://bugzilla.tianocore.org/show_bug.cgi?id=484 Add support for PREBUILD and POSTBUILD defines in the [Defines] section of an DSC to declare scripts that are executed before and after normal DSC/FDF file processing. Cc: Liming Gao Cc: Yonghong Zhu Cc: Kevin W Shaw Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael Kinney --- 2_dsc_overview/23_[defines]_section_processing.md | 11 +++++++++++ 3_edk_ii_dsc_file_format/35_[defines]_section.md | 2 ++ README.md | 1 + 3 files changed, 14 insertions(+) diff --git a/2_dsc_overview/23_[defines]_section_processing.md b/2_dsc_overview/23_[defines]_section_processing.md index 7f3c56d..f44ec57 100644 --- a/2_dsc_overview/23_[defines]_section_processing.md +++ b/2_dsc_overview/23_[defines]_section_processing.md @@ -53,6 +53,17 @@ The format for entries in this section is: `Name = Value` +If the `PREBUILD` and/or `POSTBUILD` entries are specified, value must be a +tool that can be executed. If the value contains space characters, then the +value must be a quoted string. The `build` tool suspends processing of the DSC +file if the `PREBUILD` entry is present, calls the script, and either terminates +or continues processing the DSC file depending on the exit code from the script. +If the `POSTBUILD` entry is present, prior to the successful `build` exit, the +script is called. If the script fails (non-zero exit code from the script) +`build` terminates immediately using the exit code returned from the script, +otherwise, `build` terminates normally. The author of the script is responsible +for ensuring that the script terminates with a non-zero exit code when it fails. + All defined elements of the DSC file's `[Defines]` section are valid when parsing the FDF file. The these elements must be treated as Macros when using them in other sections of the DSC and FDF file, as in $(PLATFORM_NAME). diff --git a/3_edk_ii_dsc_file_format/35_[defines]_section.md b/3_edk_ii_dsc_file_format/35_[defines]_section.md index 0785061..3ac6847 100644 --- a/3_edk_ii_dsc_file_format/35_[defines]_section.md +++ b/3_edk_ii_dsc_file_format/35_[defines]_section.md @@ -125,6 +125,8 @@ The `!include` statement may be used in a `[Defines]` section. [ "VPD_TOOL_GUID" ] [ "PCD_VAR_CHECK_GENERATION" ] + [ "PREBUILD" {} {} ] + [ "POSTBUILD" {} {} ] [ ] * * diff --git a/README.md b/README.md index 64bf2b7..31eebe4 100644 --- a/README.md +++ b/README.md @@ -178,3 +178,4 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved. | | Added new system environment variables used by the build system. | | | 1.27 | Convert to GitBooks | April 2017 | | | [#351](https://bugzilla.tianocore.org/show_bug.cgi?id=351) [DSC Spec] Extend macro usage in the !include statement | | +| | [#484](https://bugzilla.tianocore.org/show_bug.cgi?id=484) DSC spec: support Prebuild and Postbuild in the [Defines] section | | -- 2.6.3.windows.1