bin: split `write_if_different()` out
authorEric Engestrom <eric.engestrom@intel.com>
Tue, 14 Aug 2018 17:02:04 +0000 (18:02 +0100)
committerEric Engestrom <eric.engestrom@intel.com>
Thu, 16 Aug 2018 11:33:35 +0000 (12:33 +0100)
Signed-off-by: Eric Engestrom <eric.engestrom@intel.com>
Reviewed-by: Dylan Baker <dylan@pnwbakers.com>
bin/git_sha1_gen.py

index 0ce839c98be39b61747ebd002857d3d4b70c9e71..77c5fa9d2951c8e10c1c2a17d13fdf2cf69582eb 100755 (executable)
@@ -28,6 +28,18 @@ def get_git_sha1():
         git_sha1 = ''
     return git_sha1
 
+def write_if_different(contents):
+    """
+    Avoid touching the output file if it doesn't need modifications
+    Useful to avoid triggering rebuilds when nothing has changed.
+    """
+    if os.path.isfile(args.output):
+        with open(args.output, 'r') as file:
+            if file.read() == contents:
+                return
+    with open(args.output, 'w') as file:
+        file.write(contents)
+
 parser = argparse.ArgumentParser()
 parser.add_argument('--output', help='File to write the #define in',
                     required=True)
@@ -39,11 +51,6 @@ if git_sha1:
                                       '..', 'src', 'git_sha1.h.in')
     with open(git_sha1_h_in_path, 'r') as git_sha1_h_in:
         new_sha1 = git_sha1_h_in.read().replace('@VCS_TAG@', git_sha1)
-        if os.path.isfile(args.output):
-            with open(args.output, 'r') as git_sha1_h:
-                if git_sha1_h.read() == new_sha1:
-                    quit()
-        with open(args.output, 'w') as git_sha1_h:
-            git_sha1_h.write(new_sha1)
+        write_if_different(new_sha1)
 else:
-    open(args.output, 'w').close()
+    write_if_different('')