Document this hack before forgeting the purpose

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@32844 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/src/LyXVC.h b/src/LyXVC.h
index df16efcd840410c743a085b6e7a31cd35af5fa3b..e39ab9249b1d54df2c36ec4d6b75613d135c9b7e 100644 (file)
--- a/src/LyXVC.h
+++ b/src/LyXVC.h
@@ -67,6 +67,13 @@ public:
        /// Register the document as an VC file.
        bool registrer();
 
+
+       // std::string used as a return value in fucntions below are
+       // workaround to defer messages to be displayed in UI. If message()
+       // is used directly, message string is immediately overwritten
+       // by the next multiple messages on the top of the processed dispatch
+       // machinery.
+
        /// Unlock and commit changes. Returns log.
        std::string checkIn();
        /// Does the current VC supports this operation?