summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorBob Van Landuyt <bob@gitlab.com>2017-05-02 12:36:58 +0200
committerBob Van Landuyt <bob@gitlab.com>2017-05-02 13:49:09 +0200
commit29f200110245443454fd4358ed8c71ff8607fdd7 (patch)
tree2179c38b11279af22dc0cebfdc44c1af943e4cb3 /lib
parente2b9420c11cc5f328fc4014f5bfe66bacd3c8028 (diff)
downloadgitlab-ce-29f200110245443454fd4358ed8c71ff8607fdd7.tar.gz
Update comments
Diffstat (limited to 'lib')
-rw-r--r--lib/gitlab/database/rename_reserved_paths_migration/v1.rb8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/gitlab/database/rename_reserved_paths_migration/v1.rb b/lib/gitlab/database/rename_reserved_paths_migration/v1.rb
index 1966f5c1cec..89530082cd2 100644
--- a/lib/gitlab/database/rename_reserved_paths_migration/v1.rb
+++ b/lib/gitlab/database/rename_reserved_paths_migration/v1.rb
@@ -1,3 +1,11 @@
+# This module can be included in migrations to make it easier to rename paths
+# of `Namespace` & `Project` models certain paths would become `reserved`.
+#
+# If the way things are stored on the filesystem related to namespaces and
+# projects ever changes. Don't update this module, or anything nested in `V1`,
+# since it needs to keep functioning for all migrations using it using the state
+# that the data is in at the time. Instead, create a `V2` module that implements
+# the new way of reserving paths.
module Gitlab
module Database
module RenameReservedPathsMigration