[PATCH v2 0/9] Various line ending and encoding fixes

[PATCH v2 0/9] Various line ending and encoding fixes

[Leif Lindholm]

I have started looking into doing the CRLF->native conversion for EDK2,
and as part of my initial scan, I found a bunch of trivial issues that
would be easier to just fix beforehand.

Mike asked me to also do a trainling whitespace cleanup, and that will
be coming next. I will refrain from pushing this one until that one is
ready to go also, in order to isolate the non-functional-changes churn.

v2:
- Converted 8-bit characters to 7-bit replacements instead of converting
  files to UTF-8.
- Renamed/reworked Lauterbach README.txt to Readme.md.
- Added R-b:s.

Leif Lindholm (9):
  BaseTools: add missing newlines at end of files
  EmbeddedPkg: add missing newline at end of TemplateResetSystemLib.inf
  NetworkPkg: add missing newline at end of file
  EmbeddedPkg: delete outdated FdtLib README.txt
  BaseTools: fix line endings in SetupGit.py Conf files
  DynamicTablesPkg: fix .dsc line ending
  ArmPkg: ArmScmiDxe - convert .h to from 8859-x to 7-bit
  BaseTools: correct line endings for ConvertFce Python script
  EmbeddedPkg: convert Lauterbach README.txt to 7-bit safe Readme.md

 ArmPkg/Drivers/ArmScmiDxe/ArmScmiPerformanceProtocolPrivate.h           |  2 +-
 BaseTools/Conf/diff.order                                               |  2 +-
 BaseTools/Conf/gitattributes                                            |  2 +-
 BaseTools/Scripts/ConvertFceToStructurePcd.py                           | 10 +++++-----
 BaseTools/Source/Python/AutoGen/DataPipe.py                             |  2 +-
 BaseTools/Source/Python/Common/DataType.py                              |  2 +-
 BaseTools/Source/Python/Common/GlobalData.py                            |  2 +-
 DynamicTablesPkg/DynamicTablesPkg.dsc                                   |  2 +-
 EmbeddedPkg/Library/FdtLib/README.txt                                   |  1 -
 EmbeddedPkg/Library/TemplateResetSystemLib/TemplateResetSystemLib.inf   |  2 +-
 EmbeddedPkg/Scripts/LauterbachT32/README.txt                            |  7 -------
 EmbeddedPkg/Scripts/LauterbachT32/Readme.md                             | 16 ++++++++++++++++
 NetworkPkg/WifiConnectionManagerDxe/WifiConnectionManagerDxeStrings.uni |  2 +-
 13 files changed, 30 insertions(+), 22 deletions(-)
 delete mode 100644 EmbeddedPkg/Library/FdtLib/README.txt
 delete mode 100644 EmbeddedPkg/Scripts/LauterbachT32/README.txt
 create mode 100644 EmbeddedPkg/Scripts/LauterbachT32/Readme.md

Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: "Kinney, Michael D" <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sami Mujawar <Sami.Mujawar@arm.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>

-- 
2.20.1

[PATCH v2 1/9] BaseTools: add missing newlines at end of files

[Leif Lindholm]

Some scripts in Source/Python were missing newlines at end of files,
so add them.

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
Reviewed-by: Bob Feng <bob.c.feng@intel.com>
---
 BaseTools/Source/Python/AutoGen/DataPipe.py  | 2 +-
 BaseTools/Source/Python/Common/DataType.py   | 2 +-
 BaseTools/Source/Python/Common/GlobalData.py | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/BaseTools/Source/Python/AutoGen/DataPipe.py b/BaseTools/Source/Python/AutoGen/DataPipe.py
index 8b8cfd1c51eb..078bafecb45b 100755
--- a/BaseTools/Source/Python/AutoGen/DataPipe.py
+++ b/BaseTools/Source/Python/AutoGen/DataPipe.py
@@ -163,4 +163,4 @@ class MemoryDataPipe(DataPipe):
 
         self.DataContainer = {"BinCacheDest":GlobalData.gBinCacheDest}
 
-        self.DataContainer = {"EnableGenfdsMultiThread":GlobalData.gEnableGenfdsMultiThread}
\ No newline at end of file
+        self.DataContainer = {"EnableGenfdsMultiThread":GlobalData.gEnableGenfdsMultiThread}
diff --git a/BaseTools/Source/Python/Common/DataType.py b/BaseTools/Source/Python/Common/DataType.py
index 8ae1bd28fabf..5d49afb0a92a 100644
--- a/BaseTools/Source/Python/Common/DataType.py
+++ b/BaseTools/Source/Python/Common/DataType.py
@@ -532,4 +532,4 @@ PACK_CODE_BY_SIZE = {8:'=Q',
                      0:'=B',
                     16:""}
 
