summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2016-04-29 13:26:12 +0200
committerLennart Poettering <lennart@poettering.net>2016-04-29 13:26:12 +0200
commit941060bf5efae24eb9879e42444e15c649973473 (patch)
tree2347735cd97d41415f9bcd22cca0d9dfd61cbd97
parente4196edfbf8edcee8771be5a71b69c95ea63d604 (diff)
path-util: document that we shouldn't add further entries to hidden_or_backup_file()
And let's add ".bak" as a generic suffix for backups, that people can use without having to register their stuff in our list.
-rw-r--r--src/basic/path-util.c16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/basic/path-util.c b/src/basic/path-util.c
index 100e3f5af2..bcf72913df 100644
--- a/src/basic/path-util.c
+++ b/src/basic/path-util.c
@@ -772,6 +772,19 @@ bool hidden_or_backup_file(const char *filename) {
if (!p)
return false;
+ /* Please, let's not add more entries to the list below. If external projects think it's a good idea to come up
+ * with always new suffixes and that everybody else should just adjust to that, then it really should be on
+ * them. Hence, in future, let's not add any more entries. Instead, let's ask those packages to instead adopt
+ * one of the generic suffixes/prefixes for hidden files or backups, possibly augmented with an additional
+ * string. Specifically: there's now:
+ *
+ * The generic suffixes "~" and ".bak" for backup files
+ * The generic prefix "." for hidden files
+ *
+ * Thus, if a new package manager "foopkg" wants its own set of "foopkg-new", "foopkg-old", "foopkg-dist" or so
+ * registered, let's refuse that and ask them to use "foopkg-new.bak" or "foopkg-new~" instead.
+ */
+
return STR_IN_SET(p + 1,
"rpmnew",
"rpmsave",
@@ -786,7 +799,8 @@ bool hidden_or_backup_file(const char *filename) {
"ucf-new",
"ucf-old",
"ucf-dist",
- "swp");
+ "swp",
+ "bak");
}
bool is_device_path(const char *path) {