Oben Sonne avatar Oben Sonne committed c707068

Update doc

Comments (0)

Files changed (1)

 #
 # =============================================================================
 
-"""commit, fetch and push at regular intervals"""
+"""automated duplex synchronization with another repository
 
-# read the sync() function documentation for detailed information
+The idea of this extension is to use Mercurial as a synchronization engine to
+keep files in sync across work stations.
+
+This extension provides the `autosync` command which automatically and
+continuously commits working copy changes, fetches (pull, merge, commit)
+changes from another repository and pushes local changes back to the other
+repository.
+
+Website: http://bitbucket.org/obensonne/hg-autosync
+
+Requires Mercurial >= 1.3.1 
+
+The test script `tests/test-autosync` can either be executed directly or used
+within the Mercurial testing suite.
+
+"""
 
 from datetime import datetime
 import os.path
     """commit, fetch and push at regular intervals 
     
     Commit changes in the working copy, fetch (pull, merge and commit) changes
-    from the other repository and push local changes back to the other
-    repository - either continuously (default) or once only.
+    from another repository and push local changes back to the other repository
+    - either continuously (default) or once only.
     
-    The idea of this command is to use Mercurial as a back-end to synchronize
-    a set of files across different machines. Think of configuration files or
-    to-do lists as examples for things to synchronize. On a higher level one
-    can say this command synchronizes not only repositories but also working
-    directories. A central repository (usually without a working copy) must be
-    used as synchronization hub:
+    The idea of this command is to use Mercurial as a synchronization engine
+    to keep files in sync across work stations. Think of configuration files or
+    to-do lists as examples for things to synchronize. On a higher level this
+    command not only synchronizes repositories but working copies. A central
+    repository (usually without a working copy) must be used as synchronization
+    hub:
     
     repo1 <--sync--> hub <--sync--> repo2
     
     `.hgalert` or (3) in an HGRC file using options `alerter` in section
     `autosync` (locations are evaluated in that order). The alerter is supposed
     to notify errors to a human. The repository path is given as first
-    argument, an error message as the second one. Independent of this, on erros
-    and conflicts the command keeps running and retries after the next
-    interval, hoping things get fixed externally.
+    argument, an error message as the second one. In any case the autosync
+    command keeps running and retries after the next interval, hoping things
+    get fixed externally.
         
     When running in daemon mode, any output gets logged into the file
     `autosync.log` within the repository's `.hg` directory (use --daemon-log
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.