-TAB_COMPILER_MSFT = 'MSFT'
\ No newline at end of file
+TAB_COMPILER_MSFT = 'MSFT'
diff --git a/BaseTools/Source/Python/Common/GlobalData.py b/BaseTools/Source/Python/Common/GlobalData.py
index 8eb72aa1d6f5..74c6d0079bba 100755
--- a/BaseTools/Source/Python/Common/GlobalData.py
+++ b/BaseTools/Source/Python/Common/GlobalData.py
@@ -129,4 +129,4 @@ file_lock = None
 # Common dictionary to share platform libraries' constant Pcd
 libConstPcd = None
 # Common dictionary to share platform libraries' reference info
-Refes = None
\ No newline at end of file
+Refes = None
-- 
2.20.1

[PATCH v2 2/9] EmbeddedPkg: add missing newline at end of TemplateResetSystemLib.inf

[Leif Lindholm]

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 EmbeddedPkg/Library/TemplateResetSystemLib/TemplateResetSystemLib.inf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/EmbeddedPkg/Library/TemplateResetSystemLib/TemplateResetSystemLib.inf b/EmbeddedPkg/Library/TemplateResetSystemLib/TemplateResetSystemLib.inf
index 434f4ef298c7..cd7a9f845d53 100644
--- a/EmbeddedPkg/Library/TemplateResetSystemLib/TemplateResetSystemLib.inf
+++ b/EmbeddedPkg/Library/TemplateResetSystemLib/TemplateResetSystemLib.inf
@@ -27,4 +27,4 @@ [Packages]
 
 [LibraryClasses]
   IoLib
-  DebugLib
\ No newline at end of file
+  DebugLib
-- 
2.20.1

[PATCH v2 3/9] NetworkPkg: add missing newline at end of file

[Leif Lindholm]

Add missing newline at end of WifiConnectionManagerDxe .uni.

Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
Reviewed-by: Siyuan Fu <siyuan.fu@intel.com>
---
 NetworkPkg/WifiConnectionManagerDxe/WifiConnectionManagerDxeStrings.uni | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/NetworkPkg/WifiConnectionManagerDxe/WifiConnectionManagerDxeStrings.uni b/NetworkPkg/WifiConnectionManagerDxe/WifiConnectionManagerDxeStrings.uni
index 3f2b068fb827..187e5047aa9c 100644
--- a/NetworkPkg/WifiConnectionManagerDxe/WifiConnectionManagerDxeStrings.uni
+++ b/NetworkPkg/WifiConnectionManagerDxe/WifiConnectionManagerDxeStrings.uni
@@ -100,4 +100,4 @@
 #string STR_ADD_HIDDEN_NETWORK                #language en-US "Add Hidden Network"
 #string STR_HIDDEN_NETWORK_LIST               #language en-US "Hidden Network List"
 #string STR_REMOVE_HIDDEN_NETWORK_HELP        #language en-US ""
-#string STR_REMOVE_HIDDEN_NETWORK             #language en-US "Remove Hidden Network"
\ No newline at end of file
+#string STR_REMOVE_HIDDEN_NETWORK             #language en-US "Remove Hidden Network"
-- 
2.20.1

[PATCH v2 4/9] EmbeddedPkg: delete outdated FdtLib README.txt

[Leif Lindholm]

While looking at encoding and line ending errors, I found this file
in fact simply points to a sourceforge page which no longer exists.
Since there is nothing more to say than "this is an import of
libfdt", let's just delete it.

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 EmbeddedPkg/Library/FdtLib/README.txt | 1 -
 1 file changed, 1 deletion(-)

diff --git a/EmbeddedPkg/Library/FdtLib/README.txt b/EmbeddedPkg/Library/FdtLib/README.txt
deleted file mode 100644
index fb4010539f73..000000000000
--- a/EmbeddedPkg/Library/FdtLib/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-See: https://sourceforge.net/apps/mediawiki/tianocore/index.php?title=EmbeddedPkg/Fdt
\ No newline at end of file
-- 
2.20.1

[PATCH v2 5/9] BaseTools: fix line endings in SetupGit.py Conf files

[Leif Lindholm]

A file header license/copyright header copied around in commit
5b3e695d8ac5 ("BaseTools: add centralized location for git config files")
was missing a CR - add it in both faulty locations.

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
Reviewed-by: Bob Feng <bob.c.feng@intel.com>
---
 BaseTools/Conf/diff.order    | 2 +-
 BaseTools/Conf/gitattributes | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/BaseTools/Conf/diff.order b/BaseTools/Conf/diff.order
