V3: Update the build option help info

when MAX_CONCURRENT_THREAD_NUMBER is not specified, tool will
automatically detect number of processor threads.

Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=775
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
---
 BaseTools/Conf/target.template         | 14 +++++++++-----
 BaseTools/Source/Python/build/build.py |  3 ++-
 2 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/BaseTools/Conf/target.template b/BaseTools/Conf/target.template
index 787fc64..e5c31fe 100644
--- a/BaseTools/Conf/target.template
+++ b/BaseTools/Conf/target.template
@@ -1,7 +1,7 @@
 #
-#  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
+#  Copyright (c) 2006 - 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
 #  which accompanies this distribution.  The full text of the license may be found at
 #  http://opensource.org/licenses/bsd-license.php
@@ -57,14 +57,18 @@ TOOL_CHAIN_CONF       = Conf/tools_def.txt
 #  TAGNAME               List      Optional   Specify the name(s) of the tools_def.txt TagName to use.
 #                                             If not specified, all applicable TagName tools will be
 #                                             used for the build.  The list uses space character separation.
 TOOL_CHAIN_TAG        = MYTOOLS
 
-# MAX_CONCURRENT_THREAD_NUMBER  NUMBER  Optional  The number of concurrent threads. Recommend to set this
-#                                                 value to one more than the number of your compurter
-#                                                 cores or CPUs. Less than 2 means disable multithread build.
-MAX_CONCURRENT_THREAD_NUMBER = 1
+# MAX_CONCURRENT_THREAD_NUMBER  NUMBER  Optional  The number of concurrent threads. If not specified or set
+#                                                 to zero, tool automatically detect number of processor
+#                                                 threads. Recommend to set this value to one less than the
+#                                                 number of your computer cores or CPUs. When value set to 1,
+#                                                 means disable multi-thread build, value set to more than 1,
+#                                                 means user specify the thread number to build. Not specify
+#                                                 the default value in this file.
+# MAX_CONCURRENT_THREAD_NUMBER = 1
 
 
 # BUILD_RULE_CONF  Filename Optional  Specify the file name to use for the build rules that are followed
 #                                     when generating Makefiles. If not specified, the file: 
 #                                     WORKSPACE/Conf/build_rule.txt will be used
diff --git a/BaseTools/Source/Python/build/build.py b/BaseTools/Source/Python/build/build.py
index 24f9962..06a89ed 100644
--- a/BaseTools/Source/Python/build/build.py
+++ b/BaseTools/Source/Python/build/build.py
@@ -2321,11 +2321,12 @@ def MyOptionParser():
         help="Using the Tool Chain Tagname to build the platform, overriding target.txt's TOOL_CHAIN_TAG definition.")
     Parser.add_option("-x", "--sku-id", action="callback", type="string", dest="SkuId", callback=SingleCheckCallback,
         help="Using this name of SKU ID to build the platform, overriding SKUID_IDENTIFIER in DSC file.")
 
     Parser.add_option("-n", action="callback", type="int", dest="ThreadNumber", callback=SingleCheckCallback,
-        help="Build the platform using multi-threaded compiler. The value overrides target.txt's MAX_CONCURRENT_THREAD_NUMBER. Less than 2 will disable multi-thread builds.")
+        help="Build the platform using multi-threaded compiler. The value overrides target.txt's MAX_CONCURRENT_THREAD_NUMBER. When value is set to 0, tool automatically detect number of "\
+             "processor threads, set value to 1 means disable multi-thread build, and set value more than 1  means user specify the threads number to build.")
 
     Parser.add_option("-f", "--fdf", action="callback", type="string", dest="FdfFile", callback=SingleCheckCallback,
         help="The name of the FDF file to use, which overrides the setting in the DSC file.")
     Parser.add_option("-r", "--rom-image", action="append", type="string", dest="RomImage", default=[],
         help="The name of FD to be generated. The name must be from [FD] section in FDF file.")
-- 
2.6.1.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Reviewed-by: Liming Gao <liming.gao@intel.com>

