Commits

Yuya Nishihara committed 9722147

describe about this extension

  • Participants
  • Parent commits c9932e7

Comments (0)

Files changed (1)

File hgext/backupstore.py

-# backupstore.py - backup files in repository store on write
+# backupstore.py - backup files in repository store on change
 #
 # Copyright 2012 Yuya Nishihara <yuya@tcha.org>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
-"""backup files in repository store on write
+"""backup files in repository store on change
 
-TODO write brief document
+This extension makes copy of .hg/store files to .hg/store-backup on change,
+in case the repository is corrupted. Even though Mercurial's revlog is
+append-only format, it might be damaged if backend filesystem is not reliable,
+e.g. buggy network share or secured by rude antivirus software.
+
+You should keep in mind that this exntension will slow down write access to
+repository store.
 """
 
 import errno, shutil