add warning about configuration variable types to session_configuration_vars.h as...

git-svn-id: svn://localhost/ardour2/branches/3.0@8433 d708f5d6-7413-0410-9779-e7cbd77b26cf

diff --git a/libs/ardour/ardour/session_configuration_vars.h b/libs/ardour/ardour/session_configuration_vars.h
index 687932da73de8cad0f11f446518573a86dcf094a..336e694e6a81d74177ed7ad8abd499518e4f6aec 100644 (file)
--- a/libs/ardour/ardour/session_configuration_vars.h
+++ b/libs/ardour/ardour/session_configuration_vars.h
@@ -17,6 +17,14 @@
 
 */
 
+/*****************************************************
+    DO NOT USE uint8_t or any other type that resolves
+    to a single char, because the value will be
+    stored incorrectly when serialized. Use int32_t
+    instead and ensure that code correctly limits
+    the value of the variable.
+*****************************************************/
+
 CONFIG_VARIABLE (CrossfadeModel, xfade_model, "xfade-model", FullCrossfade)
 CONFIG_VARIABLE (bool, auto_xfade, "auto-xfade", true)
 CONFIG_VARIABLE (float, short_xfade_seconds, "short-xfade-seconds", 0.015)