From 40d118ce4acc5a8e53bb6bef519f56fedf406ce3 Mon Sep 17 00:00:00 2001
From: Aaron Franke <arnfranke@yahoo.com>
Date: Tue, 28 Jul 2020 02:56:05 -0400
Subject: [PATCH] Fix incorrect comments in file formatting script

(cherry picked from commit 05a418f9e648191e45fbc8e4cd43cd0c1c56b56f)
---
 misc/scripts/file_format.sh | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/misc/scripts/file_format.sh b/misc/scripts/file_format.sh
index 773999cf0c1..c570ec23a7b 100755
--- a/misc/scripts/file_format.sh
+++ b/misc/scripts/file_format.sh
@@ -31,12 +31,12 @@ while IFS= read -rd '' f; do
     elif [[ "$f" == "platform/android/java/lib/src/com/google"* ]]; then
         continue
     fi
-    # Ensures that files are UTF-8 formatted.
+    # Ensure that files are UTF-8 formatted.
     recode UTF-8 "$f" 2> /dev/null
-    # Ensures that files have LF line endings.
+    # Ensure that files have LF line endings and do not contain a BOM.
     dos2unix "$f" 2> /dev/null
-    # Remove trailing space characters.
-    # -l option handles newlines conveniently and seems to also get rid of BOMs.
+    # Remove trailing space characters and ensures that files end
+    # with newline characters. -l option handles newlines conveniently.
     perl -i -ple 's/\s*$//g' "$f"
     # Remove the character sequence "== true" if it has a leading space.
     perl -i -pe 's/\x20== true//g' "$f"