X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXVC.h;h=b81269f4473c3873cecc1a9e88c4773c1ecbd29a;hb=2098f1d8c20d51e63e670bcdc9da8996068975bf;hp=e220bde9251a006ca043cbb4d5d57f4f89728c6b;hpb=d86cae50f8156ae3adcd6786da48ee1a16f3fd93;p=lyx.git

diff --git a/src/LyXVC.h b/src/LyXVC.h
index e220bde925..b81269f447 100644
--- 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 functions 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?
@@ -107,7 +114,7 @@ public:
 
 	/**
 	 * We do not support this generally. In RCS/SVN file read-only flag
-         * is often connected with locking state and one has to be careful to
+	 * is often connected with locking state and one has to be careful to
 	 * keep things in synchro once we would allow user to toggle
 	 * read-only flags.
 	 */
@@ -116,12 +123,25 @@ public:
 	/// Is the document under administration by VCS?
 	bool inUse() const;
 
+	/// FIXME resurrect version once we add version info
+	/// into SVN. RCS parser is already prepared.
 	/// Returns the version number.
 	//std::string const & version() const;
 	/// Returns the version number.
 	std::string const versionString() const;
 
-	/// Returns the userid of the person who has locked the doc.
+	/**
+	 * Returns the userid of the person who has locked the doc.
+	 * FIXME This property is descendant from the original VCS
+	 * and used in RCS for user id or "unlocked" strings.
+	 * It would be problem to use this under SVN since getting
+	 * the locker would need connection to server any time we
+	 * load document. SVN currently (mis)uses this as a signal
+	 * for locking state, as we do not have API for vcstatus().
+	 * The RCS code for user id parsing is working but we don't display
+	 * it anywhere. One possibility is to provide proper vcstatus()
+	 * interface and kill the whole locker thing.
+	 */
 	std::string const & locker() const;
 
 private: