[PATCH] GenCfgOpt.py: remove tailing space from output file

[PATCH] GenCfgOpt.py: remove tailing space from output file

[Chasel, Chiu]

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

UPD header files generated by GenCfgOpt.py may have
tailing white space from some of the UPD description in DSC,
especially when python script automatically switching lines
for long description string. This patch will always remove
tailing white space for UPD header files.

Test: Verified the patch can remove tailing space in
      output header files when UPD DSC contains intentional
      tailing white space.

Cc: Jiewen Yao <Jiewen.yao@intel.com>
Cc: Gao Liming <liming.gao@intel.com>
Cc: Zhu Yonghong <yonghong.zhu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
---
 IntelFsp2Pkg/Tools/GenCfgOpt.py | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/IntelFsp2Pkg/Tools/GenCfgOpt.py b/IntelFsp2Pkg/Tools/GenCfgOpt.py
index c9b7bc5373..7e61b00ab8 100644
--- a/IntelFsp2Pkg/Tools/GenCfgOpt.py
+++ b/IntelFsp2Pkg/Tools/GenCfgOpt.py
@@ -1,6 +1,6 @@
 ## @ GenCfgOpt.py
 #
-# Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2014 - 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 that accompanies this distribution.
 # The full text of the license may be found at
@@ -976,6 +976,13 @@ EndList
         NewTextBody.extend(OldTextBody)
         return NewTextBody
 
+    def WriteLinesWithoutTailingSpace (self, HeaderFd, Line):
+        TxtBody2 = Line.splitlines(True)
+        for Line2 in TxtBody2:
+            Line2 = Line2.rstrip()
+            Line2 += '\n'
+            HeaderFd.write (Line2)
+        return 0
     def CreateHeaderFile (self, InputHeaderFile):
         FvDir = self._FvDir
 
@@ -1175,7 +1182,7 @@ EndList
                 Index += 1
                 for Item in range(len(StructStart)):
                     if Index >= StructStartWithComment[Item] and Index <= StructEnd[Item]:
-                        HeaderFd.write (Line)
+                        self.WriteLinesWithoutTailingSpace(HeaderFd, Line)
             HeaderFd.write("#pragma pack()\n\n")
             HeaderFd.write("#endif\n")
             HeaderFd.close()
@@ -1220,7 +1227,7 @@ EndList
                 Index += 1
                 for Item in range(len(StructStart)):
                     if Index >= StructStartWithComment[Item] and Index <= StructEnd[Item]:
-                        HeaderFd.write (Line)
+                        self.WriteLinesWithoutTailingSpace(HeaderFd, Line)
         HeaderFd.write("#pragma pack()\n\n")
         HeaderFd.write("#endif\n")
         HeaderFd.close()
-- 
2.13.3.windows.1

Re: [PATCH] GenCfgOpt.py: remove tailing space from output file

[Yao, Jiewen]

Reviewed-by: jiewen.yao@intel.com

> -----Original Message-----
> From: Chiu, Chasel
> Sent: Wednesday, September 26, 2018 7:58 PM
> To: edk2-devel@lists.01.org
> Cc: Yao, Jiewen <jiewen.yao@intel.com>; Gao, Liming
> <liming.gao@intel.com>; Zhu, Yonghong <yonghong.zhu@intel.com>; Chiu,
> Chasel <chasel.chiu@intel.com>
> Subject: [PATCH] GenCfgOpt.py: remove tailing space from output file
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1212
> 
> UPD header files generated by GenCfgOpt.py may have
> tailing white space from some of the UPD description in DSC,
> especially when python script automatically switching lines
> for long description string. This patch will always remove
> tailing white space for UPD header files.
> 
> Test: Verified the patch can remove tailing space in
>       output header files when UPD DSC contains intentional
>       tailing white space.
> 
> Cc: Jiewen Yao <Jiewen.yao@intel.com>
> Cc: Gao Liming <liming.gao@intel.com>
> Cc: Zhu Yonghong <yonghong.zhu@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
> ---
>  IntelFsp2Pkg/Tools/GenCfgOpt.py | 13 ++++++++++---
>  1 file changed, 10 insertions(+), 3 deletions(-)
> 
> diff --git a/IntelFsp2Pkg/Tools/GenCfgOpt.py
> b/IntelFsp2Pkg/Tools/GenCfgOpt.py
> index c9b7bc5373..7e61b00ab8 100644
> --- a/IntelFsp2Pkg/Tools/GenCfgOpt.py
> +++ b/IntelFsp2Pkg/Tools/GenCfgOpt.py
> @@ -1,6 +1,6 @@
>  ## @ GenCfgOpt.py
>  #
> -# Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>
> +# Copyright (c) 2014 - 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 that accompanies this
> distribution.
>  # The full text of the license may be found at
> @@ -976,6 +976,13 @@ EndList
>          NewTextBody.extend(OldTextBody)
>          return NewTextBody
> 
> +    def WriteLinesWithoutTailingSpace (self, HeaderFd, Line):
> +        TxtBody2 = Line.splitlines(True)
> +        for Line2 in TxtBody2:
> +            Line2 = Line2.rstrip()
> +            Line2 += '\n'
> +            HeaderFd.write (Line2)
> +        return 0
>      def CreateHeaderFile (self, InputHeaderFile):
>          FvDir = self._FvDir
> 
> @@ -1175,7 +1182,7 @@ EndList
>                  Index += 1
>                  for Item in range(len(StructStart)):
>                      if Index >= StructStartWithComment[Item] and
> Index <= StructEnd[Item]:
> -                        HeaderFd.write (Line)
> +                        self.WriteLinesWithoutTailingSpace(HeaderFd,
> Line)
>              HeaderFd.write("#pragma pack()\n\n")
>              HeaderFd.write("#endif\n")
>              HeaderFd.close()
> @@ -1220,7 +1227,7 @@ EndList
>                  Index += 1
>                  for Item in range(len(StructStart)):
>                      if Index >= StructStartWithComment[Item] and
> Index <= StructEnd[Item]:
> -                        HeaderFd.write (Line)
> +                        self.WriteLinesWithoutTailingSpace(HeaderFd,
> Line)
>          HeaderFd.write("#pragma pack()\n\n")
>          HeaderFd.write("#endif\n")
>          HeaderFd.close()
> --
> 2.13.3.windows.1