>-----Original Message-----
>From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
>Yonghong Zhu
>Sent: Thursday, February 08, 2018 9:50 AM
>To: edk2-devel@lists.01.org
>Subject: [edk2] [Patch] BaseTools: not specified value of
>MAX_CONCURRENT_THREAD_NUMBER
>
>V3: Update the build option help info
>
>when MAX_CONCURRENT_THREAD_NUMBER is not specified, tool will
>automatically detect number of processor threads.
>
>Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=775
>Contributed-under: TianoCore Contribution Agreement 1.1
>Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
>---
> BaseTools/Conf/target.template         | 14 +++++++++-----
> BaseTools/Source/Python/build/build.py |  3 ++-
> 2 files changed, 11 insertions(+), 6 deletions(-)
>
>diff --git a/BaseTools/Conf/target.template
>b/BaseTools/Conf/target.template
>index 787fc64..e5c31fe 100644
>--- a/BaseTools/Conf/target.template
>+++ b/BaseTools/Conf/target.template
>@@ -1,7 +1,7 @@
> #
>-#  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
>+#  Copyright (c) 2006 - 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
> #  which accompanies this distribution.  The full text of the license may be
>found at
> #  http://opensource.org/licenses/bsd-license.php
>@@ -57,14 +57,18 @@ TOOL_CHAIN_CONF       = Conf/tools_def.txt
> #  TAGNAME               List      Optional   Specify the name(s) of the tools_def.txt
>TagName to use.
> #                                             If not specified, all applicable TagName tools will be
> #                                             used for the build.  The list uses space character
>separation.
> TOOL_CHAIN_TAG        = MYTOOLS
>
>-# MAX_CONCURRENT_THREAD_NUMBER  NUMBER  Optional  The number
>of concurrent threads. Recommend to set this
>-#                                                 value to one more than the number of your
>compurter
>-#                                                 cores or CPUs. Less than 2 means disable
>multithread build.
>-MAX_CONCURRENT_THREAD_NUMBER = 1
>+# MAX_CONCURRENT_THREAD_NUMBER  NUMBER  Optional  The number
>of concurrent threads. If not specified or set
>+#                                                 to zero, tool automatically detect number of
>processor
>+#                                                 threads. Recommend to set this value to one less
>than the
>+#                                                 number of your computer cores or CPUs. When
>value set to 1,
>+#                                                 means disable multi-thread build, value set to
>more than 1,
>+#                                                 means user specify the thread number to build.
>Not specify
>+#                                                 the default value in this file.
>+# MAX_CONCURRENT_THREAD_NUMBER = 1
>
>
> # BUILD_RULE_CONF  Filename Optional  Specify the file name to use for the
>build rules that are followed
> #                                     when generating Makefiles. If not specified, the file:
> #                                     WORKSPACE/Conf/build_rule.txt will be used
>diff --git a/BaseTools/Source/Python/build/build.py
>b/BaseTools/Source/Python/build/build.py
>index 24f9962..06a89ed 100644
>--- a/BaseTools/Source/Python/build/build.py
>+++ b/BaseTools/Source/Python/build/build.py
>@@ -2321,11 +2321,12 @@ def MyOptionParser():
>         help="Using the Tool Chain Tagname to build the platform, overriding
>target.txt's TOOL_CHAIN_TAG definition.")
>     Parser.add_option("-x", "--sku-id", action="callback", type="string",
>dest="SkuId", callback=SingleCheckCallback,
>         help="Using this name of SKU ID to build the platform, overriding
>SKUID_IDENTIFIER in DSC file.")
>
>     Parser.add_option("-n", action="callback", type="int",
>dest="ThreadNumber", callback=SingleCheckCallback,
>-        help="Build the platform using multi-threaded compiler. The value
>overrides target.txt's MAX_CONCURRENT_THREAD_NUMBER. Less than 2 will
>disable multi-thread builds.")
>+        help="Build the platform using multi-threaded compiler. The value
>overrides target.txt's MAX_CONCURRENT_THREAD_NUMBER. When value is
>set to 0, tool automatically detect number of "\
>+             "processor threads, set value to 1 means disable multi-thread build,
>and set value more than 1  means user specify the threads number to build.")
>
>     Parser.add_option("-f", "--fdf", action="callback", type="string",
>dest="FdfFile", callback=SingleCheckCallback,
>         help="The name of the FDF file to use, which overrides the setting in the
>DSC file.")
>     Parser.add_option("-r", "--rom-image", action="append", type="string",
>dest="RomImage", default=[],
>         help="The name of FD to be generated. The name must be from [FD]
>section in FDF file.")
>--
>2.6.1.windows.1
>
>_______________________________________________
>edk2-devel mailing list
>edk2-devel@lists.01.org
>https://lists.01.org/mailman/listinfo/edk2-devel
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel