Fix typo.

[lyx.git] / src / LyXVC.h

diff --git a/src/LyXVC.h b/src/LyXVC.h
index 09998c952f98b14480bc1a6356c39c195e8006e1..e3db3cbe5eb175407a29ea962c4e91fb65d6fc5b 100644 (file)
--- a/src/LyXVC.h
+++ b/src/LyXVC.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes

  *
  * Full author contact details are available in file CREDITS.
  */
  *
  * Full author contact details are available in file CREDITS.
  */


@@ -26,15 +26,14 @@ class Buffer;
 
 /** Version Control for LyX.
     This is the class giving the verison control features to LyX. It is
 
 /** Version Control for LyX.
     This is the class giving the verison control features to LyX. It is

-    intended to support different kinds of version control, but at this point
-    we will only support RCS. Later CVS is a likely candidate for support.
+    intended to support different kinds of version control.

     The support in LyX is based loosely upon the version control in GNU Emacs,
     The support in LyX is based loosely upon the version control in GNU Emacs,

-    but is not as extensive as that one. See examples/VC.lyx for a simple
+    but is not as extensive as that one. See Extended Manual for a simple

     tutorial and manual for the use of the version control system in LyX.
 
     LyXVC use this algorithm when it searches for VC files:
     tutorial and manual for the use of the version control system in LyX.
 
     LyXVC use this algorithm when it searches for VC files:

-    for RCS it searches for <filename>,v and RCS/<filename>,v similar
-    should be done for CVS. By doing this there doesn't need to be any
+    for RCS it searches for <filename>,v and RCS/<filename>,v similarly
+    CVS/Entries for cvs and .svn/entries. By doing this there doesn't need to be any

     special support for VC in the lyx format, and this is especially good
     when the lyx format will be a subset of LaTeX.
 */
     special support for VC in the lyx format, and this is especially good
     when the lyx format will be a subset of LaTeX.
 */


@@ -46,9 +45,9 @@ public:
        ~LyXVC();
        /** Not a good name perhaps. This function should be called whenever
          LyX loads a file. This function then checks for a master VC file (for
        ~LyXVC();
        /** Not a good name perhaps. This function should be called whenever
          LyX loads a file. This function then checks for a master VC file (for

-         RCS this is *,v or RCS/ *,v ; for CVS this is CVS/Entries) if this
-         file is found, the loaded file is assumed to be under controll by VC
-         (only RCS and CVS so far), and the appropiate actions is taken.
+         RCS this is *,v or RCS/ *,v ; for CVS this is CVS/Entries and .svn/entries
+         for SVN) if this file or entry is found, the loaded file is assumed to be
+         under controll by VC, and the appropiate actions is taken.

          Returns true if the file is under control by a VCS.
          */
        bool file_found_hook(support::FileName const & fn);
          Returns true if the file is under control by a VCS.
          */
        bool file_found_hook(support::FileName const & fn);


@@ -66,18 +65,31 @@ public:
        void setBuffer(Buffer *);
 
        /// Register the document as an VC file.
        void setBuffer(Buffer *);
 
        /// Register the document as an VC file.

-       void registrer();
+       bool registrer();

 
 

-       /// Unlock and commit changes.
-       void checkIn();
+       /// Unlock and commit changes. Returns log.
+       std::string checkIn();

        /// Does the current VC supports this operation?
        bool checkInEnabled();
 
        /// Does the current VC supports this operation?
        bool checkInEnabled();
 

-       /// Lock and prepare to edit document.
-       void checkOut();
+       /// Lock/update and prepare to edit document. Returns log.
+       std::string checkOut();

        /// Does the current VC supports this operation?
        bool checkOutEnabled();
 
        /// Does the current VC supports this operation?
        bool checkOutEnabled();
 

+       /// Synchronize the whole archive with repository
+       std::string repoUpdate();
+       /// Does the current VC supports this operation?
+       bool repoUpdateEnabled();
+
+       /**
+        * Toggle locking property of the edited file,
+        * i.e. whether the file uses locking mechanism.
+        */
+       std::string lockingToggle();
+       /// Does the current VC supports this operation?
+       bool lockingToggleEnabled();
+

        /// Revert to last version
        void revert();
 
        /// Revert to last version
        void revert();
 


@@ -96,7 +108,7 @@ public:
        ///
        void toggleReadOnly();
 
        ///
        void toggleReadOnly();
 

-       /// Is the document under administration by RCS?
+       /// Is the document under administration by VCS?

        bool inUse();
 
        /// Returns the version number.
        bool inUse();
 
        /// Returns the version number.