diff README.txt @ 13:8cca585b11cc

Module renamed to mercurial_all_paths for possible pypi installation. Extended README.
author Marcin Kasperski <Marcin.Kasperski@mekk.waw.pl>
date Sun, 15 Nov 2015 10:16:21 +0100
parents 62880e909417
children a50e0e7a5195
line wrap: on
line diff
--- a/README.txt	Sun Nov 08 09:08:58 2015 +0100
+++ b/README.txt	Sun Nov 15 10:16:21 2015 +0100
@@ -1,27 +1,37 @@
 .. -*- mode: rst; compile-command: "rst2html README.txt README.html" -*-
 
 ================================================
-allpaths extension
+Mercurial All Paths extension
 ================================================
 
-Push or pull to many (or all) paths at once::
+Push or pull to many (or all) paths at once. 
+
+.. contents::
+   :local:
+   :depth: 2
+
+.. sectnum::
+
+Usage
+================================================
+
+Simple::
 
     hg pushall
 
-(pushes to all paths defined in the ``[paths]`` config section)::
+pushes to all paths defined for the repository (all paths
+returned by ``hg paths`` - usually defined in ``.hg/hgrc``,
+but `Path Pattern`_ paths are also handled).
+
+There is also corresponding::
 
     hg pullall
 
-(pulls from all those paths)::
-
-    hg incomingall
-    hg outgoingall
-
-You can also provide the name of a different section::
+Instead of using standard paths, you can define and use *groups*::
 
     hg pushall -g publish
 
-This will push to all paths specified in the ``[publish]`` config
+pushes to all paths specified in the ``[publish]`` config
 section, which should look like this::
 
     [publish]
@@ -30,7 +40,7 @@
     other = ssh://my@own/server
     local = /some/other/place
 
-You can also provide standard options::
+All standard ``push`` and ``pull`` options can be used::
 
     hg pushall -b branch
 
@@ -40,3 +50,77 @@
 
 etc.
 
+Finally, there are::
+
+    hg incomingall
+
+and
+
+    hg outgoingall
+
+which simply iterate over all paths.
+
+Installation
+=======================================================
+
+From PyPi
+--------------------
+
+If you have working ``pip`` or ``easy_install``::
+
+    pip install --user mercurial_all_paths
+
+or maybe::
+
+    sudo pip install mercurial_all_paths
+
+Then activate by::
+
+    [extensions]
+    mercurial_all_paths =
+
+To upgrade, repeat the same command with ``--upgrade`` option, for
+example::
+
+    pip install --user --upgrade mercurial_all_paths
+
+From source
+-------------------------------------------------------
+
+Clone this repository::
+
+    cd ~/sources
+    hg clone https://bitbucket.org/Mekk/mercurial-all_paths/
+
+either::
+
+    pip install --user -e mercurial-all_paths
+
+and activate as above, or just activate by full path::
+
+    [extensions]
+    mercurial_path_pattern = ~/sources/mercurial-path_pattern/mercurial_path_pattern.py
+
+To upgrade, pull and update.
+
+Development, bug reports, enhancement suggestions
+=======================================================
+
+At the moment this extension is forked. Version by
+Marcin Kasperski is maintained at
+
+    http://bitbucket.org/Mekk/mercurial-all_paths/
+
+while original version by Ludovic Chabant is available at
+
+    https://bitbucket.org/ludovicchabant/allpaths
+
+Additional notes
+=======================================================
+
+Information about this extension is also available
+on Mercurial Wiki: http://mercurial.selenic.com/wiki/AllPathsExtension
+
+
+
+.. Path Pattern: https://bitbucket.org/Mekk/mercurial-path_pattern/