From 3bcff5431a120e3057e0904df12beb80401735d1 Mon Sep 17 00:00:00 2001
From: Agathiyan Bragadeesh <agathiyan.bragadeesh2@arm.com>
Date: Fri, 4 Aug 2023 14:05:28 +0100
Subject: [PATCH] Put both gitignore modifications in one script

New file also contains a header file and uses sed

Signed-off-by: Agathiyan Bragadeesh <agathiyan.bragadeesh2@arm.com>
---
 scripts/gitignore_add_generated_files.sh    | 23 -------
 scripts/gitignore_patch.sh                  | 71 +++++++++++++++++++++
 scripts/gitignore_remove_generated_files.sh | 23 -------
 3 files changed, 71 insertions(+), 46 deletions(-)
 delete mode 100755 scripts/gitignore_add_generated_files.sh
 create mode 100755 scripts/gitignore_patch.sh
 delete mode 100755 scripts/gitignore_remove_generated_files.sh

diff --git a/scripts/gitignore_add_generated_files.sh b/scripts/gitignore_add_generated_files.sh
deleted file mode 100755
index 27c3480826..0000000000
--- a/scripts/gitignore_add_generated_files.sh
+++ /dev/null
@@ -1,23 +0,0 @@
-#!/bin/bash
-
-set -eu
-
-GITIGNORES=$(find . -name ".gitignore")
-
-for GITIGNORE in $GITIGNORES; do
-    IN_GEN_BLOCK=false
-    while read -r line; do
-        if [ "$line" = "###START_COMMENTED_GENERATED_FILES###" ]; then
-            IN_GEN_BLOCK=true
-            echo "###START_GENERATED_FILES###"
-        elif [ "$line" = "###END_COMMENTED_GENERATED_FILES###" ]; then
-            IN_GEN_BLOCK=false
-            echo "###END_GENERATED_FILES###"
-        elif $IN_GEN_BLOCK ; then
-            echo "${line:1}"
-        else
-            echo "$line"
-        fi
-    done <$GITIGNORE > "$GITIGNORE.tmp"
-    mv "$GITIGNORE.tmp" $GITIGNORE
-done
diff --git a/scripts/gitignore_patch.sh b/scripts/gitignore_patch.sh
new file mode 100755
index 0000000000..d0fba6d6fa
--- /dev/null
+++ b/scripts/gitignore_patch.sh
@@ -0,0 +1,71 @@
+#!/bin/bash
+#
+# Copyright The Mbed TLS Contributors
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Purpose
+#
+# For adapting gitignore files for releases so generated files can be included.
+#
+# Usage: gitignore_add_generated_files.sh  [ -h | --help ] etc
+#
+
+set -eu
+
+print_usage()
+{
+    echo "Usage: $0"
+    echo -e "  -h|--help\t\tPrint this help."
+    echo -e "  -i|--ignore\t\tAdd generated files to the gitignores."
+    echo -e "  -u|--unignore\t\tRemove generated files from the gitignores."
+}
+
+if [[ $# -eq 0 ]]; then
+    print_usage
+    exit 1
+elif [[ $# -ge 2 ]]; then
+    echo "Too many arguments!"
+    exit 1
+fi
+
+case "$1" in
+    -i | --ignore)
+        IGNORE=true
+        ;;
+    -u | --uignore)
+        IGNORE=false
+        ;;
+    -h | --help | "")
+        print_usage
+        exit 1
+        ;;
+    *)
+        echo "Unknown argument: $1"
+        echo "run '$0 --help' for options"
+        exit 1
+esac
+
+GITIGNORES=$(find . -name ".gitignore")
+for GITIGNORE in $GITIGNORES; do
+    if $IGNORE; then 
+        sed -i '/###START_COMMENTED_GENERATED_FILES###/,/###END_COMMENTED_GENERATED_FILES###/s/^# //' $GITIGNORE
+        sed -i 's/###START_COMMENTED_GENERATED_FILES###/###START_GENERATED_FILES###/' $GITIGNORE
+        sed -i 's/###END_COMMENTED_GENERATED_FILES###/###END_GENERATED_FILES###/' $GITIGNORE
+    else
+        sed -i '/###START_GENERATED_FILES###/,/###END_GENERATED_FILES###/s/^/# /' $GITIGNORE
+        sed -i 's/###START_GENERATED_FILES###/###START_COMMENTED_GENERATED_FILES###/' $GITIGNORE
+        sed -i 's/###END_GENERATED_FILES###/###END_COMMENTED_GENERATED_FILES###/' $GITIGNORE
+    fi
+done
diff --git a/scripts/gitignore_remove_generated_files.sh b/scripts/gitignore_remove_generated_files.sh
deleted file mode 100755
index 8314b2c238..0000000000
--- a/scripts/gitignore_remove_generated_files.sh
+++ /dev/null
@@ -1,23 +0,0 @@
-#!/bin/bash
-
-set -eu
-
-GITIGNORES=$(find . -name ".gitignore")
-
-for GITIGNORE in $GITIGNORES; do
-    IN_GEN_BLOCK=false
-    while read -r line; do
-        if [ "$line" = "###START_GENERATED_FILES###" ]; then
-            IN_GEN_BLOCK=true
-            echo "###START_COMMENTED_GENERATED_FILES###"
-        elif [ "$line" = "###END_GENERATED_FILES###" ]; then
-            IN_GEN_BLOCK=false
-            echo "###END_COMMENTED_GENERATED_FILES###"
-        elif $IN_GEN_BLOCK ; then
-            echo "#$line"
-        else
-            echo "$line"
-        fi
-    done <$GITIGNORE > "$GITIGNORE.tmp"
-    mv "$GITIGNORE.tmp" $GITIGNORE
-done