Re: [edk2-BuildSpecification PATCH] Add NMAKE response file for long command lines

["Zhu, Yonghong" <yonghong.zhu@intel.com>]

Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com> 

Best Regards,
Zhu Yonghong


-----Original Message-----
From: Kinney, Michael D 
Sent: Wednesday, April 19, 2017 11:40 AM
To: edk2-devel@lists.01.org
Cc: Gao, Liming <liming.gao@intel.com>; Zhu, Yonghong <yonghong.zhu@intel.com>; Shaw, Kevin W <kevin.w.shaw@intel.com>
Subject: [edk2-BuildSpecification PATCH] Add NMAKE response file for long command lines

https://bugzilla.tianocore.org/show_bug.cgi?id=479

If an NMAKE command line is too long, then the include paths and tool flags are added to a response file that is passed to NMAKE.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
 .../82_auto-generation_process.md                    | 20 ++++++++++++++++++++
 README.md                                            |  1 +
 2 files changed, 21 insertions(+)

diff --git a/8_pre-build_autogen_stage/82_auto-generation_process.md b/8_pre-build_autogen_stage/82_auto-generation_process.md
index 4175552..b7c81ea 100644
--- a/8_pre-build_autogen_stage/82_auto-generation_process.md
+++ b/8_pre-build_autogen_stage/82_auto-generation_process.md
@@ -991,6 +991,26 @@ Quotes are also required if the path to the pre-build command contains space  or special characters.
 **********
 
+#### 8.2.4.14 NMAKE Command line limitation handling
+
+`NMAKE` is limited to command-line length of 4096 characters.  Due to 
+the large number of `/I` directives specified on command line (one per 
+include directory), the path length of `WORKSPACE` is multiplied by the 
+number of `/I` directives and can exceed this command-line length 
+limitation. When this issue occurs, the build tools pass the command 
+line options via a response file instead of directly on the command 
+line.  The contents of the response file is combination of `FLAGS` 
+options and `INC` options. If a build fails, the build tools print the response file's file location and the contents of the response file.
+
+The **build** command supports the options `-l` and `--cmd-len` to set 
+the maximum command line length.  The default value is 4096.
+
+**********
+**Note:** The following `FLAGS` options are included in the response file:
+`PP_FLAGS`, `CC_FLAGS`, `VFRPP_FLAGS`, `APP_FLAGS`, `ASLPP_FLAGS`, 
+`ASLCC_FLAGS`, and `ASM_FLAGS`.
+**********
+
 ### 8.2.5 Post processing
 
 Once all files are parsed, the build tools will do following work for each EDK diff --git a/README.md b/README.md index 2d9adb1..21bb782 100644
--- a/README.md
+++ b/README.md
@@ -205,3 +205,4 @@ Copyright (c) 2008-2017, Intel Corporation. All rights reserved.
 |            | [#472](https://bugzilla.tianocore.org/show_bug.cgi?id=472) [Build Spec] Extend macro usage in the !include statements for DSC/FDF files                                                                                                                                                                                                                             |               |
 |            | [#483](https://bugzilla.tianocore.org/show_bug.cgi?id=483) Build Spec: add description for merge Pre-build and Post-build into build process                                                                                                                                                                                                                        |               |
 |            | [#490](https://bugzilla.tianocore.org/show_bug.cgi?id=490) Build Spec: specify the alignment requirements for VOID* PCDs stored in a PCD section                                                                                                                                                                                                                    |               |
+|            | [#479](https://bugzilla.tianocore.org/show_bug.cgi?id=479) Build spec: add description for nmake long command line handling                                                                                                                                                                                                                                         |               |
--
2.6.3.windows.1