Add warning to host_protections to inform developers of the consequences of changing the enum that defines these levels.
Signed-off-by: Scott Zawalski <scottz@google.com>
git-svn-id: http://test.kernel.org/svn/autotest/trunk@2958 592f7852-d20e-0410-864c-8624ca9c26a4
diff --git a/client/common_lib/host_protections.py b/client/common_lib/host_protections.py
index 47f2378..75eb898 100644
--- a/client/common_lib/host_protections.py
+++ b/client/common_lib/host_protections.py
@@ -1,5 +1,14 @@
import enum, global_config
+# Changing this file has consequences that need to be understood.
+# Adding a protection level to the enum requires you to append your change to
+# the end of the enum or a database migration needs to be added to migrate
+# older protections to match the layout of the new enum.
+# Removing a protection level from the enum requires a database migration to
+# update the integer values in the DB and migrate hosts that use the removed
+# protection to a default protection level.
+# IF THIS IS NOT DONE HOSTS' PROTECTION LEVELS WILL BE CHANGED RANDOMLY.
+
Protection = enum.Enum('No protection', # Repair can do anything to
# this host.
'Repair software only', # repair should try to fix any