Never prepend '.' to $KCONFIG_CONFIG.old

ulfalizer · ulfalizer · commit 4fed39d9271c · 2019-04-30T22:35:40.000+02:00
In retrospect, trying to be "helpful" by saving the old version of a $KCONFIG_CONFIG that does not start with a '.' as e.g. '.config.old' instead of 'config.old' is a bad idea, because it means that scripts can't rely on the backup file simply being called $KCONFIG_CONFIG.old. I spotted this causing compatibility issues in automate-lfs/jhalfs@a645174. I had Vim backup files and the like in mind originally, but .config.old is much more likely to be processed by scripts. This is a small backwards compatibility break, so the major version will be increased to 11.
diff --git a/kconfiglib.py b/kconfiglib.py
@@ -529,8 +529,7 @@ def my_other_fn(kconf, name, arg_1, arg_2, ...):
 
 # Get rid of some attribute lookups. These are obvious in context.
 from glob import iglob
-from os.path import dirname, exists, expandvars, isabs, islink, join, \
-                    relpath, split
+from os.path import dirname, exists, expandvars, isabs, islink, join, relpath
 
 
 # File layout:
@@ -1358,12 +1357,11 @@ def write_config(self, filename=None,
 
         save_old (default: True):
           If True and <filename> already exists, a copy of it will be saved to
-          .<filename>.old in the same directory before the new configuration is
-          written. The leading dot is added only if the filename doesn't
-          already start with a dot.
+          <filename>.old in the same directory before the new configuration is
+          written.
 
-          Errors are silently ignored if .<filename>.old cannot be written
-          (e.g. due to being a directory).
+          Errors are silently ignored if <filename>.old cannot be written (e.g.
+          due to being a directory).
 
         verbose (default: True):
           If True and filename is None (automatically infer configuration
@@ -5886,29 +5884,24 @@ def _touch_dep_file(path, sym_name):
 
 
 def _save_old(path):
-    # See write_config()
+    # See write_config(). os.replace() would be nice here, but it's Python 3
+    # (3.3+) only.
 
-    dirname, basename = split(path)
-    backup = join(dirname,
-                  basename + ".old" if basename.startswith(".")
-                      else "." + basename + ".old")
-
-    # os.replace() would be nice here, but it's Python 3 (3.3+) only
     try:
-        # Use copyfile() if 'path' is a symlink. The intention is probably to
-        # overwrite the target in that case.
         if os.name == "posix" and not islink(path):
-            # Will remove .<filename>.old if it already exists on POSIX
+            # Will remove <filename>.old if it already exists on POSIX
             # systems
-            os.rename(path, backup)
+            os.rename(path, path + ".old")
         else:
-            # Only import as needed, to save some startup time
+            # Use copyfile() if 'path' is a symlink. The intention is probably
+            # to overwrite the target in that case. Only import shutil as
+            # needed, to save some startup time.
             import shutil
-            shutil.copyfile(path, backup)
+            shutil.copyfile(path, path + ".old")
     except:
         # Ignore errors from 'filename' missing as well as other errors. The
-        # backup file is more of a nice-to-have, and not worth erroring out
-        # over e.g. if .<filename>.old happens to be a directory.
+        # <filename>.old file is usually more of a nice-to-have, and not worth
+        # erroring out over e.g. if <filename>.old happens to be a directory.
         pass
 
 
