Rev 5789: Clarify _CompatibleStack aims. in file:///home/vila/src/bzr/experimental/config/

[Vincent Ladeuil]

At file:///home/vila/src/bzr/experimental/config/

------------------------------------------------------------
revno: 5789
revision-id: v.ladeuil+lp at free.fr-20110512081447-1t3c11yp5zpbcb21
parent: v.ladeuil+lp at free.fr-20110511170100-ikrb0mqa79z1mfux
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: config-locks
timestamp: Thu 2011-05-12 10:14:47 +0200
message:
  Clarify _CompatibleStack aims.
-------------- next part --------------
=== modified file 'bzrlib/config.py'
--- a/bzrlib/config.py	2011-05-11 17:01:00 +0000
+++ b/bzrlib/config.py	2011-05-12 08:14:47 +0000
@@ -2542,7 +2542,14 @@
 
 
 class _CompatibleStack(Stack):
-    """Place holder for compatibility with previous design."""
+    """Place holder for compatibility with previous design.
+
+    This intended to ease the transition from the Config-based design to the
+    Stack-based design and should not be used nor relied upon by plugins.
+
+    One assumption made here is that the daughter classes will all use Stores
+    derived from LockableIniFileStore).
+    """
 
     def set(self, name, value):
         # Force a reload (assuming we use a LockableIniFileStore)