index 68b926ca94aa..4361817012c9 100644
--- a/BaseTools/Conf/diff.order
+++ b/BaseTools/Conf/diff.order
@@ -2,7 +2,7 @@
 # Copyright (c) 2019, Linaro Ltd. All rights reserved.
 #
 # SPDX-License-Identifier: BSD-2-Clause-Patent
-#
+#
 *.dec
 *.dsc.inc
 *.dsc
diff --git a/BaseTools/Conf/gitattributes b/BaseTools/Conf/gitattributes
index 9b6ab81a475b..58b93e9d4c27 100644
--- a/BaseTools/Conf/gitattributes
+++ b/BaseTools/Conf/gitattributes
@@ -2,7 +2,7 @@
 # Copyright (c) 2019, Linaro Ltd. All rights reserved.
 #
 # SPDX-License-Identifier: BSD-2-Clause-Patent
-#
+#
 *.efi     -diff
 *.EFI     -diff
 *.bin     -diff
-- 
2.20.1

[PATCH v2 6/9] DynamicTablesPkg: fix .dsc line ending

[Leif Lindholm]

Correct line ending in package .dsc.

Cc: Sami Mujawar <Sami.Mujawar@arm.com>
Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
Reviewed-by: Sami Mujawar <Sami.Mujawar@arm.com>
---
 DynamicTablesPkg/DynamicTablesPkg.dsc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/DynamicTablesPkg/DynamicTablesPkg.dsc b/DynamicTablesPkg/DynamicTablesPkg.dsc
index dfe6c0711105..ef958077ed48 100644
--- a/DynamicTablesPkg/DynamicTablesPkg.dsc
+++ b/DynamicTablesPkg/DynamicTablesPkg.dsc
@@ -4,7 +4,7 @@
 #  Copyright (c) 2019, Linaro Limited. All rights reserved.<BR>
 #  Copyright (c) 2019, ARM Limited. All rights reserved.<BR>
 #
-#  SPDX-License-Identifier: BSD-2-Clause-Patent
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
 #
 ##
 
-- 
2.20.1

[PATCH v2 7/9] ArmPkg: ArmScmiDxe - convert .h to from 8859-x to 7-bit

[Leif Lindholm]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 1042 bytes --]

A paragraph sign in a comment came from some ISO8859 encoding,
convert it to the word "section" to remain 7-bit safe, since we're
not actually doing anything special.

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: "Kinney, Michael D" <michael.d.kinney@intel.com>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 ArmPkg/Drivers/ArmScmiDxe/ArmScmiPerformanceProtocolPrivate.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ArmPkg/Drivers/ArmScmiDxe/ArmScmiPerformanceProtocolPrivate.h b/ArmPkg/Drivers/ArmScmiDxe/ArmScmiPerformanceProtocolPrivate.h
index ee8734bbaab0..b274b5ab2ad4 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/ArmScmiPerformanceProtocolPrivate.h
+++ b/ArmPkg/Drivers/ArmScmiDxe/ArmScmiPerformanceProtocolPrivate.h
@@ -23,7 +23,7 @@
 #define NUM_REMAIN_PERF_LEVELS(Lvls) (Lvls >> NUM_REMAIN_PERF_LEVELS_SHIFT)
 
 /** Return values for SCMI_MESSAGE_ID_PERFORMANCE_DESCRIBE_LEVELS command.
-  SCMI Spec § 4.5.2.5
+  SCMI Spec section 4.5.2.5
 **/
 typedef struct {
   UINT32 NumLevels;
-- 
2.20.1

[PATCH v2 8/9] BaseTools: correct line endings for ConvertFce Python script

[Leif Lindholm]

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
Reviewed-by: Bob Feng <bob.c.feng@intel.com>
---
 BaseTools/Scripts/ConvertFceToStructurePcd.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/BaseTools/Scripts/ConvertFceToStructurePcd.py b/BaseTools/Scripts/ConvertFceToStructurePcd.py
index 10f19dbe2f3c..89e6a727a201 100644
--- a/BaseTools/Scripts/ConvertFceToStructurePcd.py
+++ b/BaseTools/Scripts/ConvertFceToStructurePcd.py
@@ -506,8 +506,8 @@ class mainprocess(object):
     for i in range(len(info_list)-1,-1,-1):
       if len(info_list[i]) == 0:
         info_list.remove(info_list[i])
-    for i in (inf_list, title_all, header_list):
-      i.sort()
+    for i in (inf_list, title_all, header_list):
+      i.sort()
     return keys,title_all,info_list,header_list,inf_list
 
   def remove_bracket(self,List):
@@ -519,9 +519,9 @@ class mainprocess(object):
           List[List.index(i)][i.index(j)] = "|".join(tmp)
         else:
           List[List.index(i)][i.index(j)] = j
-    for i in List:
-      if type(i) == type([0,0]):
-        i.sort()
+    for i in List:
+      if type(i) == type([0,0]):
+        i.sort()
     return List
 
   def write_all(self):
-- 
2.20.1

[PATCH v2 9/9] EmbeddedPkg: convert Lauterbach README.txt to 7-bit safe Readme.md

[Leif Lindholm]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 2976 bytes --]

