From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <yonghong.zhu@intel.com>
Received-SPF: Pass (sender SPF authorized) identity=mailfrom;
 client-ip=134.134.136.65; helo=mga03.intel.com;
 envelope-from=yonghong.zhu@intel.com; receiver=edk2-devel@lists.01.org 
Received: from mga03.intel.com (mga03.intel.com [134.134.136.65])
 (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 311E120971753
 for <edk2-devel@lists.01.org>; Wed, 30 May 2018 17:56:39 -0700 (PDT)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga001.fm.intel.com ([10.253.24.23])
 by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 30 May 2018 17:56:38 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.49,462,1520924400"; d="scan'208";a="59975566"
Received: from shwdeopenpsi168.ccr.corp.intel.com ([10.239.158.129])
 by fmsmga001.fm.intel.com with ESMTP; 30 May 2018 17:56:34 -0700
From: Yonghong Zhu <yonghong.zhu@intel.com>
To: edk2-devel@lists.01.org
Cc: Liming Gao <liming.gao@intel.com>,
 Michael Kinney <michael.d.kinney@intel.com>,
 Kevin W Shaw <kevin.w.shaw@intel.com>
Date: Thu, 31 May 2018 08:56:22 +0800
Message-Id: <1527728184-1736-3-git-send-email-yonghong.zhu@intel.com>
X-Mailer: git-send-email 2.6.1.windows.1
In-Reply-To: <1527728184-1736-1-git-send-email-yonghong.zhu@intel.com>
References: <1527728184-1736-1-git-send-email-yonghong.zhu@intel.com>
Subject: [Patch 3/5] DSC Spec: Add !error statement support
X-BeenThere: edk2-devel@lists.01.org
X-Mailman-Version: 2.1.26
Precedence: list
List-Id: EDK II Development  <edk2-devel.lists.01.org>
List-Unsubscribe: <https://lists.01.org/mailman/options/edk2-devel>,
 <mailto:edk2-devel-request@lists.01.org?subject=unsubscribe>
List-Archive: <http://lists.01.org/pipermail/edk2-devel/>
List-Post: <mailto:edk2-devel@lists.01.org>
List-Help: <mailto:edk2-devel-request@lists.01.org?subject=help>
List-Subscribe: <https://lists.01.org/mailman/listinfo/edk2-devel>,
 <mailto:edk2-devel-request@lists.01.org?subject=subscribe>
X-List-Received-Date: Thu, 31 May 2018 00:56:39 -0000

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
---
 2_dsc_overview/22_build_description_file_format.md | 21 +++++++++++++---
 .../33_platform_dsc_definition.md                  | 28 ++++++++++++++++++++++
 README.md                                          |  1 +
 3 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/2_dsc_overview/22_build_description_file_format.md b/2_dsc_overview/22_build_description_file_format.md
index 9c5c9f8..1ce890f 100644
--- a/2_dsc_overview/22_build_description_file_format.md
+++ b/2_dsc_overview/22_build_description_file_format.md
@@ -1,9 +1,9 @@
 <!--- @file
   2.2 Build Description File Format
 
-  Copyright (c) 2006-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2006-2018, Intel Corporation. All rights reserved.<BR>
 
   Redistribution and use in source (original document form) and 'compiled'
   forms (converted to PDF, epub, HTML and other formats) with or without
   modification, are permitted provided that the following conditions are met:
 
@@ -641,11 +641,26 @@ The following are examples of conditional directives.
 !else
   # The strings do not match exactly
 !endif
 ```
 
-### 2.2.9 Expressions
+### 2.2.9 !error Statement
+
+The `!error` statement may appear within any section of EDK II DSC file. The
+argument of this statement is an error message, it causes build tool to stop
+at the location where the statement is encountered and error message following
+the `!error` statement is output as a message.
+
+The following example show the valid usage of the `!error` statement.
+
+```ini
+!if $(FEATURE_ENABLE) == TRUE
+  !error "unsupported feature!"
+!endif
+```
+
+### 2.2.10 Expressions
 
 Expressions can be used in conditional directive comparison statements and in
 value fields for Macros and PCDs in the DSC and FDF files.
 
 Refer to the EDK II Expression Syntax Specification for additional information.
@@ -702,11 +717,11 @@ names specified on the command line or come from the `Conf/target.txt` file.
 
 For logical expressions, any non-zero value must be considered `TRUE`.
 
 Invalid expressions must cause a build break with an appropriate error message.
 
-### 2.2.10 Section Handling
+### 2.2.11 Section Handling
 
 The DSC file parsing routines must process the sections so that common
 architecture sections are logically merged with the architecturally specific
 sections. The architectural sections need to be processed so that they are
 logically after the common section. It is recommended that EDK II developers
diff --git a/3_edk_ii_dsc_file_format/33_platform_dsc_definition.md b/3_edk_ii_dsc_file_format/33_platform_dsc_definition.md
index 313fc20..d99e20b 100644
--- a/3_edk_ii_dsc_file_format/33_platform_dsc_definition.md
+++ b/3_edk_ii_dsc_file_format/33_platform_dsc_definition.md
@@ -734,5 +734,33 @@ as well as to define new entries.
 **********
 **Note:** The extension used in the example, "mak", is just a three
 character extension, and would not processed by `make` or `nmake` commands. It
 might just as well have been "foo".
 **********
+
+### 3.3.5 !error Statements
+
+Use of this statement is optional.
+
+#### Summary
+This section defines the `!error` statement in EDK II Platform (DSC) files.
+This statement is used to cause build tool to stop at the location where the
+statement is encountered and error message following the `!error` statement
+is output as a message.
+
+#### Prototype
+
+`<ErrorStatement> ::= <TS> "!error" <MTS> <ErrorMessage> <EOL>`
+`<ErrorMessage>   ::= <AsciiString>`
+
+#### Parameters
+
+**_ErrorMessage_**
+
+It should in the same line with `!error` statement, and it can consist of several
+words not necessarily in quotes.
+
+#### Example (EDK II DSC)
+
+```
+!error "unsupported feature!"
+```
diff --git a/README.md b/README.md
index 3e14b34..54d50cb 100644
--- a/README.md
+++ b/README.md
@@ -190,5 +190,6 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved.
 |            | Update Skuid value to support Hex number                                                                                                                                                                                                                                                     |                |
 |            | Add flexible PCD value format into spec                                                                                                                                                                                                                                                      |                |
 |            | Add syntax to support SKU ID inherit from another SKU ID                                                                                                                                                                                                                                     |                |
 |            | Add DefaultStores section to describe the default setting                                                                                                                                                                                                                                    |                |
 |            | Add structure PCD field value assignment syntax                                                                                                                                                                                                                                              |                |
+|            | Add !error statement section                                                                                                                                                                                                                                                                 |                |
-- 
2.6.1.windows.1