This file contained what looked like windows 1250 encoded single
quotation marks. Convert them to regular 's. Rework the file to
markdown format and and rename it Readme.md while we're at it.

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: "Kinney, Michael D" <michael.d.kinney@intel.com>
Signed-off-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 EmbeddedPkg/Scripts/LauterbachT32/README.txt |  7 -------
 EmbeddedPkg/Scripts/LauterbachT32/Readme.md  | 16 ++++++++++++++++
 2 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/EmbeddedPkg/Scripts/LauterbachT32/README.txt b/EmbeddedPkg/Scripts/LauterbachT32/README.txt
deleted file mode 100644
index 06602ab8763a..000000000000
--- a/EmbeddedPkg/Scripts/LauterbachT32/README.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-DXE Phase Debug
-===============
-Update the memsize variable in EfiLoadDxe.cmm for the actual amount of memory available in your system.  Allow your system to boot to the point that the DXE core is initialized (so that the System Table and Debug Information table is present in memory) and execute this script (using the toolbar button or ‘do EfiLoadDxe’ from the command area).  It will scan memory for the debug info table and load modules in it.
- 
-SEC/PEI Phase Debug
-===================
-There is no way to autodetect where these images reside so you must pass an address for the memory-mapped Firmware Volume containing these images.  To do this, enter ‘do EfiLoadFv <addr>’ where <addr> is the base address for the firmware volume containing the SEC or PEI code.  To be more efficient you may want to create a script that calls this, like MyBoardLoadSec.cmm which contains the call to EfiLoadFv.  You can them map this script to a T32 menu or toolbar button for quick access.
diff --git a/EmbeddedPkg/Scripts/LauterbachT32/Readme.md b/EmbeddedPkg/Scripts/LauterbachT32/Readme.md
new file mode 100644
index 000000000000..51d2c8da5405
--- /dev/null
+++ b/EmbeddedPkg/Scripts/LauterbachT32/Readme.md
@@ -0,0 +1,16 @@
+# DXE Phase Debug
+Update the memsize variable in EfiLoadDxe.cmm for the actual amount of memory
+available in your system.  Allow your system to boot to the point that the DXE
+core is initialized (so that the System Table and Debug Information table is
+present in memory) and execute this script (using the toolbar button or
+'do EfiLoadDxe' from the command area).  It will scan memory for the debug info
+table and load modules in it.
+
+# SEC/PEI Phase Debug
+There is no way to autodetect where these images reside so you must pass an
+address for the memory-mapped Firmware Volume containing these images.  To do
+this, enter 'do EfiLoadFv <addr>' where <addr> is the base address for the
+firmware volume containing the SEC or PEI code.  To be more efficient you may
+want to create a script that calls this, like MyBoardLoadSec.cmm which contains
+the call to EfiLoadFv.  You can them map this script to a T32 menu or toolbar
+button for quick access.
-- 
2.20.1

Re: [edk2-devel] [PATCH v2 0/9] Various line ending and encoding fixes

[Philippe Mathieu-Daudé]

On 9/19/19 6:03 PM, Leif Lindholm wrote:
> I have started looking into doing the CRLF->native conversion for EDK2,
> and as part of my initial scan, I found a bunch of trivial issues that
> would be easier to just fix beforehand.
> 
> Mike asked me to also do a trainling whitespace cleanup, and that will
> be coming next. I will refrain from pushing this one until that one is
> ready to go also, in order to isolate the non-functional-changes churn.
> 
> v2:
> - Converted 8-bit characters to 7-bit replacements instead of converting
>   files to UTF-8.
> - Renamed/reworked Lauterbach README.txt to Readme.md.
> - Added R-b:s.
> 
> Leif Lindholm (9):
>   BaseTools: add missing newlines at end of files
>   EmbeddedPkg: add missing newline at end of TemplateResetSystemLib.inf
>   NetworkPkg: add missing newline at end of file
>   EmbeddedPkg: delete outdated FdtLib README.txt
>   BaseTools: fix line endings in SetupGit.py Conf files
>   DynamicTablesPkg: fix .dsc line ending
>   ArmPkg: ArmScmiDxe - convert .h to from 8859-x to 7-bit
>   BaseTools: correct line endings for ConvertFce Python script
>   EmbeddedPkg: convert Lauterbach README.txt to 7-bit safe Readme.md

For this funny series:
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>